Migrate to JSpecify annotations for nullability constraints.

Closes #3170
spring-projects · Feb 6, 2025 · 44d119b · 44d119b
1 parent 9592c50
commit 44d119b
Show file tree

Hide file tree

Showing 344 changed files with 1,515 additions and 1,234 deletions.
diff --git a/src/main/java/org/springframework/data/annotation/AccessType.java b/src/main/java/org/springframework/data/annotation/AccessType.java
@@ -28,7 +28,7 @@
  * @author Oliver Gierke
  */
 @Documented
-@Target({ ElementType.ANNOTATION_TYPE, ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, })
+@Target({ ElementType.ANNOTATION_TYPE, ElementType.TYPE, ElementType.FIELD, ElementType.METHOD })
 @Retention(RetentionPolicy.RUNTIME)
 public @interface AccessType {
 
@@ -40,4 +40,5 @@
 	enum Type {
 		FIELD, PROPERTY;
 	}
+
 }
diff --git a/src/main/java/org/springframework/data/annotation/package-info.java b/src/main/java/org/springframework/data/annotation/package-info.java
@@ -1,5 +1,5 @@
 /**
  * Core annotations being used by Spring Data.
  */
-@org.springframework.lang.NonNullApi
+@org.jspecify.annotations.NullMarked
 package org.springframework.data.annotation;
diff --git a/src/main/java/org/springframework/data/aot/AotContext.java b/src/main/java/org/springframework/data/aot/AotContext.java
@@ -22,14 +22,15 @@
 import java.util.Set;
 import java.util.function.Consumer;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.beans.factory.NoSuchBeanDefinitionException;
 import org.springframework.beans.factory.config.BeanDefinition;
 import org.springframework.beans.factory.config.BeanReference;
 import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.beans.factory.support.RootBeanDefinition;
 import org.springframework.data.util.TypeScanner;
-import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**

diff --git a/src/main/java/org/springframework/data/aot/AuditingBeanRegistrationAotProcessor.java b/src/main/java/org/springframework/data/aot/AuditingBeanRegistrationAotProcessor.java
@@ -15,6 +15,8 @@
  */
 package org.springframework.data.aot;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.aop.SpringProxy;
 import org.springframework.aop.framework.Advised;
 import org.springframework.aot.hint.RuntimeHints;
@@ -26,7 +28,6 @@
 import org.springframework.data.domain.AuditorAware;
 import org.springframework.data.domain.ReactiveAuditorAware;
 import org.springframework.data.util.ReactiveWrappers;
-import org.springframework.lang.Nullable;
 import org.springframework.util.ClassUtils;
 
 /**

diff --git a/src/main/java/org/springframework/data/aot/DefaultAotContext.java b/src/main/java/org/springframework/data/aot/DefaultAotContext.java
@@ -20,6 +20,8 @@
 import java.util.List;
 import java.util.Optional;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.beans.factory.NoSuchBeanDefinitionException;
 import org.springframework.beans.factory.config.BeanDefinition;
@@ -132,7 +134,7 @@ public RootBeanDefinition getRootBeanDefinition() throws NoSuchBeanDefinitionExc
 		}
 
 		@Override
-		public Class<?> resolveType() {
+		public @Nullable Class<?> resolveType() {
 			return factory.getType(beanName, false);
 		}
 	}

diff --git a/.../java/org/springframework/data/aot/ManagedTypesBeanFactoryInitializationAotProcessor.java b/.../java/org/springframework/data/aot/ManagedTypesBeanFactoryInitializationAotProcessor.java
@@ -20,6 +20,7 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.beans.factory.aot.BeanFactoryInitializationAotContribution;
 import org.springframework.beans.factory.aot.BeanFactoryInitializationAotProcessor;
@@ -30,7 +31,6 @@
 import org.springframework.beans.factory.support.BeanDefinitionRegistry;
 import org.springframework.data.domain.ManagedTypes;
 import org.springframework.lang.Contract;
-import org.springframework.lang.Nullable;
 import org.springframework.util.CollectionUtils;
 import org.springframework.util.ObjectUtils;
 
@@ -48,9 +48,9 @@ public class ManagedTypesBeanFactoryInitializationAotProcessor implements BeanFa
 	private static final Log logger = LogFactory.getLog(ManagedTypesBeanFactoryInitializationAotProcessor.class);
 
 	@Override
-	@Nullable
 	@Contract("_ -> null")
-	public BeanFactoryInitializationAotContribution processAheadOfTime(ConfigurableListableBeanFactory beanFactory) {
+	public @Nullable BeanFactoryInitializationAotContribution processAheadOfTime(
+			ConfigurableListableBeanFactory beanFactory) {
 
 		processManagedTypes(beanFactory);
 		return null;
@@ -82,12 +82,15 @@ private void postProcessManagedTypes(ConfigurableListableBeanFactory beanFactory
 				}
 
 				Object value = potentiallyWrapToIterable(supplier.get());
+				String beanClassName = beanDefinition.getBeanClassName();
 
-				BeanDefinition beanDefinitionReplacement = newManagedTypeBeanDefinition(beanDefinition.getBeanClassName(),
-						value);
+				if (beanClassName != null) {
 
-				registry.removeBeanDefinition(beanName);
-				registry.registerBeanDefinition(beanName, beanDefinitionReplacement);
+					BeanDefinition beanDefinitionReplacement = newManagedTypeBeanDefinition(beanClassName, value);
+
+					registry.removeBeanDefinition(beanName);
+					registry.registerBeanDefinition(beanName, beanDefinitionReplacement);
+				}
 			}
 		}
 	}

diff --git a/src/main/java/org/springframework/data/aot/ManagedTypesBeanRegistrationAotProcessor.java b/src/main/java/org/springframework/data/aot/ManagedTypesBeanRegistrationAotProcessor.java
@@ -21,6 +21,8 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.aot.generate.GenerationContext;
 import org.springframework.beans.factory.BeanCreationException;
 import org.springframework.beans.factory.BeanFactory;
@@ -34,7 +36,6 @@
 import org.springframework.data.util.QTypeContributor;
 import org.springframework.data.util.TypeContributor;
 import org.springframework.data.util.TypeUtils;
-import org.springframework.lang.Nullable;
 import org.springframework.util.ClassUtils;
 import org.springframework.util.StringUtils;
 
@@ -61,7 +62,7 @@ public String getModuleIdentifier() {
 	}
 
 	@Override
-	public BeanRegistrationAotContribution processAheadOfTime(RegisteredBean registeredBean) {
+	public @Nullable BeanRegistrationAotContribution processAheadOfTime(RegisteredBean registeredBean) {
 
 		if (!isMatch(registeredBean.getBeanClass(), registeredBean.getBeanName())) {
 			return null;

diff --git a/src/main/java/org/springframework/data/aot/ManagedTypesRegistrationAotContribution.java b/src/main/java/org/springframework/data/aot/ManagedTypesRegistrationAotContribution.java
@@ -22,6 +22,8 @@
 
 import javax.lang.model.element.Modifier;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.aot.generate.AccessControl;
 import org.springframework.aot.generate.GeneratedMethod;
 import org.springframework.aot.generate.GenerationContext;
@@ -41,7 +43,6 @@
 import org.springframework.javapoet.ParameterizedTypeName;
 import org.springframework.javapoet.TypeName;
 import org.springframework.javapoet.WildcardTypeName;
-import org.springframework.lang.Nullable;
 import org.springframework.util.ClassUtils;
 import org.springframework.util.ObjectUtils;
 import org.springframework.util.ReflectionUtils;

diff --git a/src/main/java/org/springframework/data/aot/package-info.java b/src/main/java/org/springframework/data/aot/package-info.java
@@ -2,5 +2,5 @@
  * Support for registering the need for reflection, resources, java serialization and proxies at runtime for Ahead of
  * Time compilation.
  */
-@org.springframework.lang.NonNullApi
+@org.jspecify.annotations.NullMarked
 package org.springframework.data.aot;
diff --git a/src/main/java/org/springframework/data/auditing/AuditableBeanWrapper.java b/src/main/java/org/springframework/data/auditing/AuditableBeanWrapper.java
@@ -18,8 +18,9 @@
 import java.time.temporal.TemporalAccessor;
 import java.util.Optional;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.lang.Contract;
-import org.springframework.lang.Nullable;
 
 /**
  * Interface to abstract the ways setting the auditing information can be implemented.

diff --git a/src/main/java/org/springframework/data/auditing/AuditingHandlerSupport.java b/src/main/java/org/springframework/data/auditing/AuditingHandlerSupport.java
@@ -20,11 +20,11 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.core.log.LogMessage;
 import org.springframework.data.domain.Auditable;
 import org.springframework.data.mapping.context.PersistentEntities;
-import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**

diff --git a/src/main/java/org/springframework/data/auditing/Auditor.java b/src/main/java/org/springframework/data/auditing/Auditor.java
@@ -17,7 +17,8 @@
 
 import java.util.Optional;
 
-import org.springframework.lang.Nullable;
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.util.ObjectUtils;
 
 /**

diff --git a/src/main/java/org/springframework/data/auditing/DefaultAuditableBeanWrapperFactory.java b/src/main/java/org/springframework/data/auditing/DefaultAuditableBeanWrapperFactory.java
@@ -24,13 +24,14 @@
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.stream.Stream;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.core.ResolvableType;
 import org.springframework.core.convert.ConversionService;
 import org.springframework.data.convert.Jsr310Converters;
 import org.springframework.data.domain.Auditable;
 import org.springframework.data.util.ReflectionUtils;
 import org.springframework.format.support.DefaultFormattingConversionService;
-import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**
@@ -115,7 +116,7 @@ public AuditableInterfaceBeanWrapper(ConversionService conversionService,
 		}
 
 		@Override
-		public Object setCreatedBy(@Nullable Object value) {
+		public @Nullable Object setCreatedBy(@Nullable Object value) {
 
 			auditable.setCreatedBy(value);
 			return value;
@@ -130,7 +131,7 @@ public TemporalAccessor setCreatedDate(TemporalAccessor value) {
 		}
 
 		@Override
-		public Object setLastModifiedBy(Object value) {
+		public @Nullable Object setLastModifiedBy(@Nullable Object value) {
 
 			auditable.setLastModifiedBy(value);
 
@@ -267,7 +268,7 @@ public ReflectionAuditingBeanWrapper(ConversionService conversionService, T targ
 		}
 
 		@Override
-		public Object setCreatedBy(@Nullable Object value) {
+		public @Nullable Object setCreatedBy(@Nullable Object value) {
 			return setField(metadata.getCreatedByField(), value);
 		}
 
@@ -277,7 +278,7 @@ public TemporalAccessor setCreatedDate(TemporalAccessor value) {
 		}
 
 		@Override
-		public Object setLastModifiedBy(@Nullable Object value) {
+		public @Nullable Object setLastModifiedBy(@Nullable Object value) {
 			return setField(metadata.getLastModifiedByField(), value);
 		}
 

diff --git a/src/main/java/org/springframework/data/auditing/MappingAuditableBeanWrapperFactory.java b/src/main/java/org/springframework/data/auditing/MappingAuditableBeanWrapperFactory.java
@@ -23,6 +23,8 @@
 import java.util.function.Predicate;
 import java.util.stream.Stream;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.core.convert.ConversionService;
 import org.springframework.data.annotation.CreatedBy;
 import org.springframework.data.annotation.CreatedDate;
@@ -41,7 +43,6 @@
 import org.springframework.data.mapping.context.PersistentEntities;
 import org.springframework.data.util.Lazy;
 import org.springframework.lang.Contract;
-import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**
@@ -195,7 +196,7 @@ public MappingMetadataAuditableBeanWrapper(
 		}
 
 		@Override
-		public Object setCreatedBy(Object value) {
+		public @Nullable Object setCreatedBy(@Nullable Object value) {
 			return setProperty(metadata.createdByPaths, value);
 		}
 
@@ -205,7 +206,7 @@ public TemporalAccessor setCreatedDate(TemporalAccessor value) {
 		}
 
 		@Override
-		public Object setLastModifiedBy(@Nullable Object value) {
+		public @Nullable Object setLastModifiedBy(@Nullable Object value) {
 			return setProperty(metadata.lastModifiedByPaths, value);
 		}
 

diff --git a/...in/java/org/springframework/data/auditing/config/AuditingHandlerBeanDefinitionParser.java b/...in/java/org/springframework/data/auditing/config/AuditingHandlerBeanDefinitionParser.java
@@ -17,6 +17,8 @@
 
 import static org.springframework.beans.factory.support.BeanDefinitionBuilder.*;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.aop.framework.ProxyFactoryBean;
 import org.springframework.aop.target.LazyInitTargetSource;
 import org.springframework.beans.factory.config.BeanDefinition;
@@ -45,7 +47,7 @@ public class AuditingHandlerBeanDefinitionParser extends AbstractSingleBeanDefin
 	private static final String AUDITOR_AWARE_REF = "auditor-aware-ref";
 
 	private final String mappingContextBeanName;
-	private String resolvedBeanName;
+	private @Nullable String resolvedBeanName;
 
 	/**
 	 * Creates a new {@link AuditingHandlerBeanDefinitionParser} to point to a {@link MappingContext} with the given bean
@@ -65,7 +67,7 @@ public AuditingHandlerBeanDefinitionParser(String mappingContextBeanName) {
 	 *
 	 * @return the resolvedBeanName
 	 */
-	public String getResolvedBeanName() {
+	public @Nullable String getResolvedBeanName() {
 		return resolvedBeanName;
 	}
 

diff --git a/src/main/java/org/springframework/data/auditing/config/package-info.java b/src/main/java/org/springframework/data/auditing/config/package-info.java
@@ -1,5 +1,5 @@
 /**
  * Types to abstract authentication concepts.
  */
-@org.springframework.lang.NonNullApi
+@org.jspecify.annotations.NullMarked
 package org.springframework.data.auditing.config;
diff --git a/src/main/java/org/springframework/data/auditing/package-info.java b/src/main/java/org/springframework/data/auditing/package-info.java
@@ -1,5 +1,5 @@
 /**
  * General support for entity auditing.
  */
-@org.springframework.lang.NonNullApi
+@org.jspecify.annotations.NullMarked
 package org.springframework.data.auditing;
diff --git a/src/main/java/org/springframework/data/config/ParsingUtils.java b/src/main/java/org/springframework/data/config/ParsingUtils.java
@@ -15,15 +15,17 @@
  */
 package org.springframework.data.config;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.beans.factory.config.BeanDefinition;
 import org.springframework.beans.factory.config.ObjectFactoryCreatingFactoryBean;
 import org.springframework.beans.factory.support.AbstractBeanDefinition;
 import org.springframework.beans.factory.support.BeanDefinitionBuilder;
 import org.springframework.beans.factory.xml.BeanDefinitionParser;
 import org.springframework.beans.factory.xml.ParserContext;
-import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
+
 import org.w3c.dom.Element;
 
 /**

diff --git a/src/main/java/org/springframework/data/config/TypeFilterParser.java b/src/main/java/org/springframework/data/config/TypeFilterParser.java
@@ -20,6 +20,8 @@
 import java.util.HashSet;
 import java.util.regex.Pattern;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.beans.BeanUtils;
 import org.springframework.beans.FatalBeanException;
 import org.springframework.beans.factory.parsing.ReaderContext;
@@ -30,7 +32,6 @@
 import org.springframework.core.type.filter.AssignableTypeFilter;
 import org.springframework.core.type.filter.RegexPatternTypeFilter;
 import org.springframework.core.type.filter.TypeFilter;
-import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 import org.w3c.dom.Element;
@@ -101,7 +102,8 @@ public Collection<TypeFilter> parseTypeFilters(Element element, Type type) {
 			try {
 				filters.add(createTypeFilter(childElement, classLoader));
 			} catch (RuntimeException e) {
-				readerContext.error(e.getMessage(), readerContext.extractSource(element), e.getCause());
+				readerContext.error("Failed creating type filter: " + e.getMessage(), readerContext.extractSource(element),
+						e.getCause());
 			}
 		}
 

diff --git a/src/main/java/org/springframework/data/config/package-info.java b/src/main/java/org/springframework/data/config/package-info.java
@@ -1,5 +1,5 @@
 /**
  * Basic support for creating custom Spring namespaces and JavaConfig.
  */
-@org.springframework.lang.NonNullApi
+@org.jspecify.annotations.NullMarked
 package org.springframework.data.config;