Skip to content

Replace NullAway configuration with nullability-maven-plugin #219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
scordio wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Replace NullAway configuration with nullability-maven-plugin #219

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions spring-batch-excel/.mvn/jvm.config
View file
Open in desktop

This file was deleted.

38 changes: 14 additions & 24 deletions spring-batch-excel/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,36 +102,26 @@

<build>
<plugins>
<plugin>
<groupId>am.ik.maven</groupId>
<artifactId>nullability-maven-plugin</artifactId>
<version>0.5.2</version>
<extensions>true</extensions>
<executions>
<execution>
<goals>
<goal>configure</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<compilerArgs>
<compilerArg>-Xlint:all,-varargs</compilerArg>
<!-- https://errorprone.info/docs/installation#maven -->
<compilerArg>-XDcompilePolicy=simple</compilerArg>
<compilerArg>--should-stop=ifError=FLOW</compilerArg>
<compilerArg>
-Xplugin:ErrorProne
-XepDisableAllChecks
<!-- Check JSpecify annotations -->
-Xep:NullAway
-XepOpt:NullAway:OnlyNullMarked
-XepOpt:NullAway:SuppressionNameAliases=DataFlowIssue
</compilerArg>
<compilerArg>-Xlint:all</compilerArg>
</compilerArgs>
<annotationProcessorPaths>
<path>
<groupId>com.google.errorprone</groupId>
<artifactId>error_prone_core</artifactId>
<version>2.48.0</version>
</path>
<path>
<groupId>com.uber.nullaway</groupId>
<artifactId>nullaway</artifactId>
<version>0.13.1</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
<plugin>
Expand Down
3 changes: 3 additions & 0 deletions ...-excel/src/main/java/org/springframework/batch/extensions/excel/mapping/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,7 @@
/**
* Default {@code RowMapper} implementations.
*/
@NullUnmarked

@scordio scordio Oct 12, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to annotate all spring-batch-excel packages with @NullUnmarked as the plugin enables the RequireExplicitNullMarking checker by default, which I think it's a good practice.

Switching from @NullUnmarked to @NullMarked would require reviewing the affected classes and annotating them accordingly, but that would be beyond the scope of this PR.

package org.springframework.batch.extensions.excel.mapping;

import org.jspecify.annotations.NullUnmarked;
3 changes: 3 additions & 0 deletions ...ng-batch-excel/src/main/java/org/springframework/batch/extensions/excel/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,7 @@
/**
* Core interfaces for reading Excel files.
*/
@NullUnmarked
package org.springframework.batch.extensions.excel;

import org.jspecify.annotations.NullUnmarked;
3 changes: 3 additions & 0 deletions ...atch-excel/src/main/java/org/springframework/batch/extensions/excel/poi/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,7 @@
/**
* Support classes for the Apache POI library.
*/
@NullUnmarked
package org.springframework.batch.extensions.excel.poi;

import org.jspecify.annotations.NullUnmarked;
3 changes: 3 additions & 0 deletions ...xcel/src/main/java/org/springframework/batch/extensions/excel/streaming/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,7 @@
/**
* Streaming implementation of ItemReaders.
*/
@NullUnmarked
package org.springframework.batch.extensions.excel.streaming;

import org.jspecify.annotations.NullUnmarked;
3 changes: 3 additions & 0 deletions ...src/main/java/org/springframework/batch/extensions/excel/support/rowset/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,7 @@
/**
* RowSet abstraction for Excel documents.
*/
@NullUnmarked
package org.springframework.batch.extensions.excel.support.rowset;

import org.jspecify.annotations.NullUnmarked;
10 changes: 0 additions & 10 deletions spring-batch-notion/.mvn/jvm.config
View file
Open in desktop

This file was deleted.

42 changes: 18 additions & 24 deletions spring-batch-notion/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,24 @@

<build>
<plugins>
<plugin>
<groupId>am.ik.maven</groupId>
<artifactId>nullability-maven-plugin</artifactId>
<version>0.5.2</version>
<extensions>true</extensions>
<configuration>
<nullAwayOptions>
<SuppressionNameAliases>DataFlowIssue</SuppressionNameAliases>
</nullAwayOptions>
</configuration>
<executions>
<execution>
<goals>
<goal>configure</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>com.mycila</groupId>
<artifactId>license-maven-plugin</artifactId>
Expand Down Expand Up @@ -130,31 +148,7 @@ limitations under the License.
<configuration>
<compilerArgs>
<compilerArg>-Xlint:all,-varargs</compilerArg>
<!-- https://errorprone.info/docs/installation#maven -->
<compilerArg>-XDcompilePolicy=simple</compilerArg>
<compilerArg>--should-stop=ifError=FLOW</compilerArg>
<compilerArg>
-Xplugin:ErrorProne
-XepDisableAllChecks
<!-- Check JSpecify annotations -->
-Xep:NullAway
-XepOpt:NullAway:OnlyNullMarked
-Xep:RequireExplicitNullMarking:WARN
-XepOpt:NullAway:SuppressionNameAliases=DataFlowIssue
</compilerArg>
</compilerArgs>
<annotationProcessorPaths>
<path>
<groupId>com.google.errorprone</groupId>
<artifactId>error_prone_core</artifactId>
<version>2.46.0</version>
</path>
<path>
<groupId>com.uber.nullaway</groupId>
<artifactId>nullaway</artifactId>
<version>0.13.1</version>
</path>
</annotationProcessorPaths>
<failOnWarning>true</failOnWarning>
</configuration>
</plugin>
Expand Down
10 changes: 0 additions & 10 deletions spring-batch-s3/.mvn/jvm.config
View file
Open in desktop

This file was deleted.

38 changes: 14 additions & 24 deletions spring-batch-s3/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,19 @@

<build>
<plugins>
<plugin>
<groupId>am.ik.maven</groupId>
<artifactId>nullability-maven-plugin</artifactId>
<version>0.5.2</version>
<extensions>true</extensions>
<executions>
<execution>
<goals>
<goal>configure</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>io.spring.javaformat</groupId>
<artifactId>spring-javaformat-maven-plugin</artifactId>
Expand All @@ -135,31 +148,8 @@
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<compilerArgs>
<compilerArg>-Xlint:all,-varargs</compilerArg>
<!-- https://errorprone.info/docs/installation#maven -->
<compilerArg>-XDcompilePolicy=simple</compilerArg>
<compilerArg>--should-stop=ifError=FLOW</compilerArg>
<compilerArg>
-Xplugin:ErrorProne
-XepDisableAllChecks
<!-- Check JSpecify annotations -->
-Xep:NullAway
-XepOpt:NullAway:OnlyNullMarked
-XepOpt:NullAway:SuppressionNameAliases=DataFlowIssue
</compilerArg>
<compilerArg>-Xlint:all</compilerArg>
</compilerArgs>
<annotationProcessorPaths>
<path>
<groupId>com.google.errorprone</groupId>
<artifactId>error_prone_core</artifactId>
<version>2.43.0</version>
</path>
<path>
<groupId>com.uber.nullaway</groupId>
<artifactId>nullaway</artifactId>
<version>0.12.11</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
<plugin>
Expand Down
Loading