← All recipes
Moderne licensed

Add @Nullable to method parameters that can receive null

Recipe IDio.moderne.nullability.AddNullableToParameterCrossFile
Artifactio.moderne.recipe:rewrite-nullability

Adds the JSpecify @Nullable annotation to a Java method parameter when some call site anywhere in the project provably passes a nullable argument in that position: the null literal (directly, through a cast or parentheses, or via either branch of a ternary), or a call to a method whose return is itself nullable. Conservative by design: it skips primitive parameters, parameters that already carry a nullability annotation, varargs parameters, and @Override methods (where widening a parameter would break override consistency). Only Java parameters are modified.

Single recipeProprietary

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe io.moderne.nullability.AddNullableToParameterCrossFile

If the recipe isn’t available locally, install it with:

mod config recipes jar install io.moderne.recipe:rewrite-nullability:0.3.1

Data tables

Structured output this recipe can produce.

  • Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
  • Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
  • Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
  • Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats