Record Class CollectionChangeSet

java.lang.Object

java.lang.Record

org.hibernate.collection.spi.CollectionChangeSet

@Incubating
public record CollectionChangeSet(List<CollectionChangeSet.Removal> removals, List<CollectionChangeSet.Addition> additions, List<CollectionChangeSet.Shift> shifts, List<CollectionChangeSet.ValueChange> valueChanges)
extends Record

Represents the complete set of changes between a collection's snapshot state and its current state. Used for planning collection update operations.

Since:

8.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	CollectionChangeSet.Addition	Represents an element that was added to the collection.
static final record	CollectionChangeSet.Removal	Represents an element that was removed from the collection.
static final record	CollectionChangeSet.Shift	Represents an element that changed position within the collection.
static final record	CollectionChangeSet.ValueChange	Represents an element whose value changed at the same position.

Field Summary

Fields

Modifier and Type	Field	Description
static final CollectionChangeSet	EMPTY

Constructor Summary

Constructors

Constructor	Description
CollectionChangeSet(List<CollectionChangeSet.Removal> removals, List<CollectionChangeSet.Addition> additions, List<CollectionChangeSet.Shift> shifts, List<CollectionChangeSet.ValueChange> valueChanges)	Creates an instance of a CollectionChangeSet record class.

Method Summary

Modifier and Type	Method	Description
List<CollectionChangeSet.Addition>	additions()	Returns the value of the additions 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.
boolean	isEmpty()
List<CollectionChangeSet.Removal>	removals()	Returns the value of the removals record component.
List<CollectionChangeSet.Shift>	shifts()	Returns the value of the shifts record component.
final String	toString()	Returns a string representation of this record class.
List<CollectionChangeSet.ValueChange>	valueChanges()	Returns the value of the valueChanges record component.

Methods inherited from class Object

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

Field Details

EMPTY

public static final CollectionChangeSet EMPTY

Constructor Details

CollectionChangeSet

public CollectionChangeSet(List<CollectionChangeSet.Removal> removals,
 List<CollectionChangeSet.Addition> additions,
 List<CollectionChangeSet.Shift> shifts,
 List<CollectionChangeSet.ValueChange> valueChanges)

Creates an instance of a CollectionChangeSet record class.

Parameters:

removals - the value for the removals record component

additions - the value for the additions record component

shifts - the value for the shifts record component

valueChanges - the value for the valueChanges record component

Method Details

isEmpty

public boolean isEmpty()

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

removals

public List<CollectionChangeSet.Removal> removals()

Returns the value of the removals record component.

Returns:

the value of the removals record component

additions

public List<CollectionChangeSet.Addition> additions()

Returns the value of the additions record component.

Returns:

the value of the additions record component

shifts

public List<CollectionChangeSet.Shift> shifts()

Returns the value of the shifts record component.

Returns:

the value of the shifts record component

valueChanges

public List<CollectionChangeSet.ValueChange> valueChanges()

Returns the value of the valueChanges record component.

Returns:

the value of the valueChanges record component