HHH-19349 actually deprecate the ImmutableEntityUpdateQueryHandlingMode enum

It's just a boolean switch, and it has a ridiculously-long name. Imagine if
we invented an enum like this for every single config switch in Hibernate!

Author: gavinking

hibernate-core/src/main/java/org/hibernate/boot/internal/SessionFactoryOptionsBuilder.java

@@ -1136,6 +1136,11 @@ public ImmutableEntityUpdateQueryHandlingMode getImmutableEntityUpdateQueryHandl
 		return immutableEntityUpdateQueryHandlingMode;
 	}
 
+	@Override
+	public boolean disallowImmutableEntityUpdate() {
+		return immutableEntityUpdateQueryHandlingMode == ImmutableEntityUpdateQueryHandlingMode.EXCEPTION;
+	}
+
 	@Override
 	public String getDefaultCatalog() {
 		return defaultCatalog;

hibernate-core/src/main/java/org/hibernate/boot/spi/AbstractDelegatingSessionFactoryOptions.java

@@ -413,6 +413,11 @@ public ImmutableEntityUpdateQueryHandlingMode getImmutableEntityUpdateQueryHandl
 		return delegate.getImmutableEntityUpdateQueryHandlingMode();
 	}
 
+	@Override
+	public boolean disallowImmutableEntityUpdate() {
+		return delegate.disallowImmutableEntityUpdate();
+	}
+
 	@Override
 	public String getDefaultCatalog() {
 		return delegate.getDefaultCatalog();

hibernate-core/src/main/java/org/hibernate/query/spi/ImmutableEntityUpdateQueryHandlingMode.java

@@ -17,10 +17,13 @@
  *     thrown instead.
  * </ul>
  *
+ * @deprecated This enumeration is isomorphic to {@code boolean}. It will be removed.
+ *
  * @see org.hibernate.cfg.AvailableSettings#IMMUTABLE_ENTITY_UPDATE_QUERY_HANDLING_MODE
  *
  * @author Vlad Mihalcea
  */
+@Deprecated(since = "7.0", forRemoval = true)
 public enum ImmutableEntityUpdateQueryHandlingMode {
 
 	WARNING,

hibernate-core/src/main/java/org/hibernate/query/spi/QueryEngineOptions.java

@@ -85,12 +85,19 @@ public interface QueryEngineOptions {
 	 */
 	ValueHandlingMode getCriteriaValueHandlingMode();
 
+	/**
+	 * @see org.hibernate.cfg.QuerySettings#IMMUTABLE_ENTITY_UPDATE_QUERY_HANDLING_MODE
+	 *
+	 * @deprecated Since {@link ImmutableEntityUpdateQueryHandlingMode} is deprecated.
+	 *             Use {@link #disallowImmutableEntityUpdate} instead.
+	 */
+	@Deprecated(since = "7.0", forRemoval = true)
+	ImmutableEntityUpdateQueryHandlingMode getImmutableEntityUpdateQueryHandlingMode();
+
 	/**
 	 * @see org.hibernate.cfg.QuerySettings#IMMUTABLE_ENTITY_UPDATE_QUERY_HANDLING_MODE
 	 */
-	default ImmutableEntityUpdateQueryHandlingMode getImmutableEntityUpdateQueryHandlingMode() {
-		return ImmutableEntityUpdateQueryHandlingMode.WARNING;
-	}
+	boolean disallowImmutableEntityUpdate();
 
 	/**
 	 * @see org.hibernate.cfg.AvailableSettings#JSON_FUNCTIONS_ENABLED

hibernate-core/src/main/java/org/hibernate/query/sqm/NodeBuilder.java

@@ -1499,5 +1499,8 @@ default SqmSortSpecification sort(
 
 	JpaCompliance getJpaCompliance();
 
+	@Deprecated(since = "7.0", forRemoval = true)
 	ImmutableEntityUpdateQueryHandlingMode getImmutableEntityUpdateQueryHandlingMode();
+
+	boolean disallowImmutableEntityUpdate();
 }

hibernate-core/src/main/java/org/hibernate/query/sqm/internal/SqmCriteriaNodeBuilder.java

@@ -190,7 +190,7 @@ public class SqmCriteriaNodeBuilder implements NodeBuilder, Serializable {
 	private final transient JpaCompliance jpaCompliance;
 	private final transient QueryEngine queryEngine;
 	private final transient ValueHandlingMode criteriaValueHandlingMode;
-	private final transient ImmutableEntityUpdateQueryHandlingMode immutableEntityUpdateQueryHandlingMode;
+	private final transient boolean disallowImmutableEntityUpdate;
 	private final transient BindingContext bindingContext;
 	private transient BasicType<Boolean> booleanType;
 	private transient BasicType<Integer> integerType;
@@ -211,7 +211,7 @@ public SqmCriteriaNodeBuilder(
 		this.name = name;
 		this.jpaCompliance = options.getJpaCompliance();
 		this.criteriaValueHandlingMode = options.getCriteriaValueHandlingMode();
-		this.immutableEntityUpdateQueryHandlingMode = options.getImmutableEntityUpdateQueryHandlingMode();
+		this.disallowImmutableEntityUpdate = options.disallowImmutableEntityUpdate();
 		this.bindingContext = bindingContext;
 		this.extensions = loadExtensions();
 	}
@@ -247,7 +247,14 @@ public JpaCompliance getJpaCompliance() {
 
 	@Override
 	public ImmutableEntityUpdateQueryHandlingMode getImmutableEntityUpdateQueryHandlingMode() {
-		return immutableEntityUpdateQueryHandlingMode;
+		return disallowImmutableEntityUpdate
+				? ImmutableEntityUpdateQueryHandlingMode.EXCEPTION
+				: ImmutableEntityUpdateQueryHandlingMode.WARNING;
+	}
+
+	@Override
+	public boolean disallowImmutableEntityUpdate() {
+		return disallowImmutableEntityUpdate;
 	}
 
 	@Override

hibernate-core/src/main/java/org/hibernate/query/sqm/tree/update/SqmUpdateStatement.java

@@ -134,14 +134,11 @@ private void verifyImmutableEntityUpdate(String hql) {
 				nodeBuilder().getMappingMetamodel().getEntityDescriptor( getTarget().getEntityName() );
 		if ( !persister.isMutable() ) {
 			final String querySpaces = Arrays.toString( persister.getQuerySpaces() );
-			switch ( nodeBuilder().getImmutableEntityUpdateQueryHandlingMode() ) {
-				case WARNING:
-					LOG.immutableEntityUpdateQuery( hql, querySpaces );
-					break;
-				case EXCEPTION:
-					throw new HibernateException( "The query attempts to update an immutable entity: " + querySpaces );
-				default:
-					throw new AssertionFailure( "Unrecognized mode" );
+			if ( nodeBuilder().disallowImmutableEntityUpdate() ) {
+				throw new HibernateException( "The query attempts to update an immutable entity: " + querySpaces );
+			}
+			else {
+				LOG.immutableEntityUpdateQuery( hql, querySpaces );
 			}
 		}
 	}