akka.persistence.fsm

Class PersistentFSM.State<S,D,E>

java.lang.Object

akka.persistence.fsm.PersistentFSM.State<S,D,E>

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product

Enclosing interface:

PersistentFSM<S extends PersistentFSM.FSMState,D,E>

public static final class PersistentFSM.State<S,D,E>
extends java.lang.Object
implements scala.Product, scala.Serializable

This captures all of the managed state of the FSM: the state name, the state data, possibly custom timeout, stop reason, replies accumulated while processing the last message, possibly domain event and handler to be executed after FSM moves to the new state (also triggered when staying in the same state)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
State(S stateName, D stateData, scala.Option<scala.concurrent.duration.FiniteDuration> timeout, scala.Option<PersistentFSM.Reason> stopReason, scala.collection.immutable.List<java.lang.Object> replies, scala.collection.Seq<E> domainEvents, scala.Function1<D,scala.runtime.BoxedUnit> afterTransitionDo, boolean notifies)

Method Summary

Modifier and Type	Method and Description
scala.Function1<D,scala.runtime.BoxedUnit>	afterTransitionDo()
PersistentFSM.State<S,D,E>	andThen(scala.Function1<D,scala.runtime.BoxedUnit> handler) Register a handler to be triggered after the state has been persisted successfully
PersistentFSM.State<S,D,E>	applying(java.lang.Object... events) Specify domain events to be applied when transitioning to the new state.
PersistentFSM.State<S,D,E>	applying(scala.collection.Seq<E> events) Specify domain events to be applied when transitioning to the new state.
PersistentFSM.State<S,D,E>	copy(S stateName, D stateData, scala.Option<scala.concurrent.duration.FiniteDuration> timeout, scala.Option<PersistentFSM.Reason> stopReason, scala.collection.immutable.List<java.lang.Object> replies, boolean notifies, scala.collection.Seq<E> domainEvents, scala.Function1<D,scala.runtime.BoxedUnit> afterTransitionDo) Copy object and update values if needed.
scala.collection.Seq<E>	domainEvents()
PersistentFSM.State<S,D,E>	forMax(scala.concurrent.duration.Duration timeout) Modify state transition descriptor to include a state timeout for the next state.
boolean	notifies()
scala.collection.immutable.List<java.lang.Object>	replies()
PersistentFSM.State<S,D,E>	replying(java.lang.Object replyValue) Send reply to sender of the current message, if available.
D	stateData()
S	stateName()
scala.Option<PersistentFSM.Reason>	stopReason()
scala.Option<scala.concurrent.duration.FiniteDuration>	timeout()
PersistentFSM.State<S,D,E>	using(D nextStateData) Modify state transition descriptor with new state data.
PersistentFSM.State<S,D,E>	withNotification(boolean notifies)
PersistentFSM.State<S,D,E>	withStopReason(PersistentFSM.Reason reason) INTERNAL API.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

State

public State(S stateName,
             D stateData,
             scala.Option<scala.concurrent.duration.FiniteDuration> timeout,
             scala.Option<PersistentFSM.Reason> stopReason,
             scala.collection.immutable.List<java.lang.Object> replies,
             scala.collection.Seq<E> domainEvents,
             scala.Function1<D,scala.runtime.BoxedUnit> afterTransitionDo,
             boolean notifies)

Method Detail

applying

public PersistentFSM.State<S,D,E> applying(java.lang.Object... events)

Specify domain events to be applied when transitioning to the new state.

Parameters:

events - (undocumented)

Returns:

(undocumented)

stateName

public S stateName()

stateData

public D stateData()

timeout

public scala.Option<scala.concurrent.duration.FiniteDuration> timeout()

stopReason

public scala.Option<PersistentFSM.Reason> stopReason()

replies

public scala.collection.immutable.List<java.lang.Object> replies()

domainEvents

public scala.collection.Seq<E> domainEvents()

afterTransitionDo

public scala.Function1<D,scala.runtime.BoxedUnit> afterTransitionDo()

notifies

public boolean notifies()

copy

public PersistentFSM.State<S,D,E> copy(S stateName,
                                       D stateData,
                                       scala.Option<scala.concurrent.duration.FiniteDuration> timeout,
                                       scala.Option<PersistentFSM.Reason> stopReason,
                                       scala.collection.immutable.List<java.lang.Object> replies,
                                       boolean notifies,
                                       scala.collection.Seq<E> domainEvents,
                                       scala.Function1<D,scala.runtime.BoxedUnit> afterTransitionDo)

Copy object and update values if needed.

Parameters:

stateName - (undocumented)

stateData - (undocumented)

timeout - (undocumented)

stopReason - (undocumented)

replies - (undocumented)

notifies - (undocumented)

domainEvents - (undocumented)

afterTransitionDo - (undocumented)

Returns:

(undocumented)

forMax

public PersistentFSM.State<S,D,E> forMax(scala.concurrent.duration.Duration timeout)

Modify state transition descriptor to include a state timeout for the next state. This timeout overrides any default timeout set for the next state.

Use Duration.Inf to deactivate an existing timeout.

Parameters:

timeout - (undocumented)

Returns:

(undocumented)

replying

public PersistentFSM.State<S,D,E> replying(java.lang.Object replyValue)

Send reply to sender of the current message, if available.

Parameters:

replyValue - (undocumented)

Returns:

this state transition descriptor

using

public PersistentFSM.State<S,D,E> using(D nextStateData)

Modify state transition descriptor with new state data. The data will be set when transitioning to the new state.

Parameters:

nextStateData - (undocumented)

Returns:

(undocumented)

withStopReason

public PersistentFSM.State<S,D,E> withStopReason(PersistentFSM.Reason reason)

INTERNAL API.

Parameters:

reason - (undocumented)

Returns:

(undocumented)

withNotification

public PersistentFSM.State<S,D,E> withNotification(boolean notifies)

applying

public PersistentFSM.State<S,D,E> applying(scala.collection.Seq<E> events)

Specify domain events to be applied when transitioning to the new state.

Parameters:

events - (undocumented)

Returns:

(undocumented)

andThen

public PersistentFSM.State<S,D,E> andThen(scala.Function1<D,scala.runtime.BoxedUnit> handler)

Register a handler to be triggered after the state has been persisted successfully

Parameters:

handler - (undocumented)

Returns:

(undocumented)