Enum Class FindMultipleOption.RemovalsMode

java.lang.Object

java.lang.Enum<FindMultipleOption.RemovalsMode>

org.hibernate.FindMultipleOption.RemovalsMode

All Implemented Interfaces:

FindOption, Serializable, Comparable<FindMultipleOption.RemovalsMode>, Constable, FindMultipleOption

Enclosing interface:

FindMultipleOption

public static enum FindMultipleOption.RemovalsMode
extends Enum<FindMultipleOption.RemovalsMode>
implements FindMultipleOption

When FindMultipleOption.SessionCheckMode is enabled, this option controls how to handle entities which are already contained by the persistence context but which are in a removed state (marked for removal, but not yet flushed).

The default is REPLACE.

Since:

7.2

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Nested classes/interfaces inherited from interface FindMultipleOption

FindMultipleOption.BatchSize, FindMultipleOption.OrderingMode, FindMultipleOption.RemovalsMode, FindMultipleOption.SessionCheckMode

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXCLUDE	Removed entities are excluded from the load result.
INCLUDE	Removed entities are included in the load result.
REPLACE	The default.

Method Summary

Modifier and Type	Method	Description
static FindMultipleOption.RemovalsMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FindMultipleOption.RemovalsMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INCLUDE

public static final FindMultipleOption.RemovalsMode INCLUDE

Removed entities are included in the load result.

REPLACE

public static final FindMultipleOption.RemovalsMode REPLACE

The default. Removed entities are replaced with null in the load result.

EXCLUDE

public static final FindMultipleOption.RemovalsMode EXCLUDE

Removed entities are excluded from the load result.

This option is incompatible with FindMultipleOption.OrderingMode.ORDERED. It must be used in conjunction with FindMultipleOption.OrderingMode.UNORDERED and FindMultipleOption.SessionCheckMode.ENABLED.

Since:

7.3

Method Details

values

public static FindMultipleOption.RemovalsMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static FindMultipleOption.RemovalsMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null