← All recipes
Moderne licensed

Add @Nullable to array element types that can hold null

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

Adds the JSpecify @Nullable annotation to the element type of a Java array whose elements are provably nullable, producing @Nullable String[] (the array's *elements* may be null) rather than String @Nullable [] (the array *reference* may be null), which NullAway checks in JSpecify mode. An array declaration (field, local, parameter, or return type) is annotated when its initializer is an array literal containing a null element (String[] a = {null}) or when an element is assigned a provably-null value (arr[i] = null) — within the same method body for a local or parameter, or anywhere in the enclosing class for a field (so a field array nulled in a separate method is still detected). Conservative by design: it skips primitive-element arrays, arrays whose element type already carries a nullability annotation, and non-Java sources.

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.AddNullableToArrayElementType")
}

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

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