← All recipes
Moderne licensed

Add @MonotonicNonNull to a lazily-initialized field

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

Annotates a lazily-initialized field with the Checker Framework @org.checkerframework.checker.nullness.qual.MonotonicNonNull annotation, the correct contract for a field that NullAway flags as not assigned in the constructor but that is set lazily and never reset to null (so @Nullable would needlessly force readers to handle null). A field qualifies when at least one assignment to it is guarded by a f == null check, it is never assigned null except in its declaration initializer, and it is not assigned non-null at its declaration or unconditionally in a constructor. Primitive, final, static, and already-annotated fields are skipped, and only Java fields are modified.

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

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

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