Add missing since attributes to @deprecated

Author: marko-bekhta

backend/elasticsearch-aws/src/main/java/org/hibernate/search/backend/elasticsearch/aws/spi/ElasticsearcAwsCredentialsProvider.java

@@ -11,7 +11,7 @@
 /**
  * @deprecated Implement {@link ElasticsearchAwsCredentialsProvider} instead.
  */
-@Deprecated
+@Deprecated(since = "6.1")
 public interface ElasticsearcAwsCredentialsProvider extends ElasticsearchAwsCredentialsProvider {
 
 	AwsCredentialsProvider create(ConfigurationPropertySource propertySource);

backend/elasticsearch/src/main/java/org/hibernate/search/backend/elasticsearch/ElasticsearchVersion.java

@@ -176,7 +176,7 @@ public ElasticsearchDistributionName distribution() {
 	 * @return The "major" number of this version, i.e. the {@code x} in {@code x.y.z-qualifier}.
 	 * @deprecated Use {@link #majorOptional()} instead.
 	 */
-	@Deprecated
+	@Deprecated(since = "7.0")
 	public int major() {
 		if ( major == null ) {
 			return 0;

backend/elasticsearch/src/main/java/org/hibernate/search/backend/elasticsearch/cfg/ElasticsearchBackendSettings.java

@@ -341,15 +341,15 @@ private Defaults() {
 		 * is now dynamic and depends on the value of the {@link ElasticsearchBackendSettings#VERSION} property.
 		 * @see ElasticsearchBackendSettings#VERSION_CHECK_ENABLED
 		 */
-		@Deprecated
+		@Deprecated(since = "7.0")
 		public static final boolean VERSION_CHECK_ENABLED = true;
 
 		/**
 		 * @deprecated The default for this property is now dynamic and depends on the mapper.
 		 * If the multi-tenancy is enabled in the mapper, the default is {@link MultiTenancyStrategyName#DISCRIMINATOR}.
 		 * Otherwise, the default is still {@link MultiTenancyStrategyName#NONE}.
 		 */
-		@Deprecated
+		@Deprecated(since = "6.1")
 		public static final MultiTenancyStrategyName MULTI_TENANCY_STRATEGY = MultiTenancyStrategyName.NONE;
 
 		public static final TypeNameMappingStrategyName MAPPING_TYPE_NAME_STRATEGY = TypeNameMappingStrategyName.DISCRIMINATOR;

backend/elasticsearch/src/main/java/org/hibernate/search/backend/elasticsearch/cfg/ElasticsearchIndexSettings.java

@@ -181,7 +181,7 @@ private Defaults() {
 		 * is now dynamic and depends on the targeted Elasticsearch distribution.
 		 * @see ElasticsearchIndexSettings#SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS
 		 */
-		@Deprecated
+		@Deprecated(since = "7.0")
 		public static final IndexStatus SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS = IndexStatus.YELLOW;
 		public static final int SCHEMA_MANAGEMENT_MINIMAL_REQUIRED_STATUS_WAIT_TIMEOUT = 10_000;
 		public static final int INDEXING_QUEUE_COUNT = 10;

backend/elasticsearch/src/main/java/org/hibernate/search/backend/elasticsearch/cfg/spi/ElasticsearchBackendImplSettings.java

@@ -9,7 +9,7 @@
  *
  * @deprecated Use {@link org.hibernate.search.backend.elasticsearch.cfg.impl.ElasticsearchBackendImplSettings} instead.
  */
-@Deprecated
+@Deprecated(since = "6.2")
 public final class ElasticsearchBackendImplSettings {
 
 	private ElasticsearchBackendImplSettings() {

backend/lucene/src/main/java/org/hibernate/search/backend/lucene/cfg/LuceneBackendSettings.java

@@ -106,7 +106,7 @@ private Defaults() {
 		 * If the multi-tenancy is enabled in the mapper, the default is {@link MultiTenancyStrategyName#DISCRIMINATOR}.
 		 * Otherwise, the default is still {@link MultiTenancyStrategyName#NONE}.
 		 */
-		@Deprecated
+		@Deprecated(since = "6.1")
 		public static final MultiTenancyStrategyName MULTI_TENANCY_STRATEGY = MultiTenancyStrategyName.NONE;
 	}
 }

build/config/src/main/resources/checkstyle.xml

@@ -110,6 +110,11 @@
 		<property name="message" value="Avoid throwing 'AssertionError': use org.hibernate.search.util.common.AssertionFailure" />
 	</module>
 
+	<module name="RegexpSingleline">
+		<property name="format" value="@Deprecated(?:\s*+\(\s*+(?!.*\bsince\s*+=).*\))?\s*+[^(].*+" />
+		<property name="message" value="When deprecating something include the `since` attribute" />
+	</module>
+
 	<module name="SuppressionFilter">
 		<property name="file" value="/suppressions.xml" />
 	</module>

engine/src/main/java/org/hibernate/search/engine/Version.java

@@ -28,7 +28,7 @@ public static String versionString() {
 	 * @return A string representation of the version of Hibernate Search.
 	 * @deprecated Use {@link #versionString()} instead.
 	 */
-	@Deprecated
+	@Deprecated(since = "6.0")
 	@Search5DeprecatedAPI
 	public static String getVersionString() {
 		return versionString();

engine/src/main/java/org/hibernate/search/engine/backend/orchestration/spi/BatchingExecutor.java

@@ -105,7 +105,7 @@ public synchronized void stop() {
 	/**
 	 * @deprecated Use {@link #submit(BatchedWork, OperationSubmitter)} instead.
 	 */
-	@Deprecated
+	@Deprecated(since = "6.2")
 	public void submit(W work) throws InterruptedException {
 		submit( work, OperationSubmitter.blocking() );
 	}

engine/src/main/java/org/hibernate/search/engine/backend/types/converter/FromDocumentFieldValueConverter.java

@@ -13,7 +13,7 @@
  * @param <V> The type of target values.
  * @deprecated Implement {@link FromDocumentValueConverter} instead.
  */
-@Deprecated
+@Deprecated(since = "6.1")
 public interface FromDocumentFieldValueConverter<F, V> extends FromDocumentValueConverter<F, V> {
 
 	@Override

engine/src/main/java/org/hibernate/search/engine/backend/types/converter/ToDocumentFieldValueConverter.java

@@ -13,7 +13,7 @@
  * @param <F> The type of target, index field values.
  * @deprecated Implement {@link ToDocumentValueConverter} instead.
  */
-@Deprecated
+@Deprecated(since = "6.1")
 public interface ToDocumentFieldValueConverter<V, F> extends ToDocumentValueConverter<V, F> {
 
 	@Override

engine/src/main/java/org/hibernate/search/engine/backend/types/converter/runtime/FromDocumentFieldValueConvertContext.java

@@ -10,7 +10,7 @@
  * @deprecated Use {@link org.hibernate.search.engine.backend.types.converter.FromDocumentValueConverter}
  * with {@link FromDocumentValueConvertContext} instead.
  */
-@Deprecated
+@Deprecated(since = "6.1")
 public interface FromDocumentFieldValueConvertContext {
 
 	/**

engine/src/main/java/org/hibernate/search/engine/backend/types/converter/runtime/FromDocumentFieldValueConvertContextExtension.java

@@ -23,7 +23,7 @@
  * @deprecated Use {@link org.hibernate.search.engine.backend.types.converter.FromDocumentValueConverter}
  * with {@link FromDocumentValueConvertContext} and {@link FromDocumentValueConvertContextExtension} instead.
  */
-@Deprecated
+@Deprecated(since = "6.1")
 public interface FromDocumentFieldValueConvertContextExtension<T> extends FromDocumentValueConvertContextExtension<T> {
 
 	@Override

engine/src/main/java/org/hibernate/search/engine/backend/types/converter/runtime/ToDocumentFieldValueConvertContext.java

@@ -10,7 +10,7 @@
  * @deprecated Use {@link org.hibernate.search.engine.backend.types.converter.ToDocumentValueConverter}
  * with {@link ToDocumentValueConvertContext} instead.
  */
-@Deprecated
+@Deprecated(since = "6.1")
 public interface ToDocumentFieldValueConvertContext {
 
 	/**

engine/src/main/java/org/hibernate/search/engine/backend/types/converter/runtime/ToDocumentFieldValueConvertContextExtension.java

@@ -23,7 +23,7 @@
  * @deprecated Use {@link org.hibernate.search.engine.backend.types.converter.ToDocumentValueConverter}
  * with {@link ToDocumentValueConvertContext} and {@link ToDocumentValueConvertContextExtension} instead.
  */
-@Deprecated
+@Deprecated(since = "6.1")
 public interface ToDocumentFieldValueConvertContextExtension<T> extends ToDocumentValueConvertContextExtension<T> {
 
 	@Override

engine/src/main/java/org/hibernate/search/engine/backend/types/converter/runtime/spi/FromDocumentValueConvertContextImpl.java

@@ -17,7 +17,7 @@ public FromDocumentValueConvertContextImpl(BackendSessionContext sessionContext)
 	}
 
 	@Override
-	@Deprecated
+	@Deprecated(since = "6.1")
 	public <T> T extension(
 			org.hibernate.search.engine.backend.types.converter.runtime.FromDocumentFieldValueConvertContextExtension<
 					T> extension) {

engine/src/main/java/org/hibernate/search/engine/backend/types/converter/runtime/spi/ToDocumentValueConvertContextImpl.java

@@ -17,7 +17,7 @@ public ToDocumentValueConvertContextImpl(BackendMappingContext mappingContext) {
 	}
 
 	@Override
-	@Deprecated
+	@Deprecated(since = "6.1")
 	public <T> T extension(
 			org.hibernate.search.engine.backend.types.converter.runtime.ToDocumentFieldValueConvertContextExtension<
 					T> extension) {

engine/src/main/java/org/hibernate/search/engine/cfg/spi/KeyContext.java

@@ -17,7 +17,7 @@ public interface KeyContext {
 	 * @return The next context.
 	 * @deprecated Use {@link #asIntegerPositiveOrZeroOrNegative()} instead.
 	 */
-	@Deprecated
+	@Deprecated(since = "6.1")
 	default OptionalPropertyContext<Integer> asInteger() {
 		return asIntegerPositiveOrZeroOrNegative();
 	}
@@ -32,7 +32,7 @@ default OptionalPropertyContext<Integer> asInteger() {
 	 * @return The next context.
 	 * @deprecated Use {@link #asLongPositiveOrZeroOrNegative()} instead.
 	 */
-	@Deprecated
+	@Deprecated(since = "6.1")
 	default OptionalPropertyContext<Long> asLong() {
 		return asLongPositiveOrZeroOrNegative();
 	}

engine/src/main/java/org/hibernate/search/engine/reporting/EntityIndexingFailureContext.java

@@ -37,7 +37,7 @@ private EntityIndexingFailureContext(Builder builder) {
 	 */
 	// The cast is safe because Object is a supertype of EntityReference and the list is unmodifiable.
 	@SuppressWarnings({ "rawtypes", "unchecked" })
-	@Deprecated
+	@Deprecated(since = "6.2")
 	public List<Object> entityReferences() {
 		return (List<Object>) (List) failingEntityReferences;
 	}
@@ -70,7 +70,7 @@ private Builder() {
 		 * @param entityReference A reference to an entity related to the failing operation.
 		 * @deprecated Use {@link #failingEntityReference(EntityReference)} instead.
 		 */
-		@Deprecated
+		@Deprecated(since = "6.2")
 		public void entityReference(Object entityReference) {
 			// This may fail for callers that don't retrieve the reference the usual way,
 			// but we consider that acceptable as this builder should only be used by integrators

engine/src/main/java/org/hibernate/search/engine/search/aggregation/dsl/RangeAggregationFieldStep.java

@@ -39,7 +39,7 @@ default <F> RangeAggregationRangeStep<?, PDF, F> field(String fieldPath, Class<F
 	 * @return The next step.
 	 * @deprecated Use {@link #field(String, Class, ValueModel)} instead.
 	 */
-	@Deprecated
+	@Deprecated(since = "7.2")
 	default <F> RangeAggregationRangeStep<?, PDF, F> field(String fieldPath, Class<F> type,
 			org.hibernate.search.engine.search.common.ValueConvert convert) {
 		return field( fieldPath, type,

engine/src/main/java/org/hibernate/search/engine/search/aggregation/dsl/TermsAggregationFieldStep.java

@@ -40,7 +40,7 @@ default <F> TermsAggregationOptionsStep<?, PDF, F, Map<F, Long>> field(String fi
 	 * @return The next step.
 	 * @deprecated Use {@link #field(String, Class, ValueModel)} instead.
 	 */
-	@Deprecated
+	@Deprecated(since = "7.2")
 	default <F> TermsAggregationOptionsStep<?, PDF, F, Map<F, Long>> field(String fieldPath, Class<F> type,
 			org.hibernate.search.engine.search.common.ValueConvert convert) {
 		return field( fieldPath, type,

engine/src/main/java/org/hibernate/search/engine/search/common/ValueConvert.java

@@ -14,7 +14,7 @@
  * Specifies whether values should be converted during search queries.
  * @deprecated Use {@link ValueModel} instead.
  */
-@Deprecated
+@Deprecated(since = "7.2")
 public enum ValueConvert {
 
 	/**
@@ -43,7 +43,7 @@ public enum ValueConvert {
 	 *
 	 * @deprecated Use {@link ValueModel#MAPPING} instead.
 	 */
-	@Deprecated
+	@Deprecated(since = "7.2")
 	YES,
 	/**
 	 * Disables value conversion.
@@ -64,7 +64,7 @@ public enum ValueConvert {
 	 *
 	 * @deprecated Use {@link ValueModel#INDEX} instead.
 	 */
-	@Deprecated
+	@Deprecated(since = "7.2")
 	NO,
 	/**
 	 * The result of applying this constant is the same as {@link #YES}.
@@ -73,10 +73,10 @@ public enum ValueConvert {
 	 * It is used as default value in some annotations like {@code FieldProjection} to help determine
 	 * if the attribute value was not set explicitly.
 	 */
-	@Deprecated
+	@Deprecated(since = "7.2")
 	DEFAULT;
 
-	@Deprecated
+	@Deprecated(since = "7.2")
 	public static ValueModel toValueModel(ValueConvert valueConvert) {
 		Contracts.assertNotNull( valueConvert, "valueConvert" );
 		switch ( valueConvert ) {

engine/src/main/java/org/hibernate/search/engine/search/common/ValueModel.java

@@ -113,6 +113,6 @@ public enum ValueModel {
 	 * @deprecated This constant is deprecated and will be removed at the same time as the {@link ValueConvert} enum is removed.
 	 * Do <b>not</b> use this value explicitly.
 	 */
-	@Deprecated(forRemoval = true)
+	@Deprecated(since = "7.2", forRemoval = true)
 	DEFAULT
 }

engine/src/main/java/org/hibernate/search/engine/search/predicate/definition/PredicateDefinitionContext.java

@@ -36,7 +36,7 @@ public interface PredicateDefinitionContext {
 	 * @see NamedPredicateOptionsStep#param(String, Object)
 	 * @deprecated Use {@link #params()} instead.
 	 */
-	@Deprecated
+	@Deprecated(since = "7.0")
 	default Object param(String name) {
 		return params().get( name, Object.class );
 	}
@@ -50,7 +50,7 @@ default Object param(String name) {
 	 * @see NamedPredicateOptionsStep#param(String, Object)
 	 * @deprecated Use {@link #params()} instead.
 	 */
-	@Deprecated
+	@Deprecated(since = "7.2")
 	default <T> T param(String name, Class<T> paramType) {
 		return params().get( name, paramType );
 	}
@@ -62,7 +62,7 @@ default <T> T param(String name, Class<T> paramType) {
 	 * @see NamedPredicateOptionsStep#param(String, Object)
 	 * @deprecated Use {@link #params()} instead.
 	 */
-	@Deprecated
+	@Deprecated(since = "7.0")
 	default Optional<Object> paramOptional(String name) {
 		return params().getOptional( name, Object.class );
 	}
@@ -76,7 +76,7 @@ default Optional<Object> paramOptional(String name) {
 	 * @see NamedPredicateOptionsStep#param(String, Object)
 	 * @deprecated Use {@link #params()} instead.
 	 */
-	@Deprecated
+	@Deprecated(since = "7.2")
 	default <T> Optional<T> paramOptional(String name, Class<T> paramType) {
 		return params().getOptional( name, paramType );
 	}

engine/src/main/java/org/hibernate/search/engine/search/predicate/dsl/MatchIdPredicateMatchingStep.java

@@ -39,7 +39,7 @@ default N matching(Object value) {
 	 * @return The next step.
 	 * @deprecated Use {@link #matching(Object, ValueModel)} instead.
 	 */
-	@Deprecated
+	@Deprecated(since = "7.2")
 	default N matching(Object value, org.hibernate.search.engine.search.common.ValueConvert convert) {
 		return matching( value, org.hibernate.search.engine.search.common.ValueConvert.toValueModel( convert ) );
 	}
@@ -75,7 +75,7 @@ default N matchingAny(Collection<?> values) {
 	 * @return The next step.
 	 * @deprecated Use {@link #matchingAny(Collection, ValueModel)} instead.
 	 */
-	@Deprecated
+	@Deprecated(since = "7.2")
 	default N matchingAny(Collection<?> values, org.hibernate.search.engine.search.common.ValueConvert convert) {
 		return matching( values, org.hibernate.search.engine.search.common.ValueConvert.toValueModel( convert ) );
 	}

engine/src/main/java/org/hibernate/search/engine/search/predicate/dsl/MatchPredicateMatchingStep.java

@@ -45,7 +45,7 @@ default N matching(Object value) {
 	 *
 	 * @see org.hibernate.search.engine.search.common.ValueConvert
 	 */
-	@Deprecated
+	@Deprecated(since = "7.2")
 	default N matching(Object value, org.hibernate.search.engine.search.common.ValueConvert convert) {
 		return matching( value, org.hibernate.search.engine.search.common.ValueConvert.toValueModel( convert ) );
 	}

engine/src/main/java/org/hibernate/search/engine/search/predicate/dsl/NestedPredicateFieldStep.java

@@ -12,7 +12,7 @@
  * @param <N> The type of the next step.
  * @deprecated Use {@link SearchPredicateFactory#nested(String)} instead.
  */
-@Deprecated
+@Deprecated(since = "6.2")
 public interface NestedPredicateFieldStep<N extends NestedPredicateNestStep<?>> {
 
 	/**

engine/src/main/java/org/hibernate/search/engine/search/predicate/dsl/NestedPredicateNestStep.java

@@ -14,7 +14,7 @@
  * @param <N> The type of the next step.
  * @deprecated Use {@link SearchPredicateFactory#nested(String)} instead.
  */
-@Deprecated
+@Deprecated(since = "6.2")
 public interface NestedPredicateNestStep<N extends NestedPredicateOptionsStep<?>> {
 
 	/**

engine/src/main/java/org/hibernate/search/engine/search/predicate/dsl/NestedPredicateOptionsStep.java

@@ -10,7 +10,7 @@
  * @param <S> The "self" type (the actual exposed type of this step).
  * @deprecated Use {@link SearchPredicateFactory#nested(String)} instead.
  */
-@Deprecated
+@Deprecated(since = "6.2")
 public interface NestedPredicateOptionsStep<S extends NestedPredicateOptionsStep<?>>
 		extends PredicateFinalStep {