HHH-18452 Remove deprecated org.hibernate.Interceptor methods

Author: dreab8

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

@@ -6,7 +6,6 @@
  */
 package org.hibernate;
 
-import java.io.Serializable;
 import java.util.Iterator;
 
 import org.hibernate.metamodel.RepresentationMode;
@@ -77,34 +76,6 @@ public interface Interceptor {
 	 */
 	default boolean onLoad(Object entity, Object id, Object[] state, String[] propertyNames, Type[] types)
 			throws CallbackException {
-		if (id==null || id instanceof Serializable) {
-			return onLoad(entity, (Serializable) id, state, propertyNames, types);
-		}
-		return false;
-	}
-
-	/**
-	 * Called just before an object is initialized. The interceptor may change the {@code state}, which will
-	 * be propagated to the persistent object. Note that when this method is called, {@code entity} will be
-	 * an empty uninitialized instance of the class.
-	 *
-	 * @apiNote The indexes across the {@code state}, {@code propertyNames}, and {@code types} arrays match.
-	 *
-	 * @param entity The entity instance being loaded
-	 * @param id The identifier value being loaded
-	 * @param state The entity state (which will be pushed into the entity instance)
-	 * @param propertyNames The names of the entity properties, corresponding to the {@code state}.
-	 * @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.
-	 *
-	 * @deprecated use {@link #onLoad(Object, Object, Object[], String[], Type[])}
-	 */
-	@Deprecated(since = "6.0")
-	default boolean onLoad(Object entity, Serializable id, Object[] state, String[] propertyNames, Type[] types)
-			throws CallbackException {
 		return false;
 	}
 
@@ -182,67 +153,6 @@ default boolean onFlushDirty(
 			Object[] previousState,
 			String[] propertyNames,
 			Type[] types) throws CallbackException {
-		if (id==null || id instanceof Serializable) {
-			return onFlushDirty(entity, (Serializable) id, currentState, previousState, propertyNames, types);
-		}
-		return false;
-	}
-
-	/**
-	 * Called when an object is detected to be dirty, during a flush. The interceptor may modify the detected
-	 * {@code currentState}, which will be propagated to both the database and the persistent object.
-	 * Note that not all flushes end in actual synchronization with the database, in which case the
-	 * new {@code currentState} will be propagated to the object, but not necessarily (immediately) to
-	 * the database. It is strongly recommended that the interceptor <b>not</b> modify the {@code previousState}.
-	 *
-	 * @apiNote The indexes across the {@code currentState}, {@code previousState}, {@code propertyNames}, and
-	 *          {@code types} arrays match.
-	 *
-	 * @param entity The entity instance detected as being dirty and being flushed
-	 * @param id The identifier of the entity
-	 * @param currentState The entity's current state
-	 * @param previousState The entity's previous (load time) state.
-	 * @param propertyNames The names of the entity properties
-	 * @param types The types of the entity properties
-	 *
-	 * @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.
-	 *
-	 * @deprecated use {@link #onFlushDirty(Object, Object, Object[], Object[], String[], Type[])}
-	 */
-	@Deprecated(since = "6.0")
-	default boolean onFlushDirty(
-			Object entity,
-			Serializable id,
-			Object[] currentState,
-			Object[] previousState,
-			String[] propertyNames,
-			Type[] types) throws CallbackException {
-		return false;
-	}
-
-	/**
-	 * Called before an object is made persistent by a stateful session.
-	 * <p>
-	 * The interceptor may modify the {@code state}, which will be used for
-	 * the SQL {@code INSERT} and propagated to the persistent object.
-	 *
-	 * @param entity The entity instance whose state is being inserted
-	 * @param id The identifier of the entity
-	 * @param state The state of the entity which will be inserted
-	 * @param propertyNames The names of the entity properties.
-	 * @param types The types of the entity properties
-	 *
-	 * @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.
-	 *
-	 * @deprecated use {@link #onSave(Object, Object, Object[], String[], Type[])}
-	 */
-	@Deprecated(since = "6.0")
-	default boolean onSave(Object entity, Serializable id, Object[] state, String[] propertyNames, Type[] types)
-			throws CallbackException {
 		return false;
 	}
 
@@ -270,31 +180,9 @@ default boolean onSave(Object entity, Serializable id, Object[] state, String[]
 	@Deprecated(since = "6.6")
 	default boolean onSave(Object entity, Object id, Object[] state, String[] propertyNames, Type[] types)
 			throws CallbackException {
-		if (id==null || id instanceof Serializable) {
-			return onSave(entity, (Serializable) id, state, propertyNames, types);
-		}
 		return false;
 	}
 
-	/**
-	 *  Called before an object is removed by a stateful session.
-	 *  <p>
-	 *  It is not recommended that the interceptor modify the {@code state}.
-	 *
-	 * @param entity The entity instance being deleted
-	 * @param id The identifier of the entity
-	 * @param state The state of the entity
-	 * @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.
-	 *
-	 * @deprecated use {@link #onDelete(Object, Object, Object[], String[], Type[])}
-	 */
-	@Deprecated(since = "6.0")
-	default void onDelete(Object entity, Serializable id, Object[] state, String[] propertyNames, Type[] types)
-			throws CallbackException {}
-
 	/**
 	 *  Called before an object is removed by a stateful session.
 	 *  <p>
@@ -315,24 +203,8 @@ default void onDelete(Object entity, Serializable id, Object[] state, String[] p
 	@Deprecated(since = "6.6")
 	default void onDelete(Object entity, Object id, Object[] state, String[] propertyNames, Type[] types)
 			throws CallbackException {
-		if (id==null || id instanceof Serializable) {
-			onDelete(entity, (Serializable) id, state, propertyNames, 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.
-	 *
-	 * @deprecated use {@link #onCollectionRecreate(Object, Object)}
-	 */
-	@Deprecated(since = "6.0")
-	default void onCollectionRecreate(Object collection, Serializable key) throws CallbackException {}
-
 	/**
 	 * Called before a collection is (re)created.
 	 *
@@ -342,24 +214,8 @@ default void onCollectionRecreate(Object collection, Serializable key) throws Ca
 	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
 	 */
 	default void onCollectionRecreate(Object collection, Object key) throws CallbackException {
-		if (key instanceof Serializable) {
-			onCollectionRecreate(collection, (Serializable) 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.
-	 *
-	 * @deprecated use {@link #onCollectionRemove(Object, Object)}
-	 */
-	@Deprecated(since = "6.0")
-	default void onCollectionRemove(Object collection, Serializable key) throws CallbackException {}
-
 	/**
 	 * Called before a collection is deleted.
 	 *
@@ -369,24 +225,8 @@ default void onCollectionRemove(Object collection, Serializable key) throws Call
 	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
 	 */
 	default void onCollectionRemove(Object collection, Object key) throws CallbackException {
-		if (key instanceof Serializable) {
-			onCollectionRemove(collection, (Serializable) 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.
-	 * 
-	 * @deprecated use {@link #onCollectionUpdate(Object, Object)}
-	 */
-	@Deprecated(since = "6.0")
-	default void onCollectionUpdate(Object collection, Serializable key) throws CallbackException {}
-
 	/**
 	 * Called before a collection is updated.
 	 *
@@ -396,9 +236,6 @@ default void onCollectionUpdate(Object collection, Serializable key) throws Call
 	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
 	 */
 	default void onCollectionUpdate(Object collection, Object key) throws CallbackException {
-		if (key instanceof Serializable) {
-			onCollectionUpdate(collection, (Serializable) key);
-		}
 	}
 	/**
 	 * Called before a flush.
@@ -436,38 +273,6 @@ default Boolean isTransient(Object entity) {
 		return null;
 	}
 
-	/**
-	 * Called from {@code flush()}. The return value determines whether the entity is updated
-	 * <ul>
-	 * <li>an array of property indices - the entity is dirty
-	 * <li>an empty array - the entity is not dirty
-	 * <li>{@code null} - use Hibernate's default dirty-checking algorithm
-	 * </ul>
-	 *
-	 * @param entity The entity for which to find dirty properties.
-	 * @param id The identifier of the entity
-	 * @param currentState The current entity state as taken from the entity instance
-	 * @param previousState The state of the entity when it was last synchronized (generally when it was loaded)
-	 * @param propertyNames The names of the entity properties.
-	 * @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.
-	 * 
-	 * @deprecated use {@link #findDirty(Object, Object, Object[], Object[], String[], Type[])}
-	 */
-	@Deprecated(since = "6.0")
-	default int[] findDirty(
-			Object entity,
-			Serializable id,
-			Object[] currentState,
-			Object[] previousState,
-			String[] propertyNames,
-			Type[] types) {
-		return null;
-	}
-
 	/**
 	 * Called from {@code flush()}. The return value determines whether the entity is updated
 	 * <ul>
@@ -494,9 +299,6 @@ default int[] findDirty(
 			Object[] previousState,
 			String[] propertyNames,
 			Type[] types) {
-		if (id==null || id instanceof Serializable) {
-			return findDirty(entity, (Serializable) id, currentState, previousState, propertyNames, types);
-		}
 		return null;
 	}
 
@@ -539,23 +341,6 @@ default String getEntityName(Object object) throws CallbackException {
 		return null;
 	}
 
-	/**
-	 * Get a fully loaded entity instance that is cached externally.
-	 *
-	 * @param entityName the name of the entity
-	 * @param id the instance identifier
-	 *
-	 * @return a fully initialized entity
-	 *
-	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
-	 * 
-	 * @deprecated use {@link #getEntity(String, Object)}
-	 */
-	@Deprecated(since = "6.0")
-	default Object getEntity(String entityName, Serializable id) throws CallbackException {
-		return null;
-	}
-
 	/**
 	 * Get a fully loaded entity instance that is cached externally.
 	 *
@@ -567,9 +352,6 @@ default Object getEntity(String entityName, Serializable id) throws CallbackExce
 	 * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback.
 	 */
 	default Object getEntity(String entityName, Object id) throws CallbackException {
-		if (id==null || id instanceof Serializable) {
-			return getEntity(entityName, (Serializable) id);
-		}
 		return null;
 	}
 

hibernate-core/src/test/java/org/hibernate/orm/test/caching/mocked/ReadWriteCacheTest.java

@@ -13,7 +13,7 @@
 import jakarta.persistence.Entity;
 import jakarta.persistence.Id;
 
-import org.hibernate.EmptyInterceptor;
+import org.hibernate.Interceptor;
 import org.hibernate.Session;
 import org.hibernate.Transaction;
 import org.hibernate.annotations.CacheConcurrencyStrategy;
@@ -296,7 +296,7 @@ public String toString() {
 		}
 	}
 
-	private final class TransactionInterceptor extends EmptyInterceptor {
+	private final class TransactionInterceptor implements Interceptor {
 		@Override
 		public void beforeTransactionCompletion(Transaction tx) {
 			if ( interceptTransaction.get() ) {

hibernate-core/src/test/java/org/hibernate/orm/test/dirtiness/CustomDirtinessStrategyTest.java

@@ -6,8 +6,6 @@
  */
 package org.hibernate.orm.test.dirtiness;
 
-import java.io.Serializable;
-
 import org.hibernate.CustomEntityDirtinessStrategy;
 import org.hibernate.Interceptor;
 import org.hibernate.Session;
@@ -203,7 +201,7 @@ public static class OnFlushDirtyInterceptor implements Interceptor {
 		@Override
 		public boolean onFlushDirty(
 				Object entity,
-				Serializable id,
+				Object id,
 				Object[] currentState,
 				Object[] previousState,
 				String[] propertyNames,

hibernate-core/src/test/java/org/hibernate/orm/test/interceptor/CollectionInterceptor.java

@@ -7,14 +7,13 @@
 
 //$Id: CollectionInterceptor.java 7700 2005-07-30 05:02:47Z oneovthafew $
 package org.hibernate.orm.test.interceptor;
-import java.io.Serializable;
 
-import org.hibernate.EmptyInterceptor;
+import org.hibernate.Interceptor;
 import org.hibernate.type.Type;
 
-public class CollectionInterceptor extends EmptyInterceptor {
+public class CollectionInterceptor implements Interceptor {
 
-	public boolean onFlushDirty(Object entity, Serializable id, Object[] currentState, Object[] previousState, String[] propertyNames, Type[] types) {
+	public boolean onFlushDirty(Object entity, Object id, Object[] currentState, Object[] previousState, String[] propertyNames, Type[] types) {
 		( (User) entity ).getActions().add("updated");
 		return false;
 	}

hibernate-core/src/test/java/org/hibernate/orm/test/interceptor/InstantiateInterceptor.java

@@ -11,10 +11,10 @@
 package org.hibernate.orm.test.interceptor;
 
 import org.hibernate.CallbackException;
-import org.hibernate.EmptyInterceptor;
+import org.hibernate.Interceptor;
 import org.hibernate.metamodel.RepresentationMode;
 
-public class InstantiateInterceptor extends EmptyInterceptor {
+public class InstantiateInterceptor implements Interceptor {
 	private String injectedString;
 
 	public InstantiateInterceptor(String injectedString) {

hibernate-core/src/test/java/org/hibernate/orm/test/interceptor/InterceptorNonNullTransactionTest.java

@@ -18,7 +18,7 @@
 import jakarta.persistence.GeneratedValue;
 import jakarta.persistence.Id;
 
-import org.hibernate.EmptyInterceptor;
+import org.hibernate.Interceptor;
 import org.hibernate.Session;
 import org.hibernate.cfg.AvailableSettings;
 import org.hibernate.resource.transaction.spi.TransactionStatus;
@@ -205,7 +205,7 @@ public void setName(String name) {
 		}
 	}
 
-	private class TransactionInterceptor extends EmptyInterceptor {
+	private class TransactionInterceptor implements Interceptor {
 		private boolean afterTransactionBeginMethodCalled;
 		private Boolean afterTransactionBeginAssertionPassed;