Enum Class CollectionTransition

java.lang.Object

java.lang.Enum<CollectionTransition>

org.hibernate.action.queue.spi.CollectionTransition

All Implemented Interfaces:

Serializable, Comparable<CollectionTransition>, Constable

@Incubating(since="8.0",
            group="action-queue")
public enum CollectionTransition
extends Enum<CollectionTransition>

Describes the logical relationship between the loaded and current collection endpoints.

Since:

8.0

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CREATE	Create the collection rows associated with the current endpoint.
NONE	No loaded-to-current collection transition was detected.
REMOVE	Remove the collection rows associated with the loaded endpoint.
REMOVE_AND_CREATE	Remove rows from the loaded endpoint and create rows at the current endpoint.
UPDATE	Update the collection at its existing loaded/current endpoint.

Method Summary

Modifier and Type	Method	Description
static CollectionTransition	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CollectionTransition[]	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

NONE

public static final CollectionTransition NONE

No loaded-to-current collection transition was detected.

This value is used when the input contains only queued operations for an uninitialized collection.

CREATE

public static final CollectionTransition CREATE

Create the collection rows associated with the current endpoint.

There is no corresponding remove from a loaded endpoint.

REMOVE

public static final CollectionTransition REMOVE

Remove the collection rows associated with the loaded endpoint.

There is no corresponding create at a current endpoint.

UPDATE

public static final CollectionTransition UPDATE

Update the collection at its existing loaded/current endpoint.

The role and key are unchanged; the collection's contents or ordering may nevertheless require row deletion, insertion, or update.

REMOVE_AND_CREATE

public static final CollectionTransition REMOVE_AND_CREATE

Remove rows from the loaded endpoint and create rows at the current endpoint.

This represents a collection role or owner-key change. The remove side must precede the create side, and each side retains its own semantic lifecycle.

Method Details

values

public static CollectionTransition[] 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 CollectionTransition 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