Package io.fluxcapacitor.javaclient.persisting.eventsourcing

Enum Class NoOpSnapshotStore

java.lang.Object

java.lang.Enum<NoOpSnapshotStore>

io.fluxcapacitor.javaclient.persisting.eventsourcing.NoOpSnapshotStore

All Implemented Interfaces:

SnapshotStore, Serializable, Comparable<NoOpSnapshotStore>, Constable

public enum NoOpSnapshotStore
extends Enum<NoOpSnapshotStore>
implements SnapshotStore

A SnapshotStore implementation that is used when snapshotting is explicitly disabled, such as when snapshotPeriod <= 0 is configured on an aggregate via Aggregate.

See Also:

• SnapshotStore
• Aggregate.snapshotPeriod()

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	deleteSnapshot(Object aggregateId)	Deletes the snapshot for the specified aggregate ID.
<T> Optional<Entity<T>>	getSnapshot(Object aggregateId)	Retrieves the most recent snapshot for a given aggregate ID, if available.
<T> CompletableFuture<Void>	storeSnapshot(Entity<T> snapshot)	Stores a new snapshot for the given aggregate entity.
static NoOpSnapshotStore	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NoOpSnapshotStore[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final NoOpSnapshotStore INSTANCE

Method Details

values

public static NoOpSnapshotStore[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static NoOpSnapshotStore valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

storeSnapshot

public <T> CompletableFuture<Void> storeSnapshot(Entity<T> snapshot)

Description copied from interface: SnapshotStore

Stores a new snapshot for the given aggregate entity.

The snapshot typically contains the latest known state and metadata such as the aggregate ID and sequence number. Storing a snapshot will overwrite any existing snapshot for the same aggregate ID.

Specified by:

storeSnapshot in interface SnapshotStore

Type Parameters:

T - The aggregate root type.

Parameters:

snapshot - The aggregate entity to be stored as a snapshot.

Returns:

A CompletableFuture indicating whether the operation completed successfully.

getSnapshot

public <T> Optional<Entity<T>> getSnapshot(Object aggregateId)

Description copied from interface: SnapshotStore

Retrieves the most recent snapshot for a given aggregate ID, if available.

Specified by:

getSnapshot in interface SnapshotStore

Type Parameters:

T - The expected type of the aggregate.

Parameters:

aggregateId - The ID of the aggregate for which to retrieve a snapshot.

Returns:

An Optional containing the aggregate snapshot if present, otherwise empty.

deleteSnapshot

public CompletableFuture<Void> deleteSnapshot(Object aggregateId)

Description copied from interface: SnapshotStore

Deletes the snapshot for the specified aggregate ID.

Specified by:

deleteSnapshot in interface SnapshotStore

Parameters:

aggregateId - The ID of the aggregate whose snapshot should be deleted.

Returns:

A CompletableFuture indicating completion of the deletion operation.