Migrate to JSpecify annotations for nullability constraints.

Closes #528

Author: mp911de

pom.xml

@@ -95,6 +95,11 @@
 			<version>${cdi}</version>
 			<optional>true</optional>
 		</dependency>
+		<dependency>
+			<groupId>org.jspecify</groupId>
+			<artifactId>jspecify</artifactId>
+			<version>1.0.0</version>
+		</dependency>
 
 		<dependency>
 			<groupId>jakarta.annotation</groupId>

src/main/java/org/springframework/data/ldap/config/package-info.java

@@ -1,7 +1,5 @@
 /**
  * XML configuration support for Spring Data LDAP repositories.
  */
-@NonNullApi
+@org.jspecify.annotations.NullMarked
 package org.springframework.data.ldap.config;
-
-import org.springframework.lang.NonNullApi;

src/main/java/org/springframework/data/ldap/core/mapping/BasicLdapPersistentEntity.java

@@ -35,4 +35,5 @@ public class BasicLdapPersistentEntity<T> extends BasicPersistentEntity<T, LdapP
 	public BasicLdapPersistentEntity(TypeInformation<T> information) {
 		super(information);
 	}
+
 }

src/main/java/org/springframework/data/ldap/core/mapping/LdapMappingContext.java

@@ -45,4 +45,5 @@ protected LdapPersistentProperty createPersistentProperty(Property property, Bas
 			SimpleTypeHolder simpleTypeHolder) {
 		return new LdapPersistentProperty(property, owner, simpleTypeHolder);
 	}
+
 }

src/main/java/org/springframework/data/ldap/core/mapping/LdapPersistentProperty.java

@@ -48,11 +48,12 @@ public LdapPersistentProperty(Property property, PersistentEntity<?, LdapPersist
 
 	@Override
 	protected Association<LdapPersistentProperty> createAssociation() {
-		return null;
+		throw new UnsupportedOperationException("LDAP does not support associations");
 	}
 
 	@Override
 	public boolean isIdProperty() {
 		return isId.get();
 	}
+
 }

src/main/java/org/springframework/data/ldap/core/mapping/LdapSimpleTypes.java

@@ -44,4 +44,5 @@ public abstract class LdapSimpleTypes {
 	public static final SimpleTypeHolder HOLDER = new SimpleTypeHolder(VAULT_SIMPLE_TYPES, true);
 
 	private LdapSimpleTypes() {}
+
 }

src/main/java/org/springframework/data/ldap/core/mapping/package-info.java

@@ -1,6 +1,5 @@
 /**
  * Infrastructure for the LDAP object mapping subsystem.
  */
-@org.springframework.lang.NonNullApi
-@org.springframework.lang.NonNullFields
+@org.jspecify.annotations.NullMarked
 package org.springframework.data.ldap.core.mapping;

src/main/java/org/springframework/data/ldap/repository/LdapEncoder.java

@@ -49,6 +49,7 @@ class NameEncoder implements LdapEncoder {
 		public String encode(String value) {
 			return org.springframework.ldap.support.LdapEncoder.nameEncode(value);
 		}
+
 	}
 
 	/**
@@ -79,6 +80,7 @@ public String encode(String value) {
 
 			return buff.toString();
 		}
+
 	}
 
 }

src/main/java/org/springframework/data/ldap/repository/LdapRepository.java

@@ -48,4 +48,5 @@ public interface LdapRepository<T> extends ListCrudRepository<T, Name> {
 	 * @return the entries matching the query.
 	 */
 	List<T> findAll(LdapQuery ldapQuery);
+
 }

src/main/java/org/springframework/data/ldap/repository/Query.java

@@ -75,4 +75,5 @@
 	 * @return the count limit.
 	 */
 	int countLimit() default 0;
+
 }

src/main/java/org/springframework/data/ldap/repository/cdi/LdapRepositoryBean.java

@@ -70,4 +70,5 @@ protected T create(CreationalContext<T> creationalContext, Class<T> repositoryTy
 	public Class<? extends Annotation> getScope() {
 		return operations.getScope();
 	}
+
 }

src/main/java/org/springframework/data/ldap/repository/cdi/LdapRepositoryExtension.java

@@ -115,4 +115,5 @@ private <T> CdiRepositoryBean<T> createRepositoryBean(Class<T> repositoryType, S
 		return new LdapRepositoryBean<>(LdapOperations, qualifiers, repositoryType, beanManager,
 				Optional.of(getCustomImplementationDetector()));
 	}
+
 }

src/main/java/org/springframework/data/ldap/repository/cdi/package-info.java

@@ -1,5 +1,5 @@
 /**
  * CDI support for LDAP specific repository implementation.
  */
-@org.springframework.lang.NonNullApi
+@org.jspecify.annotations.NullMarked
 package org.springframework.data.ldap.repository.cdi;

src/main/java/org/springframework/data/ldap/repository/config/LdapRepositoriesRegistrar.java

@@ -36,4 +36,5 @@ protected Class<? extends Annotation> getAnnotation() {
 	protected RepositoryConfigurationExtension getExtension() {
 		return new LdapRepositoryConfigurationExtension();
 	}
+
 }

src/main/java/org/springframework/data/ldap/repository/config/LdapRepositoryConfigurationExtension.java

@@ -112,4 +112,5 @@ public void registerBeansForRoot(BeanDefinitionRegistry registry, RepositoryConf
 	protected boolean useRepositoryConfiguration(RepositoryMetadata metadata) {
 		return !metadata.isReactiveRepository();
 	}
+
 }

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

@@ -1,7 +1,5 @@
 /**
  * Support infrastructure for the configuration of LDAP specific repositories.
  */
-@NonNullApi
+@org.jspecify.annotations.NullMarked
 package org.springframework.data.ldap.repository.config;
-
-import org.springframework.lang.NonNullApi;

src/main/java/org/springframework/data/ldap/repository/package-info.java

@@ -1,5 +1,5 @@
 /**
  * LDAP specific repository implementation.
  */
-@org.springframework.lang.NonNullApi
+@org.jspecify.annotations.NullMarked
 package org.springframework.data.ldap.repository;

src/main/java/org/springframework/data/ldap/repository/query/AbstractLdapRepositoryQuery.java

@@ -17,6 +17,8 @@
 
 import static org.springframework.data.ldap.repository.query.LdapQueryExecution.*;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.core.convert.converter.Converter;
 import org.springframework.data.ldap.repository.Query;
 import org.springframework.data.mapping.PersistentEntity;
@@ -71,7 +73,7 @@ public AbstractLdapRepositoryQuery(LdapQueryMethod queryMethod, Class<?> entityT
 
 	@Override
 	@SuppressWarnings("ConstantConditions")
-	public final Object execute(Object[] parameters) {
+	public final @Nullable Object execute(Object[] parameters) {
 
 		LdapParametersParameterAccessor parameterAccessor = new LdapParametersParameterAccessor(queryMethod, parameters);
 		LdapQuery query = createQuery(parameterAccessor);
@@ -117,4 +119,5 @@ protected Class<?> getEntityClass() {
 	public final QueryMethod getQueryMethod() {
 		return queryMethod;
 	}
+
 }

src/main/java/org/springframework/data/ldap/repository/query/LdapParameterAccessor.java

@@ -31,4 +31,5 @@ public interface LdapParameterAccessor extends ParameterAccessor {
 	 * @return
 	 */
 	Object[] getBindableParameterValues();
+
 }

src/main/java/org/springframework/data/ldap/repository/query/LdapParameters.java

@@ -18,6 +18,8 @@
 import java.lang.reflect.Method;
 import java.util.List;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.beans.BeanUtils;
 import org.springframework.core.MethodParameter;
 import org.springframework.data.geo.Distance;
@@ -27,7 +29,6 @@
 import org.springframework.data.repository.query.Parameters;
 import org.springframework.data.repository.query.ParametersSource;
 import org.springframework.data.util.TypeInformation;
-import org.springframework.lang.Nullable;
 
 /**
  * Custom extension of {@link Parameters} discovering additional

src/main/java/org/springframework/data/ldap/repository/query/LdapQueryCreator.java

@@ -15,11 +15,11 @@
  */
 package org.springframework.data.ldap.repository.query;
 
-import static org.springframework.ldap.query.LdapQueryBuilder.*;
-
 import java.util.Iterator;
 import java.util.List;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.core.annotation.AnnotatedElementUtils;
 import org.springframework.data.domain.Sort;
 import org.springframework.data.mapping.PropertyPath;
@@ -73,7 +73,7 @@ protected ContainerCriteria create(Part part, Iterator<Object> iterator) {
 
 		Entry entry = AnnotatedElementUtils.findMergedAnnotation(entityType, Entry.class);
 
-		LdapQueryBuilder query = query();
+		LdapQueryBuilder query = LdapQueryBuilder.query();
 
 		if (entry != null) {
 			query = query.base(entry.base());
@@ -148,7 +148,8 @@ protected ContainerCriteria or(ContainerCriteria base, ContainerCriteria criteri
 	}
 
 	@Override
-	protected LdapQuery complete(ContainerCriteria criteria, Sort sort) {
-		return criteria;
+	protected LdapQuery complete(@Nullable ContainerCriteria criteria, Sort sort) {
+		return criteria == null ? LdapQueryBuilder.query() : criteria;
 	}
+
 }

src/main/java/org/springframework/data/ldap/repository/query/LdapQueryExecution.java

@@ -15,6 +15,8 @@
  */
 package org.springframework.data.ldap.repository.query;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.core.convert.converter.Converter;
 import org.springframework.dao.EmptyResultDataAccessException;
 import org.springframework.data.convert.DtoInstantiatingConverter;
@@ -39,6 +41,7 @@
 @FunctionalInterface
 interface LdapQueryExecution {
 
+	@Nullable
 	Object execute(LdapQuery query);
 
 	/**
@@ -57,13 +60,14 @@ final class FindOneExecution implements LdapQueryExecution {
 		}
 
 		@Override
-		public Object execute(LdapQuery query) {
+		public @Nullable Object execute(LdapQuery query) {
 			try {
 				return operations.findOne(query, entityType);
 			} catch (EmptyResultDataAccessException e) {
 				return null;
 			}
 		}
+
 	}
 
 	/**
@@ -85,6 +89,7 @@ final class CollectionExecution implements LdapQueryExecution {
 		public Object execute(LdapQuery query) {
 			return operations.find(query, entityType);
 		}
+
 	}
 
 	/**
@@ -108,6 +113,7 @@ final class StreamExecution implements LdapQueryExecution {
 		public Object execute(LdapQuery query) {
 			return operations.find(query, entityType).stream().map(resultProcessing::convert);
 		}
+
 	}
 
 	/**
@@ -124,9 +130,12 @@ public ResultProcessingExecution(LdapQueryExecution delegate, Converter<Object,
 		}
 
 		@Override
-		public Object execute(LdapQuery query) {
-			return converter.convert(delegate.execute(query));
+		public @Nullable Object execute(LdapQuery query) {
+
+			Object result = delegate.execute(query);
+			return result != null ? converter.convert(result) : null;
 		}
+
 	}
 
 	/**
@@ -149,7 +158,7 @@ public ResultProcessingConverter(ResultProcessor processor,
 		}
 
 		@Override
-		public Object convert(Object source) {
+		public @Nullable Object convert(@Nullable Object source) {
 
 			ReturnedType returnedType = processor.getReturnedType();
 
@@ -165,5 +174,7 @@ public Object convert(Object source) {
 
 			return processor.processResult(source, converter);
 		}
+
 	}
+
 }

src/main/java/org/springframework/data/ldap/repository/query/LdapQueryMethod.java

@@ -17,12 +17,13 @@
 
 import java.lang.reflect.Method;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.data.ldap.repository.Query;
 import org.springframework.data.projection.ProjectionFactory;
 import org.springframework.data.repository.core.RepositoryMetadata;
 import org.springframework.data.repository.query.QueryMethod;
-import org.springframework.lang.Nullable;
 
 /**
  * QueryMethod for Ldap Queries.

src/main/java/org/springframework/data/ldap/repository/query/PartTreeLdapRepositoryQuery.java

@@ -74,4 +74,5 @@ protected LdapQuery createQuery(LdapParameterAccessor parameters) {
 				getEntityClass(), objectDirectoryMapper, parameters, inputProperties);
 		return queryCreator.createQuery();
 	}
+
 }

src/main/java/org/springframework/data/ldap/repository/query/StringBasedQuery.java

@@ -27,14 +27,15 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.data.expression.ValueExpression;
 import org.springframework.data.expression.ValueExpressionParser;
 import org.springframework.data.repository.query.Parameter;
 import org.springframework.data.repository.query.ParameterAccessor;
 import org.springframework.data.repository.query.Parameters;
 import org.springframework.data.repository.query.ValueExpressionDelegate;
 import org.springframework.data.spel.ExpressionDependencies;
-import org.springframework.lang.Nullable;
 import org.springframework.ldap.support.LdapEncoder;
 import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
@@ -245,6 +246,7 @@ private static Matcher findNextBindingOrExpression(String input, int startPositi
 
 			return (matcherMap.isEmpty() ? null : matcherMap.values().iterator().next());
 		}
+
 	}
 
 	/**
@@ -288,6 +290,7 @@ public static String bind(String input, List<Object> parameters) {
 
 			return result.append(input.subSequence(currentPosition, input.length())).toString();
 		}
+
 	}
 
 	/**
@@ -349,8 +352,7 @@ public List<Object> getBindingValues() {
 		 * @param binding must not be {@literal null}.
 		 * @return the value used for the given {@link ParameterBinding}.
 		 */
-		@Nullable
-		private Object getParameterValueForBinding(ParameterBinding binding) {
+		private @Nullable Object getParameterValueForBinding(ParameterBinding binding) {
 
 			if (binding.isExpression()) {
 				return evaluator.apply(binding.getRequiredExpression());
@@ -439,6 +441,9 @@ String getRequiredParameterName() {
 
 				return parameterName;
 			}
+
 		}
+
 	}
+
 }

src/main/java/org/springframework/data/ldap/repository/query/package-info.java

@@ -1,7 +1,5 @@
 /**
  * Query derivation mechanism for LDAP specific repositories.
  */
-@NonNullApi
+@org.jspecify.annotations.NullMarked
 package org.springframework.data.ldap.repository.query;
-
-import org.springframework.lang.NonNullApi;

src/main/java/org/springframework/data/ldap/repository/support/DefaultLdapAnnotationProcessorConfiguration.java

@@ -22,7 +22,8 @@
 import javax.annotation.processing.RoundEnvironment;
 import javax.lang.model.element.VariableElement;
 
-import org.springframework.lang.Nullable;
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.ldap.odm.annotations.Id;
 
 import com.querydsl.apt.DefaultConfiguration;
@@ -55,4 +56,5 @@ public boolean isBlockedField(VariableElement field) {
 	public boolean isValidField(VariableElement field) {
 		return super.isValidField(field) && field.getAnnotation(Id.class) == null;
 	}
+
 }