Recipe nullability best practices
Recipe ID
org.openrewrite.java.recipes.RecipeNullabilityBestPracticesArtifact
org.openrewrite.recipe:rewrite-rewriteUse JSpecify nullable annotations; drop Nonnull annotations; use NullMarked on package-info.java instead.
Usage
This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.java.recipes.RecipeNullabilityBestPracticesIf the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite.recipe:rewrite-rewrite:0.29.0Definition
This recipe runs the following recipes in order.
- Migrate from OpenRewrite annotations to JSpecify
org.openrewrite.java.jspecify.MigrateFromOpenRewriteAnnotations - Remove annotation
org.openrewrite.java.RemoveAnnotation - Remove annotation
org.openrewrite.java.RemoveAnnotation - Remove annotation
org.openrewrite.java.RemoveAnnotation - Migrate to JSpecify
org.openrewrite.java.jspecify.MigrateToJSpecify - Annotate methods which may return
nullwith@Nullableorg.openrewrite.staticanalysis.AnnotateNullableMethods - Move
@Nullablemethod annotations to the return typeorg.openrewrite.staticanalysis.NullableOnMethodReturnType
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