← All recipes
Moderne licensed

Add @Nullable to methods that can return null

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

Adds the JSpecify @Nullable annotation to the return type of Java methods whose body returns a provably-nullable value: an explicit return null (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 and void returns, methods that already carry a nullability annotation, and @Override methods (where annotating the return could violate the supertype contract). Only Java return types 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.AddNullableToReturnType

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