Skip to content

jte-jspecify-nullmarked NullMarked Annotation Generator

jte-jspecify-nullmarked is a generator extension for jte that creates package-info.java files annotated with @NullMarked for each package containing generated classes. This enables null-safety tooling (such as NullAway or ErrorProne) to treat generated classes as null-safe, preventing build failures in projects that enforce null-safety annotations.

Setup

Add jspecify 1.0.0 or later to your project dependencies, then configure the build plugin to use the extension.

Add to your <dependencies> section:

1
2
3
4
5
<dependency>
    <groupId>org.jspecify</groupId>
    <artifactId>jspecify</artifactId>
    <version>1.0.0</version>
</dependency>

Add to your <build><plugins> section:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
<plugin>
    <groupId>gg.jte</groupId>
    <artifactId>jte-maven-plugin</artifactId>
    <version>${jte.version}</version>
    <configuration>
        <sourceDirectory>${project.basedir}/src/main/jte</sourceDirectory>
        <contentType>Html</contentType>
        <extensions>
            <extension>
                <className>gg.jte.jspecify.NullMarkedExtension</className>
            </extension>
        </extensions>
    </configuration>
    <executions>
        <execution>
            <phase>generate-sources</phase>
            <goals>
                <goal>generate</goal>
            </goals>
        </execution>
    </executions>
    <dependencies>
        <dependency>
            <groupId>gg.jte</groupId>
            <artifactId>jte-jspecify-nullmarked</artifactId>
            <version>${jte.version}</version>
        </dependency>
    </dependencies>
</plugin>

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
plugins {
    id 'gg.jte.gradle' version '${jte.version}'
}

dependencies {
    implementation 'gg.jte:jte-runtime:${jte.version}'
    implementation 'org.jspecify:jspecify:1.0.0'
    jteGenerate 'gg.jte:jte-jspecify-nullmarked:${jte.version}'
}

jte {
    generate()
    jteExtension 'gg.jte.jspecify.NullMarkedExtension'
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
plugins {
    id("gg.jte.gradle") version "${jte.version}"
}

dependencies {
    implementation("gg.jte:jte-runtime:${jte.version}")
    implementation("org.jspecify:jspecify:1.0.0")
    jteGenerate("gg.jte:jte-jspecify-nullmarked:${jte.version}")
}

jte {
    generate()
    jteExtension("gg.jte.jspecify.NullMarkedExtension")
}

Run the build to generate classes.

Output

For each package containing generated classes, a package-info.java file is created:

@NullMarked
package gg.jte.generated.precompiled;

import org.jspecify.annotations.NullMarked;

If a package-info.java already exists in a package directory, it is left unchanged.