Package org.axonframework.eventsourcing.snapshot.api

Record Class EvolutionResult

java.lang.Object

java.lang.Record

org.axonframework.eventsourcing.snapshot.api.EvolutionResult

Record Components:

eventsApplied - the number of events applied while sourcing the entity, never negative

sourcingTime - the total time spent sourcing the entity, never null

public record EvolutionResult(long eventsApplied, Duration sourcingTime)
extends Record

Represents metrics collected while sourcing an event-sourced entity to its current state.

EvolutionResult captures information about the sourcing process, including how many events were applied, how long the process took, and whether a snapshot was requested during sourcing.

This information is provided to the Snapshotter once sourcing has completed, allowing it to make an informed decision about creating and persisting a snapshot.

Since:

5.1.0

Author:

John Hendrikx

Constructor Summary

Constructors

Constructor	Description
EvolutionResult(long eventsApplied, Duration sourcingTime)	Creates a new EvolutionResult.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
long	eventsApplied()	Returns the value of the eventsApplied record component.
final int	hashCode()	Returns a hash code value for this object.
Duration	sourcingTime()	Returns the value of the sourcingTime 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

EvolutionResult

public EvolutionResult(long eventsApplied,
 Duration sourcingTime)

Creates a new EvolutionResult.

Throws:

NullPointerException - if sourcingTime is null

IllegalArgumentException - if eventsApplied is negative

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 '=='.

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.

eventsApplied

public long eventsApplied()

Returns the value of the eventsApplied record component.

Returns:

the value of the eventsApplied record component

sourcingTime

public Duration sourcingTime()

Returns the value of the sourcingTime record component.

Returns:

the value of the sourcingTime record component