HSEARCH-5369 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