Package org.axonframework.eventsourcing.eventstore

Record Class SourcingStrategy.Snapshot

java.lang.Object

java.lang.Record

org.axonframework.eventsourcing.eventstore.SourcingStrategy.Snapshot

Record Components:

qualifiedName - the QualifiedName defining the snapshot type, cannot be null

identifier - the identifier of the snapshotted entity, cannot be null

maximumPosition - the maximum position of the snapshot to return, can be null

All Implemented Interfaces:

SourcingStrategy

Enclosing interface:

SourcingStrategy

public static record SourcingStrategy.Snapshot(QualifiedName qualifiedName, Object identifier, @Nullable Position maximumPosition)
extends Record
implements SourcingStrategy

Snapshot-based sourcing strategy.

This strategy provides an initial state (snapshot) if available, succeeded by an ordered event stream from the position of the snapshot.

Nested Class Summary

Nested classes/interfaces inherited from interface org.axonframework.eventsourcing.eventstore.SourcingStrategy

SourcingStrategy.Absolute, SourcingStrategy.Snapshot

Constructor Summary

Constructors

Constructor	Description
Snapshot(QualifiedName qualifiedName, Object identifier, @Nullable Position maximumPosition)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
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.
Object	identifier()	Returns the value of the identifier record component.
@Nullable Position	maximumPosition()	Returns the value of the maximumPosition record component.
SourcingStrategy	merge(SourcingStrategy other)	Merges this sourcing strategy with another sourcing strategy to produce a single effective strategy for event sourcing.
QualifiedName	qualifiedName()	Returns the value of the qualifiedName record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

Snapshot

public Snapshot(QualifiedName qualifiedName,
 Object identifier,
 @Nullable Position maximumPosition)

Constructs a new instance.

Throws:

NullPointerException - if qualifiedName or identifier is null

Method Details

merge

public SourcingStrategy merge(SourcingStrategy other)

Description copied from interface: SourcingStrategy

Merges this sourcing strategy with another sourcing strategy to produce a single effective strategy for event sourcing.

The merge operation is deterministic and defined as follows:

• Merging two SourcingStrategy.Absolute strategies results in an Absolute whose position is the minimum of both positions
• Merging an SourcingStrategy.Absolute with a SourcingStrategy.Snapshot results in the Snapshot
• Merging two SourcingStrategy.Snapshot instances is not supported and results in an UnsupportedOperationException

Specified by:

merge in interface SourcingStrategy

Parameters:

other - the other sourcing strategy to merge with this one, cannot be null

Returns:

the merged sourcing strategy

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.

qualifiedName

public QualifiedName qualifiedName()

Returns the value of the qualifiedName record component.

Returns:

the value of the qualifiedName record component

identifier

public Object identifier()

Returns the value of the identifier record component.

Returns:

the value of the identifier record component

maximumPosition

public @Nullable Position maximumPosition()

Returns the value of the maximumPosition record component.

Returns:

the value of the maximumPosition record component