Switch to jspecify nullability annotations.

Original Pull Request #3065
Closes #2984

Signed-off-by: Peter-Josef Meisch <[email protected]>

Author: sothawo

src/main/antora/modules/ROOT/pages/elasticsearch/auditing.adoc

@@ -10,7 +10,7 @@ In order for the auditing code to be able to decide whether an entity instance i
 ----
 package org.springframework.data.domain;
 
-import org.springframework.lang.Nullable;
+import org.jspecify.annotations.Nullable;
 
 public interface Persistable<ID> {
     @Nullable
@@ -81,5 +81,5 @@ class MyConfiguration {
 }
 ----
 
-If your code contains more than one `AuditorAware` bean for different types, you must provide the name of the bean to use as an argument to the `auditorAwareRef` parameter of the 
- `@EnableElasticsearchAuditing` annotation. 
+If your code contains more than one `AuditorAware` bean for different types, you must provide the name of the bean to use as an argument to the `auditorAwareRef` parameter of the
+ `@EnableElasticsearchAuditing` annotation.

src/main/antora/modules/ROOT/pages/elasticsearch/scripted-and-runtime-fields.adoc

@@ -20,12 +20,12 @@ Whereas the birthdate is fix, the age depends on the time when a query is issued
 ====
 [source,java]
 ----
+import org.jspecify.annotations.Nullable;
 import org.springframework.data.annotation.Id;
 import org.springframework.data.elasticsearch.annotations.DateFormat;
 import org.springframework.data.elasticsearch.annotations.Document;
 import org.springframework.data.elasticsearch.annotations.Field;
 import org.springframework.data.elasticsearch.annotations.ScriptedField;
-import org.springframework.lang.Nullable;
 
 import java.time.LocalDate;
 import java.time.format.DateTimeFormatter;

src/main/java/org/springframework/data/elasticsearch/ElasticsearchErrorCause.java

@@ -15,19 +15,18 @@
  */
 package org.springframework.data.elasticsearch;
 
-import org.springframework.lang.Nullable;
-
 import java.util.List;
 
+import org.jspecify.annotations.Nullable;
+
 /**
  * Object describing an Elasticsearch error
  *
  * @author Peter-Josef Meisch
  * @since 4.4
  */
 public class ElasticsearchErrorCause {
-	@Nullable
-	private final String type;
+	@Nullable private final String type;
 
 	private final String reason;
 

src/main/java/org/springframework/data/elasticsearch/UncategorizedElasticsearchException.java

@@ -15,8 +15,8 @@
  */
 package org.springframework.data.elasticsearch;
 
+import org.jspecify.annotations.Nullable;
 import org.springframework.dao.UncategorizedDataAccessException;
-import org.springframework.lang.Nullable;
 
 /**
  * @author Peter-Josef Meisch

src/main/java/org/springframework/data/elasticsearch/annotations/package-info.java

@@ -1,3 +1,2 @@
-@org.springframework.lang.NonNullApi
-@org.springframework.lang.NonNullFields
+@org.jspecify.annotations.NullMarked
 package org.springframework.data.elasticsearch.annotations;

src/main/java/org/springframework/data/elasticsearch/aot/SpringDataElasticsearchRuntimeHints.java

@@ -19,6 +19,7 @@
 
 import java.util.Arrays;
 
+import org.jspecify.annotations.Nullable;
 import org.springframework.aot.hint.MemberCategory;
 import org.springframework.aot.hint.RuntimeHints;
 import org.springframework.aot.hint.RuntimeHintsRegistrar;
@@ -32,7 +33,6 @@
 import org.springframework.data.elasticsearch.core.event.ReactiveAfterLoadCallback;
 import org.springframework.data.elasticsearch.core.event.ReactiveAfterSaveCallback;
 import org.springframework.data.elasticsearch.core.event.ReactiveBeforeConvertCallback;
-import org.springframework.lang.Nullable;
 
 /**
  * @author Peter-Josef Meisch

src/main/java/org/springframework/data/elasticsearch/aot/package-info.java

@@ -1,3 +1,2 @@
-@org.springframework.lang.NonNullApi
-@org.springframework.lang.NonNullFields
+@org.jspecify.annotations.NullMarked
 package org.springframework.data.elasticsearch.aot;

src/main/java/org/springframework/data/elasticsearch/client/ClientConfiguration.java

@@ -25,8 +25,8 @@
 import javax.net.ssl.HostnameVerifier;
 import javax.net.ssl.SSLContext;
 
+import org.jspecify.annotations.Nullable;
 import org.springframework.data.elasticsearch.support.HttpHeaders;
-import org.springframework.lang.Nullable;
 
 /**
  * Configuration interface exposing common client configuration properties for Elasticsearch clients.

src/main/java/org/springframework/data/elasticsearch/client/ClientConfigurationBuilder.java

@@ -25,11 +25,11 @@
 import javax.net.ssl.HostnameVerifier;
 import javax.net.ssl.SSLContext;
 
+import org.jspecify.annotations.Nullable;
 import org.springframework.data.elasticsearch.client.ClientConfiguration.ClientConfigurationBuilderWithRequiredEndpoint;
 import org.springframework.data.elasticsearch.client.ClientConfiguration.MaybeSecureClientConfigurationBuilder;
 import org.springframework.data.elasticsearch.client.ClientConfiguration.TerminalClientConfigurationBuilder;
 import org.springframework.data.elasticsearch.support.HttpHeaders;
-import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**

src/main/java/org/springframework/data/elasticsearch/client/DefaultClientConfiguration.java

@@ -24,9 +24,8 @@
 import javax.net.ssl.HostnameVerifier;
 import javax.net.ssl.SSLContext;
 
-import org.elasticsearch.client.RestClientBuilder.HttpClientConfigCallback;
+import org.jspecify.annotations.Nullable;
 import org.springframework.data.elasticsearch.support.HttpHeaders;
-import org.springframework.lang.Nullable;
 
 /**
  * Default {@link ClientConfiguration} implementation.

src/main/java/org/springframework/data/elasticsearch/client/elc/AbstractQueryProcessor.java

@@ -17,10 +17,10 @@
 
 import java.util.function.Consumer;
 
+import org.jspecify.annotations.Nullable;
 import org.springframework.data.elasticsearch.core.query.CriteriaQuery;
 import org.springframework.data.elasticsearch.core.query.Query;
 import org.springframework.data.elasticsearch.core.query.StringQuery;
-import org.springframework.lang.Nullable;
 
 /**
  * An abstract class that serves as a base for query processors. It provides a common interface and basic functionality
@@ -38,8 +38,8 @@ public abstract class AbstractQueryProcessor {
 	 * @param queryConverter correct mapped field names and the values to the converted values.
 	 * @return an Elasticsearch {@literal query}.
 	 */
-	@Nullable
-	static co.elastic.clients.elasticsearch._types.query_dsl.Query getEsQuery(@Nullable Query query,
+
+	static co.elastic.clients.elasticsearch._types.query_dsl.@Nullable Query getEsQuery(@Nullable Query query,
 			@Nullable Consumer<Query> queryConverter) {
 		if (query == null) {
 			return null;

src/main/java/org/springframework/data/elasticsearch/client/elc/CriteriaQueryProcessor.java

@@ -31,13 +31,13 @@
 import java.util.List;
 import java.util.Objects;
 
+import org.jspecify.annotations.Nullable;
 import org.springframework.data.elasticsearch.annotations.FieldType;
 import org.springframework.data.elasticsearch.core.query.Criteria;
 import org.springframework.data.elasticsearch.core.query.Field;
 import org.springframework.data.elasticsearch.core.query.HasChildQuery;
 import org.springframework.data.elasticsearch.core.query.HasParentQuery;
 import org.springframework.data.elasticsearch.core.query.InnerHitsQuery;
-import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**

src/main/java/org/springframework/data/elasticsearch/client/elc/DocumentAdapters.java

@@ -34,14 +34,14 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.Nullable;
 import org.springframework.data.elasticsearch.core.MultiGetItem;
 import org.springframework.data.elasticsearch.core.document.Document;
 import org.springframework.data.elasticsearch.core.document.Explanation;
 import org.springframework.data.elasticsearch.core.document.NestedMetaData;
 import org.springframework.data.elasticsearch.core.document.SearchDocument;
 import org.springframework.data.elasticsearch.core.document.SearchDocumentAdapter;
 import org.springframework.data.elasticsearch.core.document.SearchDocumentResponse;
-import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**
@@ -160,7 +160,7 @@ public static SearchDocument from(CompletionSuggestOption<EntityAsMap> completio
 	}
 
 	@Nullable
-	private static Explanation from(@Nullable co.elastic.clients.elasticsearch.core.explain.Explanation explanation) {
+	private static Explanation from(co.elastic.clients.elasticsearch.core.explain.@Nullable Explanation explanation) {
 
 		if (explanation == null) {
 			return null;

src/main/java/org/springframework/data/elasticsearch/client/elc/ElasticsearchAggregations.java

@@ -22,8 +22,8 @@
 import java.util.List;
 import java.util.Map;
 
+import org.jspecify.annotations.Nullable;
 import org.springframework.data.elasticsearch.core.AggregationsContainer;
-import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**

src/main/java/org/springframework/data/elasticsearch/client/elc/ElasticsearchClientFactoryBean.java

@@ -19,12 +19,12 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.Nullable;
 import org.springframework.beans.factory.DisposableBean;
 import org.springframework.beans.factory.FactoryBean;
 import org.springframework.beans.factory.FactoryBeanNotInitializedException;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.data.elasticsearch.client.ClientConfiguration;
-import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**

src/main/java/org/springframework/data/elasticsearch/client/elc/ElasticsearchClients.java

@@ -46,9 +46,9 @@
 import org.elasticsearch.client.RequestOptions;
 import org.elasticsearch.client.RestClient;
 import org.elasticsearch.client.RestClientBuilder;
+import org.jspecify.annotations.Nullable;
 import org.springframework.data.elasticsearch.client.ClientConfiguration;
 import org.springframework.data.elasticsearch.support.HttpHeaders;
-import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**

src/main/java/org/springframework/data/elasticsearch/client/elc/ElasticsearchTemplate.java

@@ -40,6 +40,7 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.Nullable;
 import org.springframework.data.elasticsearch.BulkFailureException;
 import org.springframework.data.elasticsearch.client.UnsupportedBackendOperation;
 import org.springframework.data.elasticsearch.core.AbstractElasticsearchTemplate;
@@ -59,7 +60,6 @@
 import org.springframework.data.elasticsearch.core.reindex.ReindexResponse;
 import org.springframework.data.elasticsearch.core.script.Script;
 import org.springframework.data.elasticsearch.core.sql.SqlResponse;
-import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**

src/main/java/org/springframework/data/elasticsearch/client/elc/HighlightQueryBuilder.java

@@ -20,14 +20,14 @@
 import java.util.Arrays;
 import java.util.stream.Collectors;
 
+import org.jspecify.annotations.Nullable;
 import org.springframework.data.elasticsearch.core.mapping.ElasticsearchPersistentEntity;
 import org.springframework.data.elasticsearch.core.mapping.ElasticsearchPersistentProperty;
 import org.springframework.data.elasticsearch.core.query.highlight.Highlight;
 import org.springframework.data.elasticsearch.core.query.highlight.HighlightField;
 import org.springframework.data.elasticsearch.core.query.highlight.HighlightFieldParameters;
 import org.springframework.data.elasticsearch.core.query.highlight.HighlightParameters;
 import org.springframework.data.mapping.context.MappingContext;
-import org.springframework.lang.Nullable;
 import org.springframework.util.StringUtils;
 
 /**
@@ -43,7 +43,8 @@ class HighlightQueryBuilder {
 	private final RequestConverter requestConverter;
 
 	HighlightQueryBuilder(
-			MappingContext<? extends ElasticsearchPersistentEntity<?>, ElasticsearchPersistentProperty> mappingContext, RequestConverter requestConverter) {
+			MappingContext<? extends ElasticsearchPersistentEntity<?>, ElasticsearchPersistentProperty> mappingContext,
+			RequestConverter requestConverter) {
 		this.mappingContext = mappingContext;
 		this.requestConverter = requestConverter;
 	}

src/main/java/org/springframework/data/elasticsearch/client/elc/IndicesTemplate.java

@@ -27,6 +27,7 @@
 import java.util.Objects;
 import java.util.Set;
 
+import org.jspecify.annotations.Nullable;
 import org.springframework.core.annotation.AnnotatedElementUtils;
 import org.springframework.dao.InvalidDataAccessApiUsageException;
 import org.springframework.data.elasticsearch.UncategorizedElasticsearchException;
@@ -49,7 +50,6 @@
 import org.springframework.data.elasticsearch.core.mapping.CreateIndexSettings;
 import org.springframework.data.elasticsearch.core.mapping.ElasticsearchPersistentEntity;
 import org.springframework.data.elasticsearch.core.mapping.IndexCoordinates;
-import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**

src/main/java/org/springframework/data/elasticsearch/client/elc/JsonUtils.java

@@ -23,7 +23,7 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
-import org.springframework.lang.Nullable;
+import org.jspecify.annotations.Nullable;
 
 /**
  * @author Peter-Josef Meisch
@@ -48,7 +48,7 @@ public static String toJson(Object object, JsonpMapper mapper) {
 	}
 
 	@Nullable
-	public static String queryToJson(@Nullable co.elastic.clients.elasticsearch._types.query_dsl.Query query,
+	public static String queryToJson(co.elastic.clients.elasticsearch._types.query_dsl.@Nullable Query query,
 			JsonpMapper mapper) {
 
 		if (query == null) {

src/main/java/org/springframework/data/elasticsearch/client/elc/NativeQuery.java

@@ -28,8 +28,8 @@
 import java.util.List;
 import java.util.Map;
 
+import org.jspecify.annotations.Nullable;
 import org.springframework.data.elasticsearch.core.query.BaseQuery;
-import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**
@@ -44,7 +44,7 @@
 public class NativeQuery extends BaseQuery {
 
 	@Nullable private final Query query;
-	@Nullable private org.springframework.data.elasticsearch.core.query.Query springDataQuery;
+	private org.springframework.data.elasticsearch.core.query.@Nullable Query springDataQuery;
 	@Nullable private Query filter;
 	// note: the new client does not have pipeline aggs, these are just set up as normal aggs
 	private final Map<String, Aggregation> aggregations = new LinkedHashMap<>();
@@ -117,7 +117,7 @@ public Map<String, JsonData> getSearchExtensions() {
 	 * @see NativeQueryBuilder#withQuery(org.springframework.data.elasticsearch.core.query.Query).
 	 * @since 5.1
 	 */
-	public void setSpringDataQuery(@Nullable org.springframework.data.elasticsearch.core.query.Query springDataQuery) {
+	public void setSpringDataQuery(org.springframework.data.elasticsearch.core.query.@Nullable Query springDataQuery) {
 		this.springDataQuery = springDataQuery;
 	}
 
@@ -129,8 +129,7 @@ public List<KnnSearch> getKnnSearches() {
 		return knnSearches;
 	}
 
-	@Nullable
-	public org.springframework.data.elasticsearch.core.query.Query getSpringDataQuery() {
+	public org.springframework.data.elasticsearch.core.query.@Nullable Query getSpringDataQuery() {
 		return springDataQuery;
 	}
 }

src/main/java/org/springframework/data/elasticsearch/client/elc/NativeQueryBuilder.java

@@ -33,8 +33,8 @@
 import java.util.Map;
 import java.util.function.Function;
 
+import org.jspecify.annotations.Nullable;
 import org.springframework.data.elasticsearch.core.query.BaseQueryBuilder;
-import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**
@@ -53,7 +53,7 @@ public class NativeQueryBuilder extends BaseQueryBuilder<NativeQuery, NativeQuer
 	private final List<SortOptions> sortOptions = new ArrayList<>();
 	private final Map<String, JsonData> searchExtensions = new LinkedHashMap<>();
 
-	@Nullable private org.springframework.data.elasticsearch.core.query.Query springDataQuery;
+	private org.springframework.data.elasticsearch.core.query.@Nullable Query springDataQuery;
 	@Nullable private KnnQuery knnQuery;
 	@Nullable private List<KnnSearch> knnSearches = Collections.emptyList();
 
@@ -104,8 +104,7 @@ public List<KnnSearch> getKnnSearches() {
 		return knnSearches;
 	}
 
-	@Nullable
-	public org.springframework.data.elasticsearch.core.query.Query getSpringDataQuery() {
+	public org.springframework.data.elasticsearch.core.query.@Nullable Query getSpringDataQuery() {
 		return springDataQuery;
 	}
 

src/main/java/org/springframework/data/elasticsearch/client/elc/Queries.java

@@ -34,9 +34,9 @@
 import java.util.List;
 import java.util.function.Function;
 
+import org.jspecify.annotations.Nullable;
 import org.springframework.data.elasticsearch.core.geo.GeoPoint;
 import org.springframework.data.elasticsearch.core.query.BaseQueryBuilder;
-import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**

src/main/java/org/springframework/data/elasticsearch/client/elc/ReactiveElasticsearchClient.java

@@ -30,7 +30,7 @@
 import java.io.IOException;
 import java.util.function.Function;
 
-import org.springframework.lang.Nullable;
+import org.jspecify.annotations.Nullable;
 import org.springframework.util.Assert;
 
 /**