← All recipes
Moderne licensed

Add @Nullable to collection and map type arguments that hold null elements

Recipe IDio.moderne.nullability.AddNullableToTypeArgumentArtifactio.moderne.recipe:rewrite-nullability

Places the JSpecify @Nullable annotation on a collection or map type argument when its elements or values are provably nullable, producing List<@Nullable String> or Map<String, @Nullable String> (the list may hold null elements) rather than @Nullable List<String> (the list reference may be null), which NullAway enforces in JSpecify mode. A type argument is annotated when Collection.add(...) is called with a provably-null element, Map.put(...) with a provably-null value, or the declaration's initializer is a List.of(...)/Set.of(...)/Arrays.asList(...) containing a null. The receiver is resolved to its declaration within the same compilation unit (cross-file declarations are not handled). Conservative by design: it skips wildcard and raw type arguments and ones already @Nullable.

Single recipeProprietary

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("io.moderne.nullability.AddNullableToTypeArgument")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("io.moderne.recipe:rewrite-nullability:0.6.0")
}

Then run

./gradlew rewriteRun

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.AddNullableToTypeArgument

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

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

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