escalate some annotation deprecations to forRemoval=true

gavinking · gavinking · commit 9faf1da8d0e3 · 2025-01-03T23:00:34.000+01:00
especially the enums which names collide with JPA
diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/AttributeAccessor.java b/hibernate-core/src/main/java/org/hibernate/annotations/AttributeAccessor.java
@@ -48,7 +48,7 @@
 	 *
 	 * @deprecated use {@link #strategy()}
 	 */
-	@Deprecated(since = "6.0")
+	@Deprecated(since = "6.0", forRemoval = true)
 	String value() default "";
 	/**
 	 * A class implementing {@link PropertyAccessStrategy}.
diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/Cascade.java b/hibernate-core/src/main/java/org/hibernate/annotations/Cascade.java
@@ -32,7 +32,7 @@
  * @deprecated Use the JPA-defined
  *             {@link jakarta.persistence.CascadeType}
  */
-@Deprecated(since = "7")
+@Deprecated(since = "7", forRemoval = true)
 @Target({METHOD, FIELD})
 @Retention(RUNTIME)
 public @interface Cascade {
diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/CascadeType.java b/hibernate-core/src/main/java/org/hibernate/annotations/CascadeType.java
@@ -30,9 +30,11 @@
  * @see Cascade
  *
  * @deprecated Use the JPA-defined
- *             {@link jakarta.persistence.CascadeType}
+ *             {@link jakarta.persistence.CascadeType}.
+ *             This enumeration will be removed to alleviate the
+ *             duplication in naming.
  */
-@Deprecated(since = "7")
+@Deprecated(since = "7", forRemoval = true)
 public enum CascadeType {
 	/**
 	 * Includes all types listed here.
diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/Checks.java b/hibernate-core/src/main/java/org/hibernate/annotations/Checks.java
@@ -15,10 +15,13 @@
 /**
  * A list of {@link Check}s.
  *
+ * @deprecated since {@link Check} is deprecated.
+ *
  * @author Gavin King
  */
 @Target({TYPE, METHOD, FIELD})
 @Retention(RUNTIME)
+@Deprecated(since = "7")
 public @interface Checks {
 	Check[] value();
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/FlushModeType.java b/hibernate-core/src/main/java/org/hibernate/annotations/FlushModeType.java
@@ -17,9 +17,10 @@
  * @see NamedQuery#flushMode
  * @see NamedNativeQuery#flushMode
  *
- * @deprecated use {@link QueryFlushMode}
+ * @deprecated Use {@link QueryFlushMode}. This enumeration will be removed to alleviate
+ *             the duplication in naming with {@link jakarta.persistence.FlushModeType}.
  */
-@Deprecated(since="7")
+@Deprecated(since="7", forRemoval = true)
 public enum FlushModeType {
 	/**
 	 * Corresponds to {@link org.hibernate.FlushMode#ALWAYS}.
diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/GenericGenerator.java b/hibernate-core/src/main/java/org/hibernate/annotations/GenericGenerator.java
@@ -66,7 +66,7 @@
 @Target({PACKAGE, TYPE, METHOD, FIELD})
 @Retention(RUNTIME)
 @Repeatable(GenericGenerators.class)
-@Deprecated(since = "6.5")
+@Deprecated(since = "6.5", forRemoval = true)
 public @interface GenericGenerator {
 	/**
 	 * The name of the identifier generator. This is the name that may be specified by
@@ -93,7 +93,7 @@
 	 *
 	 * @deprecated use {@link #type()} for typesafety
 	 */
-	@Deprecated(since="6.2")
+	@Deprecated(since="6.2", forRemoval = true)
 	String strategy() default "native";
 	/**
 	 * Parameters to be passed to {@link org.hibernate.id.IdentifierGenerator#configure}
diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/GenericGenerators.java b/hibernate-core/src/main/java/org/hibernate/annotations/GenericGenerators.java
@@ -20,7 +20,7 @@
  */
 @Target({PACKAGE, TYPE})
 @Retention(RUNTIME)
-@Deprecated(since = "6.5")
+@Deprecated(since = "6.5", forRemoval = true)
 public @interface GenericGenerators {
 	/**
 	 * The aggregated generators.
diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/NamedNativeQuery.java b/hibernate-core/src/main/java/org/hibernate/annotations/NamedNativeQuery.java
@@ -80,7 +80,7 @@
 	 *
 	 * @deprecated use {@link #flush()}
 	 */
-	@Deprecated(since = "7")
+	@Deprecated(since = "7", forRemoval = true)
 	FlushModeType flushMode() default FlushModeType.PERSISTENCE_CONTEXT;
 
 	/**
@@ -182,6 +182,6 @@
 	 *
 	 * @see org.hibernate.jpa.HibernateHints#HINT_CALLABLE_FUNCTION
 	 */
-	@Deprecated( since = "6.0" )
+	@Deprecated(since = "6.0", forRemoval = true)
 	boolean callable() default false;
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/NamedQuery.java b/hibernate-core/src/main/java/org/hibernate/annotations/NamedQuery.java
@@ -75,7 +75,7 @@
 	 *
 	 * @deprecated use {@link #flush()}
 	 */
-	@Deprecated(since = "7")
+	@Deprecated(since = "7", forRemoval = true)
 	FlushModeType flushMode() default FlushModeType.PERSISTENCE_CONTEXT;
 
 	/**
diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/ResultCheckStyle.java b/hibernate-core/src/main/java/org/hibernate/annotations/ResultCheckStyle.java
@@ -24,7 +24,7 @@
  *
  * @deprecated Use an {@link Expectation} class instead.
  */
-@Deprecated(since = "6.5")
+@Deprecated(since = "6.5", forRemoval = true)
 public enum ResultCheckStyle {
 	/**
 	 * No return code checking. Might mean that no checks are required, or that
diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/SQLDelete.java b/hibernate-core/src/main/java/org/hibernate/annotations/SQLDelete.java
@@ -59,7 +59,7 @@
 	 *
 	 * @deprecated use {@link #verify()} with an {@link Expectation} class
 	 */
-	@Deprecated(since = "6.5")
+	@Deprecated(since = "6.5", forRemoval = true)
 	ResultCheckStyle check() default ResultCheckStyle.NONE;
 
 	/**
diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/SQLDeleteAll.java b/hibernate-core/src/main/java/org/hibernate/annotations/SQLDeleteAll.java
@@ -47,7 +47,7 @@
 	 *
 	 * @deprecated use {@link #verify()} with an {@link Expectation} class
 	 */
-	@Deprecated(since = "6.5")
+	@Deprecated(since = "6.5", forRemoval = true)
 	ResultCheckStyle check() default ResultCheckStyle.NONE;
 
 	/**
diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/SQLInsert.java b/hibernate-core/src/main/java/org/hibernate/annotations/SQLInsert.java
@@ -75,7 +75,7 @@
 	 *
 	 * @deprecated use {@link #verify()} with an {@link Expectation} class
 	 */
-	@Deprecated(since = "6.5")
+	@Deprecated(since = "6.5", forRemoval = true)
 	ResultCheckStyle check() default ResultCheckStyle.NONE;
 
 	/**
diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/SQLUpdate.java b/hibernate-core/src/main/java/org/hibernate/annotations/SQLUpdate.java
@@ -78,7 +78,7 @@
 	 *
 	 * @deprecated use {@link #verify()} with an {@link Expectation} class
 	 */
-	@Deprecated(since = "6.5")
+	@Deprecated(since = "6.5", forRemoval = true)
 	ResultCheckStyle check() default ResultCheckStyle.NONE;
 
 	/**

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@`
`48`	`48`	`*`
`49`	`49`	`* @deprecated use {@link #strategy()}`
`50`	`50`	`*/`
`51`		`- @Deprecated(since = "6.0")`
	`51`	`+ @Deprecated(since = "6.0", forRemoval = true)`
`52`	`52`	`String value() default "";`
`53`	`53`	`/**`
`54`	`54`	`* A class implementing {@link PropertyAccessStrategy}.`
Original file line number	Diff line number	Diff line change
`@@ -15,10 +15,13 @@`
`15`	`15`	`/**`
`16`	`16`	`* A list of {@link Check}s.`
`17`	`17`	`*`
	`18`	`+ * @deprecated since {@link Check} is deprecated.`
	`19`	`+ *`
`18`	`20`	`* @author Gavin King`
`19`	`21`	`*/`
`20`	`22`	`@Target({TYPE, METHOD, FIELD})`
`21`	`23`	`@Retention(RUNTIME)`
	`24`	`+@Deprecated(since = "7")`
`22`	`25`	`public @interface Checks {`
`23`	`26`	`Check[] value();`
`24`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@`
`80`	`80`	`*`
`81`	`81`	`* @deprecated use {@link #flush()}`
`82`	`82`	`*/`
`83`		`- @Deprecated(since = "7")`
	`83`	`+ @Deprecated(since = "7", forRemoval = true)`
`84`	`84`	`FlushModeType flushMode() default FlushModeType.PERSISTENCE_CONTEXT;`
`85`	`85`
`86`	`86`	`/**`
`@@ -182,6 +182,6 @@`
`182`	`182`	`*`
`183`	`183`	`* @see org.hibernate.jpa.HibernateHints#HINT_CALLABLE_FUNCTION`
`184`	`184`	`*/`
`185`		`- @Deprecated( since = "6.0" )`
	`185`	`+ @Deprecated(since = "6.0", forRemoval = true)`
`186`	`186`	`boolean callable() default false;`
`187`	`187`	`}`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@`
`75`	`75`	`*`
`76`	`76`	`* @deprecated use {@link #flush()}`
`77`	`77`	`*/`
`78`		`- @Deprecated(since = "7")`
	`78`	`+ @Deprecated(since = "7", forRemoval = true)`
`79`	`79`	`FlushModeType flushMode() default FlushModeType.PERSISTENCE_CONTEXT;`
`80`	`80`
`81`	`81`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`*`
`25`	`25`	`* @deprecated Use an {@link Expectation} class instead.`
`26`	`26`	`*/`
`27`		`-@Deprecated(since = "6.5")`
	`27`	`+@Deprecated(since = "6.5", forRemoval = true)`
`28`	`28`	`public enum ResultCheckStyle {`
`29`	`29`	`/**`
`30`	`30`	`* No return code checking. Might mean that no checks are required, or that`