HHH-19829 - Introduce MultiFindOptions and its implementations for use in findMultiple()

Signed-off-by: Jan Schatteman <[email protected]>

Author: jrenaat

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

@@ -0,0 +1,31 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate;
+
+
+import jakarta.persistence.EntityGraph;
+import jakarta.persistence.FindOption;
+
+import java.util.List;
+
+/**
+ * MultiFindOption implementation to specify whether the returned list
+ * of entity instances should contain instances that have been
+ * {@linkplain Session#remove(Object) marked for removal} in the
+ * current session, but not yet deleted in the database.
+ * <p>
+ * The default is {@link #EXCLUDE}, meaning that instances marked for
+ * removal are replaced by null in the returned list of entities when {@link OrderedReturn}
+ * is used.
+ *
+ * @see org.hibernate.MultiFindOption
+ * @see OrderedReturn
+ * @see org.hibernate.Session#findMultiple(Class, List, FindOption...)
+ * @see org.hibernate.Session#findMultiple(EntityGraph, List , FindOption...)
+ */
+public record IncludeRemovals(boolean include) implements MultiFindOption {
+	public static IncludeRemovals INCLUDE = new IncludeRemovals( true );
+	public static IncludeRemovals EXCLUDE = new IncludeRemovals( false );
+}

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

@@ -0,0 +1,14 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate;
+
+
+import jakarta.persistence.FindOption;
+
+/**
+ * Simple marker interface for FindOptions which can be applied to multiple id loading.
+ */
+interface MultiFindOption extends FindOption {
+}

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

@@ -0,0 +1,32 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate;
+
+
+import jakarta.persistence.EntityGraph;
+import jakarta.persistence.FindOption;
+
+import java.util.List;
+
+/**
+ * MultiFindOption implementation to specify whether the returned list
+ * of entity instances should be ordered, where the position of an entity
+ * instance is determined by the position of its identifier
+ * in the list of ids passed to {@code findMultiple(...)}.
+ * <p>
+ * The default is {@link #ORDERED}, meaning the positions of the entities
+ * in the returned list correspond to the positions of their ids. In this case,
+ * the {@link IncludeRemovals} handling of entities marked for removal
+ * becomes important.
+ *
+ * @see org.hibernate.MultiFindOption
+ * @see IncludeRemovals
+ * @see org.hibernate.Session#findMultiple(Class, List, FindOption...)
+ * @see org.hibernate.Session#findMultiple(EntityGraph, List , FindOption...)
+ */
+public record OrderedReturn(boolean ordered) implements MultiFindOption {
+	public static OrderedReturn ORDERED = new OrderedReturn( true );
+	public static OrderedReturn UNORDERED = new OrderedReturn( false );
+}

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

@@ -0,0 +1,30 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate;
+
+
+import jakarta.persistence.EntityGraph;
+import jakarta.persistence.FindOption;
+
+import java.util.List;
+
+/**
+ * MultiFindOption implementation to specify whether the ids of managed entity instances already
+ * cached in the current persistence context should be excluded.
+ * from the list of ids sent to the database.
+ * <p>
+ * The default is {@link #DISABLED}, meaning all ids are included and sent to the database.
+ *
+ * Use {@link #ENABLED} to exclude already managed entity instance ids from
+ * the list of ids sent to the database.
+ *
+ * @see org.hibernate.MultiFindOption
+ * @see org.hibernate.Session#findMultiple(Class, List , FindOption...)
+ * @see org.hibernate.Session#findMultiple(EntityGraph, List , FindOption...)
+ */
+public record SessionChecking(boolean enabled) implements MultiFindOption {
+	public static SessionChecking ENABLED = new SessionChecking( true );
+	public static SessionChecking DISABLED = new SessionChecking( false );
+}

hibernate-core/src/main/java/org/hibernate/internal/SessionImpl.java

@@ -960,6 +960,15 @@ else if ( option instanceof ReadOnlyMode ) {
 			else if ( option instanceof BatchSize batchSizeOption ) {
 				batchSize = batchSizeOption.batchSize();
 			}
+			else if ( option instanceof SessionChecking sessionChecking ) {
+				loadAccess.enableSessionCheck( sessionChecking.enabled() );
+			}
+			else if ( option instanceof OrderedReturn orderedReturn ) {
+				loadAccess.enableOrderedReturn( orderedReturn.ordered() );
+			}
+			else if ( option instanceof IncludeRemovals includeRemovals ) {
+				loadAccess.enableReturnOfDeletedEntities( includeRemovals.include() );
+			}
 		}
 		loadAccess.with( lockOptions )
 				.with( interpretCacheMode( storeMode, retrieveMode ) )