Package io.fluxcapacitor.javaclient.persisting.eventsourcing

Enum Class NoSnapshotTrigger

java.lang.Object

java.lang.Enum<NoSnapshotTrigger>

io.fluxcapacitor.javaclient.persisting.eventsourcing.NoSnapshotTrigger

All Implemented Interfaces:

SnapshotTrigger, Serializable, Comparable<NoSnapshotTrigger>, Constable

public enum NoSnapshotTrigger
extends Enum<NoSnapshotTrigger>
implements SnapshotTrigger

A SnapshotTrigger implementation that never triggers snapshot creation.

This trigger is used by default when snapshotting is explicitly disabled, such as when snapshotPeriod <= 0 is configured on an aggregate via Aggregate.

For many aggregate types this is a suitable default.

See Also:

• SnapshotTrigger
• 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
boolean	shouldCreateSnapshot(Entity<?> model, List<AppliedEvent> newEvents)	Always returns false, indicating that a snapshot should never be created.
static NoSnapshotTrigger	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NoSnapshotTrigger[]	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 NoSnapshotTrigger INSTANCE

Method Details

values

public static NoSnapshotTrigger[] 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 NoSnapshotTrigger 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

shouldCreateSnapshot

public boolean shouldCreateSnapshot(Entity<?> model,
 List<AppliedEvent> newEvents)

Always returns false, indicating that a snapshot should never be created.

Specified by:

shouldCreateSnapshot in interface SnapshotTrigger

Parameters:

model - The current aggregate instance (unused).

newEvents - The list of newly applied events (unused).

Returns:

false always.