org.axonframework.eventhandling

Enum ReplayStatus

java.lang.Object

java.lang.Enum<ReplayStatus>

org.axonframework.eventhandling.ReplayStatus

All Implemented Interfaces:

Serializable, Comparable<ReplayStatus>

public enum ReplayStatus
extends Enum<ReplayStatus>

Type that can be used as parameter of Event Handler methods that indicates whether a message is delivered as part of a replay, or in regular operations. Messages delivered as part of a replay may have been handled by this handler before.

Note that this is only sensible for event handlers that are assigned to a StreamingEventProcessor. Event Handlers assigned to a different mechanism, such as the SubscribingEventProcessor or certain extensions, will always receive ReplayStatus.REGULAR as value.

Since:

3.2

Author:

Allard Buijze

See Also:

@AllowReplay

Enum Constant Summary

Enum Constants

Enum Constant and Description
REGULAR Indicates the message is not delivered as part of a replay (and has not been delivered before).
REPLAY Indicates the message is delivered as part of a replay (and may have been delivered before)

Method Summary

Modifier and Type	Method and Description
boolean	isReplay() Indicates whether this status represents a replay.
static ReplayStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReplayStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

REPLAY

public static final ReplayStatus REPLAY

Indicates the message is delivered as part of a replay (and may have been delivered before)

REGULAR

public static final ReplayStatus REGULAR

Indicates the message is not delivered as part of a replay (and has not been delivered before).

Method Detail

values

public static ReplayStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ReplayStatus c : ReplayStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static ReplayStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

isReplay

public boolean isReplay()

Indicates whether this status represents a replay.

Returns:

true if this status indicates a replay, otherwise false