Annotate null-checked method parameters with @Nullable

MSAL

Add @Nullable to parameters of public methods that are explicitly checked for null. By default org.jspecify.annotations.Nullable is used, but through the nullableAnnotationClass option a custom annotation can be provided. Both @Target(TYPE_USE) and declaration annotations (e.g. javax.annotation.CheckForNull) are supported. Parameters that already carry a known nullable annotation are skipped to avoid duplication. This recipe scans for methods that do not already have parameters annotated with a nullable annotation and checks their usages for potential null checks. Additional null-checking methods can be specified via the additionalNullCheckingMethods option.

org.openrewrite.staticanalysis.AnnotateNullableParameters

Optional

The fully qualified name of the @Nullable annotation to add. Both @Target(TYPE_USE) and declaration annotations (e.g. javax.annotation.CheckForNull) are supported. Defaults to org.jspecify.annotations.Nullable.

A list of method patterns (in OpenRewrite MethodMatcher format) that should be considered as null-checking methods. These will be added to the built-in list of known null-checking methods. Use .. for any parameters, e.g., com.mycompany.utils.StringUtil isEmpty(..) or com.mycompany.utils.CollectionUtil isNullOrEmpty(java.util.Collection). Separate values with commas.

mod run . --recipe=org.openrewrite.staticanalysis.AnnotateNullableParameters

Install it once from Recipe actions, then run it on every repository under the current directory. New to the Moderne CLI? Set it up.