deprecate obsolete exception type

Author: gavinking

hibernate-core/src/main/java/org/hibernate/CallbackException.java

@@ -8,10 +8,13 @@
  * Intended to be thrown from {@link Interceptor} callbacks.
  *
  * @implNote This is a legacy exception type from back in the day before
- * Hibernate moved to an unchecked exception strategy.
+ *           Hibernate moved to an unchecked exception strategy.
+ * @deprecated Methods of {@link Interceptor} are no longer required to
+ *             throw this exception type.
  *
  * @author Gavin King
  */
+@Deprecated(since = "7")
 public class CallbackException extends HibernateException {
 	/**
 	 * Creates a CallbackException using the given underlying cause.

hibernate-core/src/main/java/org/hibernate/Interceptor.java

@@ -72,11 +72,8 @@ public interface Interceptor {
 	 * @param types The types of the entity properties, corresponding to the {@code state}.
 	 *
 	 * @return {@code true} if the user modified the {@code state} in any way.
-	 *
-	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
 	 */
-	default boolean onLoad(Object entity, Object id, Object[] state, String[] propertyNames, Type[] types)
-			throws CallbackException {
+	default boolean onLoad(Object entity, Object id, Object[] state, String[] propertyNames, Type[] types) {
 		return false;
 	}
 
@@ -94,13 +91,10 @@ default boolean onLoad(Object entity, Object id, Object[] state, String[] proper
 	 *
 	 * @return {@code true} if the user modified the {@code state} in any way.
 	 *
-	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
-	 *
 	 * @see Session#persist(Object)
 	 * @see Session#merge(Object)
 	 */
-	default boolean onPersist(Object entity, Object id, Object[] state, String[] propertyNames, Type[] types)
-			throws CallbackException {
+	default boolean onPersist(Object entity, Object id, Object[] state, String[] propertyNames, Type[] types) {
 		return onSave(entity, id, state, propertyNames, types);
 	}
 
@@ -115,12 +109,9 @@ default boolean onPersist(Object entity, Object id, Object[] state, String[] pro
 	 * @param propertyNames The names of the entity properties.
 	 * @param types The types of the entity properties
 	 *
-	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
-	 *
 	 * @see Session#remove(Object)
 	 */
-	default void onRemove(Object entity, Object id, Object[] state, String[] propertyNames, Type[] types)
-			throws CallbackException {
+	default void onRemove(Object entity, Object id, Object[] state, String[] propertyNames, Type[] types) {
 		onDelete(entity, id, state, propertyNames, types);
 	}
 
@@ -143,8 +134,6 @@ default void onRemove(Object entity, Object id, Object[] state, String[] propert
 	 *
 	 * @return {@code true} if the user modified the {@code currentState} in any way.
 	 *
-	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
-	 *
 	 * @see Session#flush()
 	 */
 	default boolean onFlushDirty(
@@ -153,7 +142,7 @@ default boolean onFlushDirty(
 			Object[] currentState,
 			Object[] previousState,
 			String[] propertyNames,
-			Type[] types) throws CallbackException {
+			Type[] types) {
 		return false;
 	}
 
@@ -171,16 +160,13 @@ default boolean onFlushDirty(
 	 *
 	 * @return {@code true} if the user modified the {@code state} in any way.
 	 *
-	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
-	 *
 	 * @see Session#persist(Object)
 	 * @see Session#merge(Object)
 	 *
 	 * @deprecated Use {@link #onPersist(Object, Object, Object[], String[], Type[])}
 	 */
 	@Deprecated(since = "6.6")
-	default boolean onSave(Object entity, Object id, Object[] state, String[] propertyNames, Type[] types)
-			throws CallbackException {
+	default boolean onSave(Object entity, Object id, Object[] state, String[] propertyNames, Type[] types) {
 		return false;
 	}
 
@@ -195,67 +181,54 @@ default boolean onSave(Object entity, Object id, Object[] state, String[] proper
 	 * @param propertyNames The names of the entity properties.
 	 * @param types The types of the entity properties
 	 *
-	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
-	 *
 	 * @see Session#remove(Object)
 	 *
 	 * @deprecated Use {@link #onRemove(Object, Object, Object[], String[], Type[])}
 	 */
 	@Deprecated(since = "6.6")
-	default void onDelete(Object entity, Object id, Object[] state, String[] propertyNames, Type[] types)
-			throws CallbackException {
+	default void onDelete(Object entity, Object id, Object[] state, String[] propertyNames, Type[] types) {
 	}
 
 	/**
 	 * Called before a collection is (re)created.
 	 *
 	 * @param collection The collection instance.
 	 * @param key The collection key value.
-	 *
-	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
 	 */
-	default void onCollectionRecreate(Object collection, Object key) throws CallbackException {
+	default void onCollectionRecreate(Object collection, Object key) {
 	}
 
 	/**
 	 * Called before a collection is deleted.
 	 *
 	 * @param collection The collection instance.
 	 * @param key The collection key value.
-	 *
-	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
 	 */
-	default void onCollectionRemove(Object collection, Object key) throws CallbackException {
+	default void onCollectionRemove(Object collection, Object key) {
 	}
 
 	/**
 	 * Called before a collection is updated.
 	 *
 	 * @param collection The collection instance.
 	 * @param key The collection key value.
-	 *
-	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
 	 */
-	default void onCollectionUpdate(Object collection, Object key) throws CallbackException {
+	default void onCollectionUpdate(Object collection, Object key) {
 	}
 	/**
 	 * Called before a flush.
 	 *
 	 * @param entities The entities to be flushed.
-	 *
-	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
 	 */
-	default void preFlush(Iterator<Object> entities) throws CallbackException {}
+	default void preFlush(Iterator<Object> entities) {}
 
 	/**
 	 * Called after a flush that actually ends in execution of the SQL statements required to synchronize
 	 * in-memory state with the database.
 	 *
 	 * @param entities The entities that were flushed.
-	 *
-	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
 	 */
-	default void postFlush(Iterator<Object> entities) throws CallbackException {}
+	default void postFlush(Iterator<Object> entities) {}
 
 	/**
 	 * Called to distinguish between transient and detached entities. The return value determines the
@@ -290,8 +263,6 @@ default Boolean isTransient(Object entity) {
 	 * @param types The types of the entity properties
 	 *
 	 * @return array of dirty property indices or {@code null} to indicate Hibernate should perform default behaviour
-	 *
-	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
 	 */
 	default int[] findDirty(
 			Object entity,
@@ -311,7 +282,7 @@ default int[] findDirty(
 	default Object instantiate(
 			String entityName,
 			EntityRepresentationStrategy representationStrategy,
-			Object id) throws CallbackException {
+			Object id) {
 		return instantiate( entityName, representationStrategy.getMode(), id );
 	}
 
@@ -323,7 +294,7 @@ default Object instantiate(
 	default Object instantiate(
 			String entityName,
 			RepresentationMode representationMode,
-			Object id) throws CallbackException {
+			Object id) {
 		return null;
 	}
 
@@ -334,11 +305,9 @@ default Object instantiate(
 	 *
 	 * @return the name of the entity
 	 *
-	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
-	 *
 	 * @see EntityNameResolver
 	 */
-	default String getEntityName(Object object) throws CallbackException {
+	default String getEntityName(Object object) {
 		return null;
 	}
 
@@ -349,10 +318,8 @@ default String getEntityName(Object object) throws CallbackException {
 	 * @param id the instance identifier
 	 *
 	 * @return a fully initialized entity
-	 *
-	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
 	 */
-	default Object getEntity(String entityName, Object id) throws CallbackException {
+	default Object getEntity(String entityName, Object id) {
 		return null;
 	}
 
@@ -388,8 +355,6 @@ default void afterTransactionCompletion(Transaction tx) {}
 	 * @param propertyNames The names of the entity properties.
 	 * @param propertyTypes The types of the entity properties
 	 *
-	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
-	 *
 	 * @see StatelessSession#insert(Object)
 	 */
 	default void onInsert(Object entity, Object id, Object[] state, String[] propertyNames, Type[] propertyTypes) {}
@@ -403,8 +368,6 @@ default void onInsert(Object entity, Object id, Object[] state, String[] propert
 	 * @param propertyNames The names of the entity properties.
 	 * @param propertyTypes The types of the entity properties
 	 *
-	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
-	 *
 	 * @see StatelessSession#update(Object)
 	 */
 	default void onUpdate(Object entity, Object id, Object[] state, String[] propertyNames, Type[] propertyTypes) {}
@@ -418,8 +381,6 @@ default void onUpdate(Object entity, Object id, Object[] state, String[] propert
 	 * @param propertyNames The names of the entity properties.
 	 * @param propertyTypes The types of the entity properties
 	 *
-	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
-	 *
 	 * @see StatelessSession#upsert(String, Object)
 	 */
 	default void onUpsert(Object entity, Object id, Object[] state, String[] propertyNames, Type[] propertyTypes) {}
@@ -432,8 +393,6 @@ default void onUpsert(Object entity, Object id, Object[] state, String[] propert
 	 * @param propertyNames The names of the entity properties.
 	 * @param propertyTypes The types of the entity properties
 	 *
-	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
-	 *
 	 * @see StatelessSession#delete(Object)
 	 */
 	default void onDelete(Object entity, Object id, String[] propertyNames, Type[] propertyTypes) {}