Record Class QueuedCollectionOperation

java.lang.Object

java.lang.Record

org.hibernate.collection.spi.QueuedCollectionOperation

Record Components:

kind - The command kind

addedValue - The value added or assigned, if applicable

orphan - The known previous or removed value, if applicable

position - The map key or absolute list position, if known

order - The command's zero-based position in the live queue

@Incubating(since="8.0",
            group="collection-delta")
public record QueuedCollectionOperation(QueuedCollectionOperation.Kind kind, @Nullable Object addedValue, @Nullable Object orphan, @Nullable Object position, int order)
extends Record

Immutable view of one command in an uninitialized collection's operation queue.

This is producer input, not an independently executable collection mutation. Command order is significant, and a CLEAR command is an ordering barrier.

Since:

8.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	QueuedCollectionOperation.Kind

Constructor Summary

Constructors

Constructor	Description
QueuedCollectionOperation(QueuedCollectionOperation.Kind kind, Object addedValue, Object orphan, Object position, int order)	Creates an instance of a QueuedCollectionOperation record class.

Method Summary

Modifier and Type	Method	Description
Object	addedValue()	Returns the value of the addedValue record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
QueuedCollectionOperation.Kind	kind()	Returns the value of the kind record component.
int	order()	Returns the value of the order record component.
Object	orphan()	Returns the value of the orphan record component.
Object	position()	Returns the value of the position record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

QueuedCollectionOperation

public QueuedCollectionOperation(QueuedCollectionOperation.Kind kind,
 @Nullable
 Object addedValue,
 @Nullable
 Object orphan,
 @Nullable
 Object position,
 int order)

Creates an instance of a QueuedCollectionOperation record class.

Parameters:

kind - the value for the kind record component

addedValue - the value for the addedValue record component

orphan - the value for the orphan record component

position - the value for the position record component

order - the value for the order record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

kind

public QueuedCollectionOperation.Kind kind()

Returns the value of the kind record component.

Returns:

the value of the kind record component

addedValue

@Nullable
public Object addedValue()

Returns the value of the addedValue record component.

Returns:

the value of the addedValue record component

orphan

@Nullable
public Object orphan()

Returns the value of the orphan record component.

Returns:

the value of the orphan record component

position

@Nullable
public Object position()

Returns the value of the position record component.

Returns:

the value of the position record component

order

public int order()

Returns the value of the order record component.

Returns:

the value of the order record component