Migrate to JSpecify annotations for nullability constraints.

Closes #3745
Original pull request: #3781

Author: christophstrobl

org/antlr/v4/tool/templates/codegen/Java/Java.stg

@@ -48,14 +48,18 @@ ParserFile(file, parser, namedActions, contextSuperClass) ::= <<
 package <file.genPackage>;
 <endif>
 <namedActions.header>
+
 import org.antlr.v4.runtime.atn.*;
 import org.antlr.v4.runtime.dfa.DFA;
 import org.antlr.v4.runtime.*;
 import org.antlr.v4.runtime.misc.*;
 import org.antlr.v4.runtime.tree.*;
+import org.jspecify.annotations.NullUnmarked;
 import java.util.List;
 import java.util.Iterator;
 import java.util.ArrayList;
+import jakarta.annotation.Generated;
+
 
 <parser>
 >>
@@ -67,11 +71,15 @@ package <file.genPackage>;
 <endif>
 <header>
 import org.antlr.v4.runtime.tree.ParseTreeListener;
+import org.jspecify.annotations.NullUnmarked;
+import jakarta.annotation.Generated;
 
 /**
  * This interface defines a complete listener for a parse tree produced by
  * {@link <file.parserName>}.
  */
+@NullUnmarked
+@Generated("<file.grammarName>Listener")
 interface <file.grammarName>Listener extends ParseTreeListener {
 	<file.listenerNames:{lname |
 /**
@@ -103,17 +111,20 @@ BaseListenerFile(file, header, namedActions) ::= <<
 package <file.genPackage>;
 <endif>
 <header>
-
 import org.antlr.v4.runtime.ParserRuleContext;
 import org.antlr.v4.runtime.tree.ErrorNode;
 import org.antlr.v4.runtime.tree.TerminalNode;
+import org.jspecify.annotations.NullUnmarked;
+import jakarta.annotation.Generated;
 
 /**
  * This class provides an empty implementation of {@link <file.grammarName>Listener},
  * which can be extended to create a listener which only needs to handle a subset
  * of the available methods.
  */
-@SuppressWarnings("CheckReturnValue")
+@NullUnmarked
+@Generated("<file.grammarName>BaseListener")
+@SuppressWarnings({ "CheckReturnValue", "NullAway" })
 class <file.grammarName>BaseListener implements <file.grammarName>Listener {
 	<file.listenerNames:{lname |
 /**
@@ -163,6 +174,8 @@ package <file.genPackage>;
 <endif>
 <header>
 import org.antlr.v4.runtime.tree.ParseTreeVisitor;
+import org.jspecify.annotations.NullUnmarked;
+import jakarta.annotation.Generated;
 
 /**
  * This interface defines a complete generic visitor for a parse tree produced
@@ -171,6 +184,8 @@ import org.antlr.v4.runtime.tree.ParseTreeVisitor;
  * @param \<T> The return type of the visit operation. Use {@link Void} for
  * operations with no return type.
  */
+@NullUnmarked
+@Generated("<file.grammarName>Visitor")
 interface <file.grammarName>Visitor\<T> extends ParseTreeVisitor\<T> {
 	<file.visitorNames:{lname |
 /**
@@ -194,6 +209,8 @@ package <file.genPackage>;
 <endif>
 <header>
 import org.antlr.v4.runtime.tree.AbstractParseTreeVisitor;
+import org.jspecify.annotations.NullUnmarked;
+import jakarta.annotation.Generated;
 
 /**
  * This class provides an empty implementation of {@link <file.grammarName>Visitor},
@@ -203,7 +220,9 @@ import org.antlr.v4.runtime.tree.AbstractParseTreeVisitor;
  * @param \<T> The return type of the visit operation. Use {@link Void} for
  * operations with no return type.
  */
-@SuppressWarnings("CheckReturnValue")
+@NullUnmarked
+@Generated("<file.grammarName>BaseVisitor")
+@SuppressWarnings({ "CheckReturnValue", "NullAway" })
 class <file.grammarName>BaseVisitor\<T> extends AbstractParseTreeVisitor\<T> implements <file.grammarName>Visitor\<T> {
 	<file.visitorNames:{lname |
 /**
@@ -225,7 +244,9 @@ Parser(parser, funcs, atn, sempredFuncs, superClass) ::= <<
 >>
 
 Parser_(parser, funcs, atn, sempredFuncs, ctor, superClass) ::= <<
-@SuppressWarnings({"all", "warnings", "unchecked", "unused", "cast", "CheckReturnValue"})
+@NullUnmarked
+@Generated("<parser.name>")
+@SuppressWarnings({"all", "warnings", "unchecked", "unused", "cast", "CheckReturnValue", "NullAway"})
 class <parser.name> extends <superClass; null="Parser"> {
 	// Customization: Suppress version check
 	// static { RuntimeMetaData.checkVersion("<file.ANTLRVersion>", RuntimeMetaData.VERSION); }
@@ -895,12 +916,16 @@ import org.antlr.v4.runtime.*;
 import org.antlr.v4.runtime.atn.*;
 import org.antlr.v4.runtime.dfa.DFA;
 import org.antlr.v4.runtime.misc.*;
+import org.jspecify.annotations.NullUnmarked;
+import jakarta.annotation.Generated;
 
 <lexer>
 >>
 
 Lexer(lexer, atn, actionFuncs, sempredFuncs, superClass) ::= <<
-@SuppressWarnings({"all", "warnings", "unchecked", "unused", "cast", "CheckReturnValue"})
+@NullUnmarked
+@Generated("<lexer.name>")
+@SuppressWarnings({"all", "warnings", "unchecked", "unused", "cast", "CheckReturnValue", "NullAway"})
 class <lexer.name> extends <superClass; null="Lexer"> {
 	// Customization: Suppress version check
 	// static { RuntimeMetaData.checkVersion("<lexerFile.ANTLRVersion>", RuntimeMetaData.VERSION); }

spring-data-envers/src/main/java/org/springframework/data/envers/repository/config/package-info.java

@@ -1,5 +1,5 @@
 /**
  * Classes for Envers Repositories configuration support.
  */
-@org.springframework.lang.NonNullApi
+@org.jspecify.annotations.NullMarked
 package org.springframework.data.envers.repository.config;

spring-data-envers/src/main/java/org/springframework/data/envers/repository/support/EnversRevisionRepositoryFactoryBean.java

@@ -21,6 +21,7 @@
 
 import org.hibernate.envers.DefaultRevisionEntity;
 
+import org.jspecify.annotations.Nullable;
 import org.springframework.beans.factory.FactoryBean;
 import org.springframework.data.jpa.repository.support.JpaRepositoryFactory;
 import org.springframework.data.jpa.repository.support.JpaRepositoryFactoryBean;
@@ -39,7 +40,7 @@
 public class EnversRevisionRepositoryFactoryBean<T extends RevisionRepository<S, ID, N>, S, ID, N extends Number & Comparable<N>>
 		extends JpaRepositoryFactoryBean<T, S, ID> {
 
-	private Class<?> revisionEntityClass;
+	private @Nullable Class<?> revisionEntityClass;
 
 	/**
 	 * Creates a new {@link EnversRevisionRepositoryFactoryBean} for the given repository interface.
@@ -81,7 +82,7 @@ private static class RevisionRepositoryFactory<T, ID, N extends Number & Compara
 		 * @param entityManager must not be {@literal null}.
 		 * @param revisionEntityClass can be {@literal null}, will default to {@link DefaultRevisionEntity}.
 		 */
-		public RevisionRepositoryFactory(EntityManager entityManager, Class<?> revisionEntityClass) {
+		public RevisionRepositoryFactory(EntityManager entityManager, @Nullable Class<?> revisionEntityClass) {
 
 			super(entityManager);
 

spring-data-envers/src/main/java/org/springframework/data/envers/repository/support/package-info.java

@@ -1,5 +1,5 @@
 /**
  * Spring Data JPA specific converter infrastructure.
  */
-@org.springframework.lang.NonNullApi
+@org.jspecify.annotations.NullMarked
 package org.springframework.data.envers.repository.support;

spring-data-jpa/pom.xml

@@ -465,4 +465,89 @@
 		</profile>
 	</profiles>
 
+	<profiles>
+		<profile>
+			<id>nullaway</id>
+			<build>
+				<plugins>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-compiler-plugin</artifactId>
+						<configuration>
+							<annotationProcessorPaths>
+								<path>
+									<groupId>com.querydsl</groupId>
+									<artifactId>querydsl-apt</artifactId>
+									<version>${querydsl}</version>
+									<classifier>jakarta</classifier>
+								</path>
+								<path>
+									<groupId>org.hibernate.orm</groupId>
+									<artifactId>hibernate-jpamodelgen</artifactId>
+									<version>${hibernate}</version>
+								</path>
+								<path>
+									<groupId>org.hibernate.orm</groupId>
+									<artifactId>hibernate-core</artifactId>
+									<version>${hibernate}</version>
+								</path>
+								<path>
+									<groupId>org.openjdk.jmh</groupId>
+									<artifactId>jmh-generator-annprocess</artifactId>
+									<version>${jmh}</version>
+								</path>
+								<path>
+									<groupId>jakarta.persistence</groupId>
+									<artifactId>jakarta.persistence-api</artifactId>
+									<version>${jakarta-persistence-api}</version>
+								</path>
+								<path>
+									<groupId>com.google.errorprone</groupId>
+									<artifactId>error_prone_core</artifactId>
+									<version>${errorprone}</version>
+								</path>
+								<path>
+									<groupId>com.uber.nullaway</groupId>
+									<artifactId>nullaway</artifactId>
+									<version>${nullaway}</version>
+								</path>
+							</annotationProcessorPaths>
+						</configuration>
+						<executions>
+							<execution>
+								<id>default-compile</id>
+								<phase>none</phase>
+							</execution>
+							<execution>
+								<id>default-testCompile</id>
+								<phase>none</phase>
+							</execution>
+							<execution>
+								<id>java-compile</id>
+								<phase>compile</phase>
+								<goals>
+									<goal>compile</goal>
+								</goals>
+								<configuration>
+									<compilerArgs>
+										<arg>-XDcompilePolicy=simple</arg>
+										<arg>--should-stop=ifError=FLOW</arg>
+										<arg>-Xplugin:ErrorProne -XepDisableAllChecks -Xep:NullAway:ERROR -XepOpt:NullAway:OnlyNullMarked=true -XepOpt:NullAway:TreatGeneratedAsUnannotated=true -XepOpt:NullAway:CustomContractAnnotations=org.springframework.lang.Contract</arg>
+									</compilerArgs>
+								</configuration>
+							</execution>
+							<execution>
+								<id>java-test-compile</id>
+								<phase>test-compile</phase>
+								<goals>
+									<goal>testCompile</goal>
+								</goals>
+							</execution>
+						</executions>
+					</plugin>
+				</plugins>
+			</build>
+		</profile>
+	</profiles>
+
 </project>

spring-data-jpa/src/main/java/org/springframework/data/jpa/convert/QueryByExamplePredicateBuilder.java

@@ -34,14 +34,15 @@
 import java.util.Set;
 
 import org.springframework.dao.InvalidDataAccessApiUsageException;
+
+import org.jspecify.annotations.Nullable;
 import org.springframework.data.domain.Example;
 import org.springframework.data.domain.ExampleMatcher;
 import org.springframework.data.domain.ExampleMatcher.MatchMode;
 import org.springframework.data.domain.ExampleMatcher.PropertyValueTransformer;
 import org.springframework.data.jpa.repository.query.EscapeCharacter;
 import org.springframework.data.support.ExampleMatcherAccessor;
 import org.springframework.data.util.DirectFieldAccessFallbackBeanWrapper;
-import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 import org.springframework.util.ClassUtils;
 import org.springframework.util.ObjectUtils;
@@ -81,8 +82,7 @@ public class QueryByExamplePredicateBuilder {
 	 * @param example must not be {@literal null}.
 	 * @return {@literal null} indicates no {@link Predicate}.
 	 */
-	@Nullable
-	public static <T> Predicate getPredicate(Root<T> root, CriteriaBuilder cb, Example<T> example) {
+	public static <T> @Nullable Predicate getPredicate(Root<T> root, CriteriaBuilder cb, Example<T> example) {
 		return getPredicate(root, cb, example, EscapeCharacter.DEFAULT);
 	}
 
@@ -95,8 +95,7 @@ public static <T> Predicate getPredicate(Root<T> root, CriteriaBuilder cb, Examp
 	 * @param escapeCharacter Must not be {@literal null}.
 	 * @return {@literal null} indicates no constraints
 	 */
-	@Nullable
-	public static <T> Predicate getPredicate(Root<T> root, CriteriaBuilder cb, Example<T> example,
+	public static <T> @Nullable Predicate getPredicate(Root<T> root, CriteriaBuilder cb, Example<T> example,
 			EscapeCharacter escapeCharacter) {
 
 		Assert.notNull(root, "Root must not be null");

spring-data-jpa/src/main/java/org/springframework/data/jpa/convert/package-info.java

@@ -1,5 +1,5 @@
 /**
  * Spring Data JPA specific converter infrastructure.
  */
-@org.springframework.lang.NonNullApi
+@org.jspecify.annotations.NullMarked
 package org.springframework.data.jpa.convert;