Record Class CollectionDelta

java.lang.Object

java.lang.Record

org.hibernate.collection.spi.CollectionDelta

Record Components:

baseline - The reference state against which the changes are expressed

coverage - Whether the changes completely describe the difference from the baseline

changes - The ordered semantic changes

sources - How the changes were discovered

@Incubating(since="8.0",
            group="collection-delta")
public record CollectionDelta(@Nonnull CollectionBaseline baseline, @Nonnull DeltaCoverage coverage, @Nonnull List<CollectionChange> changes, @Nonnull Set<DeltaSource> sources)
extends Record

An immutable semantic description of collection changes relative to an identified reference state.

Since:

8.0

Constructor Summary

Constructors

Constructor	Description
CollectionDelta(CollectionBaseline baseline, DeltaCoverage coverage, List<CollectionChange> changes, Set<DeltaSource> sources)	Creates an instance of a CollectionDelta record class.

Method Summary

Modifier and Type	Method	Description
CollectionBaseline	baseline()	Returns the value of the baseline record component.
List<CollectionChange>	changes()	Returns the value of the changes record component.
DeltaCoverage	coverage()	Returns the value of the coverage 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()	Whether the delta contains no semantic changes.
List<Object>	orphanCandidates()	Project the known orphan candidates represented by removals and replacements.
Set<DeltaSource>	sources()	Returns the value of the sources 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

CollectionDelta

public CollectionDelta(@Nonnull
 CollectionBaseline baseline,
 @Nonnull
 DeltaCoverage coverage,
 @Nonnull
 List<CollectionChange> changes,
 @Nonnull
 Set<DeltaSource> sources)

Creates an instance of a CollectionDelta record class.

Parameters:

baseline - the value for the baseline record component

coverage - the value for the coverage record component

changes - the value for the changes record component

sources - the value for the sources record component

Method Details

isEmpty

public boolean isEmpty()

Whether the delta contains no semantic changes.

orphanCandidates

public List<Object> orphanCandidates()

Project the known orphan candidates represented by removals and replacements.

For an explicit-changes-only delta this contains only explicitly known candidates and says nothing about unmentioned persisted rows.

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.

baseline

@Nonnull
public CollectionBaseline baseline()

Returns the value of the baseline record component.

Returns:

the value of the baseline record component

coverage

@Nonnull
public DeltaCoverage coverage()

Returns the value of the coverage record component.

Returns:

the value of the coverage record component

changes

@Nonnull
public List<CollectionChange> changes()

Returns the value of the changes record component.

Returns:

the value of the changes record component

sources

@Nonnull
public Set<DeltaSource> sources()

Returns the value of the sources record component.

Returns:

the value of the sources record component