Package akka.persistence.fsm

Class AbstractPersistentFSMBase<S,D,E>

java.lang.Object

akka.persistence.fsm.AbstractPersistentFSMBase<S,D,E>

All Implemented Interfaces:

Actor, ActorLogging, PersistentFSMBase<S,D,E>, Listeners

Direct Known Subclasses:

AbstractPersistentFSM

public abstract class AbstractPersistentFSMBase<S,D,E>
extends java.lang.Object
implements PersistentFSMBase<S,D,E>

Returns this AbstractActor's ActorContext The ActorContext is not thread safe so do not expose it outside of the AbstractActor.

Nested Class Summary

Nested classes/interfaces inherited from interface akka.actor.Actor

Actor.emptyBehavior$, Actor.ignoringBehavior$

Nested classes/interfaces inherited from interface akka.persistence.fsm.PersistentFSMBase

PersistentFSMBase.TransformHelper

Constructor Summary

Constructors

Constructor	Description
AbstractPersistentFSMBase()

Method Summary

Modifier and Type	Method	Description
PersistentFSM.$minus$greater$	$minus$greater()	This extractor is just convenience for matching a (S, S) pair, including a reminder what the new state is.
protected void	akka$actor$Actor$_setter_$context_$eq(ActorContext x$1)
protected void	akka$actor$Actor$_setter_$self_$eq(ActorRef x$1)	The 'self' field holds the ActorRef for this actor.
protected void	akka$persistence$fsm$PersistentFSMBase$_setter_$Event_$eq(PersistentFSM.Event$ x$1)
protected void	akka$persistence$fsm$PersistentFSMBase$_setter_$StateTimeout_$eq(PersistentFSM.StateTimeout$ x$1)	This case object is received in case of a state timeout.
protected void	akka$persistence$fsm$PersistentFSMBase$_setter_$StopEvent_$eq(PersistentFSM.StopEvent$ x$1)
protected void	akka$routing$Listeners$_setter_$listeners_$eq(java.util.Set<ActorRef> x$1)
ActorContext	context()	Scala API: Stores the context for this actor, including self, and sender.
PersistentFSM.Event$	Event()
AbstractActor.ActorContext	getContext()
ActorRef	getSelf()	Returns the ActorRef for this actor.
ActorRef	getSender()	The reference sender Actor of the currently processed message.
PersistentFSM.State<S,D,E>	goTo(S nextStateName)	Produce transition to other state.
protected java.util.Set<ActorRef>	listeners()
FSMStateFunctionBuilder<S,D,E>	matchAnyEvent(FI.Apply2<java.lang.Object,D,PersistentFSM.State<S,D,E>> apply)	Create an FSMStateFunctionBuilder with the first case statement set.
<DT extends D> UnitPFBuilder<D>	matchData(java.lang.Class<DT> dataType, FI.TypedPredicate<DT> predicate, FI.UnitApply<DT> apply)	Create a UnitPFBuilder with the first case statement set.
<DT extends D> UnitPFBuilder<D>	matchData(java.lang.Class<DT> dataType, FI.UnitApply<DT> apply)	Create a UnitPFBuilder with the first case statement set.
FSMStateFunctionBuilder<S,D,E>	matchEvent(FI.TypedPredicate2<java.lang.Object,D> predicate, FI.Apply2<java.lang.Object,D,PersistentFSM.State<S,D,E>> apply)	Create an FSMStateFunctionBuilder with the first case statement set.
<ET> FSMStateFunctionBuilder<S,D,E>	matchEvent(java.lang.Class<ET> eventType, FI.Apply2<ET,D,PersistentFSM.State<S,D,E>> apply)	Create an FSMStateFunctionBuilder with the first case statement set.
<ET> FSMStateFunctionBuilder<S,D,E>	matchEvent(java.lang.Class<ET> eventType, FI.TypedPredicate2<ET,D> predicate, FI.Apply2<ET,D,PersistentFSM.State<S,D,E>> apply)	Create an FSMStateFunctionBuilder with the first case statement set.
<ET,DT extends D> FSMStateFunctionBuilder<S,D,E>	matchEvent(java.lang.Class<ET> eventType, java.lang.Class<DT> dataType, FI.Apply2<ET,DT,PersistentFSM.State<S,D,E>> apply)	Create an FSMStateFunctionBuilder with the first case statement set.
<ET,DT extends D> FSMStateFunctionBuilder<S,D,E>	matchEvent(java.lang.Class<ET> eventType, java.lang.Class<DT> dataType, FI.TypedPredicate2<ET,DT> predicate, FI.Apply2<ET,DT,PersistentFSM.State<S,D,E>> apply)	Create an FSMStateFunctionBuilder with the first case statement set.
FSMStateFunctionBuilder<S,D,E>	matchEvent(java.util.List<java.lang.Object> eventMatches, FI.Apply2<java.lang.Object,D,PersistentFSM.State<S,D,E>> apply)	Create an FSMStateFunctionBuilder with the first case statement set.
<DT extends D> FSMStateFunctionBuilder<S,D,E>	matchEvent(java.util.List<java.lang.Object> eventMatches, java.lang.Class<DT> dataType, FI.Apply2<java.lang.Object,DT,PersistentFSM.State<S,D,E>> apply)	Create an FSMStateFunctionBuilder with the first case statement set.
<Ev> FSMStateFunctionBuilder<S,D,E>	matchEventEquals(Ev event, FI.Apply2<Ev,D,PersistentFSM.State<S,D,E>> apply)	Create an FSMStateFunctionBuilder with the first case statement set.
<Ev,DT extends D> FSMStateFunctionBuilder<S,D,E>	matchEventEquals(Ev event, java.lang.Class<DT> dataType, FI.Apply2<Ev,DT,PersistentFSM.State<S,D,E>> apply)	Create an FSMStateFunctionBuilder with the first case statement set.
FSMTransitionHandlerBuilder<S>	matchState(S fromState, S toState, FI.UnitApply2<S,S> apply)	Create an FSMTransitionHandlerBuilder with the first case statement set.
FSMTransitionHandlerBuilder<S>	matchState(S fromState, S toState, FI.UnitApplyVoid apply)	Create an FSMTransitionHandlerBuilder with the first case statement set.
FSMStopBuilder<S,D>	matchStop(PersistentFSM.Reason reason, FI.UnitApply2<S,D> apply)	Create an FSMStopBuilder with the first case statement set.
<RT extends PersistentFSM.Reason> FSMStopBuilder<S,D>	matchStop(java.lang.Class<RT> reasonType, FI.TypedPredicate<RT> predicate, FI.UnitApply3<RT,S,D> apply)	Create an FSMStopBuilder with the first case statement set.
<RT extends PersistentFSM.Reason> FSMStopBuilder<S,D>	matchStop(java.lang.Class<RT> reasonType, FI.UnitApply3<RT,S,D> apply)	Create an FSMStopBuilder with the first case statement set.
PersistentFSM.Reason	Normal()	Default reason if calling stop().
static <S,D> scala.PartialFunction<S,D>	NullFunction()
void	onTermination(FSMStopBuilder<S,D> stopBuilder)	Set handler which is called upon termination of this FSM actor.
void	onTransition(FI.UnitApply2<S,S> transitionHandler)	Add a handler which is called upon each state transition, i.e.
void	onTransition(FSMTransitionHandlerBuilder<S> transitionHandlerBuilder)	Add a handler which is called upon each state transition, i.e.
ActorRef	self()	The 'self' field holds the ActorRef for this actor.
void	setTimer(java.lang.String name, java.lang.Object msg, scala.concurrent.duration.FiniteDuration timeout)	Schedule named timer to deliver message after given delay, possibly repeating.
PersistentFSM.Reason	Shutdown()	Reason given when someone was calling system.stop(fsm) from outside; also applies to Stop supervision directive.
void	startWith(S stateName, D stateData)	Set initial state.
void	startWith(S stateName, D stateData, scala.concurrent.duration.FiniteDuration timeout)	Set initial state.
PersistentFSM.StateTimeout$	StateTimeout()	This case object is received in case of a state timeout.
PersistentFSM.StopEvent$	StopEvent()
void	when(S stateName, FSMStateFunctionBuilder<S,D,E> stateFunctionBuilder)	Insert a new StateFunction at the end of the processing chain for the given state.
void	when(S stateName, scala.concurrent.duration.FiniteDuration stateTimeout, FSMStateFunctionBuilder<S,D,E> stateFunctionBuilder)	Insert a new StateFunction at the end of the processing chain for the given state.
void	when(S stateName, scala.PartialFunction<PersistentFSM.Event<D>,PersistentFSM.State<S,D,E>> stateFunction)	Insert a new StateFunction at the end of the processing chain for the given state.
void	whenUnhandled(FSMStateFunctionBuilder<S,D,E> stateFunctionBuilder)	Set handler which is called upon reception of unhandled messages.

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.actor.Actor

aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, postRestart, preRestart, preStart, sender, supervisorStrategy, unhandled

Methods inherited from interface akka.actor.ActorLogging

_log_$eq, log

Methods inherited from interface akka.routing.Listeners

gossip, gossip$default$2, listenerManagement

Methods inherited from interface akka.persistence.fsm.PersistentFSMBase

applyState, cancelTimer, currentState_$eq, debugEvent, generation_$eq, handleEvent_$eq, handleTransition, initialize, isStateTimerActive, isTimerActive, logTermination, makeTransition, nextState_$eq, nextStateData, onTermination, onTransition, postStop, processEvent, processMsg, receive, register, setStateTimeout, setTimer, setTimer$default$4, startWith, startWith$default$3, stateData, stateName, stateNames, stay, stop, stop, stop, super$postStop, terminate, terminateEvent_$eq, timeoutFuture_$eq, total2pf, transform, transitionEvent_$eq, when, when$default$2, whenUnhandled

Constructor Detail

AbstractPersistentFSMBase

public AbstractPersistentFSMBase()

Method Detail

NullFunction

public static <S,D> scala.PartialFunction<S,D> NullFunction()

Event

public PersistentFSM.Event$ Event()

Specified by:

Event in interface PersistentFSMBase<S,D,E>

StopEvent

public PersistentFSM.StopEvent$ StopEvent()

Specified by:

StopEvent in interface PersistentFSMBase<S,D,E>

$minus$greater

public PersistentFSM.$minus$greater$ $minus$greater()

Description copied from interface: PersistentFSMBase

This extractor is just convenience for matching a (S, S) pair, including a reminder what the new state is.

Specified by:

$minus$greater in interface PersistentFSMBase<S,D,E>

Returns:

(undocumented)

StateTimeout

public PersistentFSM.StateTimeout$ StateTimeout()

Description copied from interface: PersistentFSMBase

This case object is received in case of a state timeout.

Specified by:

StateTimeout in interface PersistentFSMBase<S,D,E>

Returns:

(undocumented)

akka$persistence$fsm$PersistentFSMBase$_setter_$Event_$eq

protected void akka$persistence$fsm$PersistentFSMBase$_setter_$Event_$eq(PersistentFSM.Event$ x$1)

Specified by:

akka$persistence$fsm$PersistentFSMBase$_setter_$Event_$eq in interface PersistentFSMBase<S,D,E>

akka$persistence$fsm$PersistentFSMBase$_setter_$StopEvent_$eq

protected void akka$persistence$fsm$PersistentFSMBase$_setter_$StopEvent_$eq(PersistentFSM.StopEvent$ x$1)

Specified by:

akka$persistence$fsm$PersistentFSMBase$_setter_$StopEvent_$eq in interface PersistentFSMBase<S,D,E>

akka$persistence$fsm$PersistentFSMBase$_setter_$StateTimeout_$eq

protected void akka$persistence$fsm$PersistentFSMBase$_setter_$StateTimeout_$eq(PersistentFSM.StateTimeout$ x$1)

Description copied from interface: PersistentFSMBase

This case object is received in case of a state timeout.

Specified by:

akka$persistence$fsm$PersistentFSMBase$_setter_$StateTimeout_$eq in interface PersistentFSMBase<S,D,E>

Parameters:

x$1 - (undocumented)

listeners

protected java.util.Set<ActorRef> listeners()

Specified by:

listeners in interface Listeners

akka$routing$Listeners$_setter_$listeners_$eq

protected void akka$routing$Listeners$_setter_$listeners_$eq(java.util.Set<ActorRef> x$1)

Specified by:

akka$routing$Listeners$_setter_$listeners_$eq in interface Listeners

context

public ActorContext context()

Description copied from interface: Actor

Scala API: Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.

WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

ActorContext is the Scala API. getContext returns a AbstractActor.ActorContext, which is the Java API of the actor context.

Specified by:

context in interface Actor

Returns:

(undocumented)

self

public final ActorRef self()

Description copied from interface: Actor

The 'self' field holds the ActorRef for this actor.

Can be used to send messages to itself:

 self ! message
 

Specified by:

self in interface Actor

Returns:

(undocumented)

akka$actor$Actor$_setter_$context_$eq

protected void akka$actor$Actor$_setter_$context_$eq(ActorContext x$1)

Specified by:

akka$actor$Actor$_setter_$context_$eq in interface Actor

akka$actor$Actor$_setter_$self_$eq

protected final void akka$actor$Actor$_setter_$self_$eq(ActorRef x$1)

Description copied from interface: Actor

The 'self' field holds the ActorRef for this actor.

Can be used to send messages to itself:

 self ! message
 

Specified by:

akka$actor$Actor$_setter_$self_$eq in interface Actor

Parameters:

x$1 - (undocumented)

getContext

public AbstractActor.ActorContext getContext()

getSelf

public ActorRef getSelf()

Returns the ActorRef for this actor.

Same as self().

Returns:

(undocumented)

getSender

public ActorRef getSender()

The reference sender Actor of the currently processed message. This is always a legal destination to send to, even if there is no logical recipient for the reply, in which case it will be sent to the dead letter mailbox.

Same as sender().

WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

Returns:

(undocumented)

when

public final void when(S stateName,
                       scala.PartialFunction<PersistentFSM.Event<D>,PersistentFSM.State<S,D,E>> stateFunction)

Insert a new StateFunction at the end of the processing chain for the given state.

Parameters:

stateName - designator for the state

stateFunction - partial function describing response to input

when

public final void when(S stateName,
                       FSMStateFunctionBuilder<S,D,E> stateFunctionBuilder)

Insert a new StateFunction at the end of the processing chain for the given state.

Parameters:

stateName - designator for the state

stateFunctionBuilder - partial function builder describing response to input

when

public final void when(S stateName,
                       scala.concurrent.duration.FiniteDuration stateTimeout,
                       FSMStateFunctionBuilder<S,D,E> stateFunctionBuilder)

Insert a new StateFunction at the end of the processing chain for the given state. If the stateTimeout parameter is set, entering this state without a differing explicit timeout setting will trigger a StateTimeout event; the same is true when using #stay.

Parameters:

stateName - designator for the state

stateTimeout - default state timeout for this state

stateFunctionBuilder - partial function builder describing response to input

startWith

public final void startWith(S stateName,
                            D stateData)

Set initial state. Call this method from the constructor before the PersistentFSMBase.initialize() method. If different state is needed after a restart this method, followed by PersistentFSMBase.initialize(), can be used in the actor life cycle hooks Actor.preStart() and Actor.postRestart(java.lang.Throwable).

Parameters:

stateName - initial state designator

stateData - initial state data

startWith

public final void startWith(S stateName,
                            D stateData,
                            scala.concurrent.duration.FiniteDuration timeout)

Set initial state. Call this method from the constructor before the PersistentFSMBase.initialize() method. If different state is needed after a restart this method, followed by PersistentFSMBase.initialize(), can be used in the actor life cycle hooks Actor.preStart() and Actor.postRestart(java.lang.Throwable).

Parameters:

stateName - initial state designator

stateData - initial state data

timeout - state timeout for the initial state, overriding the default timeout for that state

onTransition

public final void onTransition(FSMTransitionHandlerBuilder<S> transitionHandlerBuilder)

Add a handler which is called upon each state transition, i.e. not when staying in the same state.

Multiple handlers may be installed, and every one of them will be called, not only the first one matching.

Parameters:

transitionHandlerBuilder - (undocumented)

onTransition

public final void onTransition(FI.UnitApply2<S,S> transitionHandler)

Add a handler which is called upon each state transition, i.e. not when staying in the same state.

Multiple handlers may be installed, and every one of them will be called, not only the first one matching.

Parameters:

transitionHandler - (undocumented)

whenUnhandled

public final void whenUnhandled(FSMStateFunctionBuilder<S,D,E> stateFunctionBuilder)

Set handler which is called upon reception of unhandled messages. Calling this method again will overwrite the previous contents.

The current state may be queried using stateName.

Parameters:

stateFunctionBuilder - (undocumented)

onTermination

public final void onTermination(FSMStopBuilder<S,D> stopBuilder)

Set handler which is called upon termination of this FSM actor. Calling this method again will overwrite the previous contents.

Parameters:

stopBuilder - (undocumented)

matchEvent

public final <ET,DT extends D> FSMStateFunctionBuilder<S,D,E> matchEvent(java.lang.Class<ET> eventType,
                                                                                           java.lang.Class<DT> dataType,
                                                                                           FI.TypedPredicate2<ET,DT> predicate,
                                                                                           FI.Apply2<ET,DT,PersistentFSM.State<S,D,E>> apply)

Create an FSMStateFunctionBuilder with the first case statement set.

A case statement that matches on an event and data type and a predicate.

Parameters:

eventType - the event type to match on

dataType - the data type to match on

predicate - a predicate to evaluate on the matched types

apply - an action to apply to the event and state data if there is a match

Returns:

the builder with the case statement added

matchEvent

public final <ET,DT extends D> FSMStateFunctionBuilder<S,D,E> matchEvent(java.lang.Class<ET> eventType,
                                                                                           java.lang.Class<DT> dataType,
                                                                                           FI.Apply2<ET,DT,PersistentFSM.State<S,D,E>> apply)

Create an FSMStateFunctionBuilder with the first case statement set.

A case statement that matches on an event and data type.

Parameters:

eventType - the event type to match on

dataType - the data type to match on

apply - an action to apply to the event and state data if there is a match

Returns:

the builder with the case statement added

matchEvent

public final <ET> FSMStateFunctionBuilder<S,D,E> matchEvent(java.lang.Class<ET> eventType,
                                                                        FI.TypedPredicate2<ET,D> predicate,
                                                                        FI.Apply2<ET,D,PersistentFSM.State<S,D,E>> apply)

Create an FSMStateFunctionBuilder with the first case statement set.

A case statement that matches if the event type and predicate matches.

Parameters:

eventType - the event type to match on

predicate - a predicate that will be evaluated on the data and the event

apply - an action to apply to the event and state data if there is a match

Returns:

the builder with the case statement added

matchEvent

public final <ET> FSMStateFunctionBuilder<S,D,E> matchEvent(java.lang.Class<ET> eventType,
                                                                        FI.Apply2<ET,D,PersistentFSM.State<S,D,E>> apply)

Create an FSMStateFunctionBuilder with the first case statement set.

A case statement that matches if the event type matches.

Parameters:

eventType - the event type to match on

apply - an action to apply to the event and state data if there is a match

Returns:

the builder with the case statement added

matchEvent

public final FSMStateFunctionBuilder<S,D,E> matchEvent(FI.TypedPredicate2<java.lang.Object,D> predicate,
                                                                   FI.Apply2<java.lang.Object,D,PersistentFSM.State<S,D,E>> apply)

Create an FSMStateFunctionBuilder with the first case statement set.

A case statement that matches if the predicate matches.

Parameters:

predicate - a predicate that will be evaluated on the data and the event

apply - an action to apply to the event and state data if there is a match

Returns:

the builder with the case statement added

matchEvent

public final <DT extends D> FSMStateFunctionBuilder<S,D,E> matchEvent(java.util.List<java.lang.Object> eventMatches,
                                                                                  java.lang.Class<DT> dataType,
                                                                                  FI.Apply2<java.lang.Object,DT,PersistentFSM.State<S,D,E>> apply)

Create an FSMStateFunctionBuilder with the first case statement set.

A case statement that matches on the data type and if any of the event types in the list match or any of the event instances in the list compares equal.

Parameters:

eventMatches - a list of types or instances to match against

dataType - the data type to match on

apply - an action to apply to the event and state data if there is a match

Returns:

the builder with the case statement added

matchEvent

public final FSMStateFunctionBuilder<S,D,E> matchEvent(java.util.List<java.lang.Object> eventMatches,
                                                                   FI.Apply2<java.lang.Object,D,PersistentFSM.State<S,D,E>> apply)

Create an FSMStateFunctionBuilder with the first case statement set.

A case statement that matches if any of the event types in the list match or any of the event instances in the list compares equal.

Parameters:

eventMatches - a list of types or instances to match against

apply - an action to apply to the event and state data if there is a match

Returns:

the builder with the case statement added

matchEventEquals

public final <Ev,DT extends D> FSMStateFunctionBuilder<S,D,E> matchEventEquals(Ev event,
                                                                                                 java.lang.Class<DT> dataType,
                                                                                                 FI.Apply2<Ev,DT,PersistentFSM.State<S,D,E>> apply)

Create an FSMStateFunctionBuilder with the first case statement set.

A case statement that matches on the data type and if the event compares equal.

Parameters:

event - an event to compare equal against

dataType - the data type to match on

apply - an action to apply to the event and state data if there is a match

Returns:

the builder with the case statement added

matchEventEquals

public final <Ev> FSMStateFunctionBuilder<S,D,E> matchEventEquals(Ev event,
                                                                              FI.Apply2<Ev,D,PersistentFSM.State<S,D,E>> apply)

Create an FSMStateFunctionBuilder with the first case statement set.

A case statement that matches if the event compares equal.

Parameters:

event - an event to compare equal against

apply - an action to apply to the event and state data if there is a match

Returns:

the builder with the case statement added

matchAnyEvent

public final FSMStateFunctionBuilder<S,D,E> matchAnyEvent(FI.Apply2<java.lang.Object,D,PersistentFSM.State<S,D,E>> apply)

Create an FSMStateFunctionBuilder with the first case statement set.

A case statement that matches on any type of event.

Parameters:

apply - an action to apply to the event and state data if there is a match

Returns:

the builder with the case statement added

matchState

public final FSMTransitionHandlerBuilder<S> matchState(S fromState,
                                                       S toState,
                                                       FI.UnitApplyVoid apply)

Create an FSMTransitionHandlerBuilder with the first case statement set.

A case statement that matches on a from state and a to state.

Parameters:

fromState - the from state to match on

toState - the to state to match on

apply - an action to apply when the states match

Returns:

the builder with the case statement added

matchState

public final FSMTransitionHandlerBuilder<S> matchState(S fromState,
                                                       S toState,
                                                       FI.UnitApply2<S,S> apply)

Create an FSMTransitionHandlerBuilder with the first case statement set.

A case statement that matches on a from state and a to state.

Parameters:

fromState - the from state to match on

toState - the to state to match on

apply - an action to apply when the states match

Returns:

the builder with the case statement added

matchStop

public final FSMStopBuilder<S,D> matchStop(PersistentFSM.Reason reason,
                                                 FI.UnitApply2<S,D> apply)

Create an FSMStopBuilder with the first case statement set.

A case statement that matches on an PersistentFSM.Reason.

Parameters:

reason - the reason for the termination

apply - an action to apply to the event and state data if there is a match

Returns:

the builder with the case statement added

matchStop

public final <RT extends PersistentFSM.Reason> FSMStopBuilder<S,D> matchStop(java.lang.Class<RT> reasonType,
                                                                                   FI.UnitApply3<RT,S,D> apply)

Create an FSMStopBuilder with the first case statement set.

A case statement that matches on a reason type.

Parameters:

reasonType - the reason type to match on

apply - an action to apply to the reason, event and state data if there is a match

Returns:

the builder with the case statement added

matchStop

public final <RT extends PersistentFSM.Reason> FSMStopBuilder<S,D> matchStop(java.lang.Class<RT> reasonType,
                                                                                   FI.TypedPredicate<RT> predicate,
                                                                                   FI.UnitApply3<RT,S,D> apply)

Create an FSMStopBuilder with the first case statement set.

A case statement that matches on a reason type and a predicate.

Parameters:

reasonType - the reason type to match on

apply - an action to apply to the reason, event and state data if there is a match

predicate - a predicate that will be evaluated on the reason if the type matches

Returns:

the builder with the case statement added

matchData

public final <DT extends D> UnitPFBuilder<D> matchData(java.lang.Class<DT> dataType,
                                                       FI.UnitApply<DT> apply)

Create a UnitPFBuilder with the first case statement set.

Parameters:

dataType - a type to match the argument against

apply - an action to apply to the argument if the type matches

Returns:

a builder with the case statement added

matchData

public final <DT extends D> UnitPFBuilder<D> matchData(java.lang.Class<DT> dataType,
                                                       FI.TypedPredicate<DT> predicate,
                                                       FI.UnitApply<DT> apply)

Create a UnitPFBuilder with the first case statement set.

Parameters:

dataType - a type to match the argument against

predicate - a predicate that will be evaluated on the argument if the type matches

apply - an action to apply to the argument if the type and predicate matches

Returns:

a builder with the case statement added

goTo

public final PersistentFSM.State<S,D,E> goTo(S nextStateName)

Produce transition to other state. Return this from a state function in order to effect the transition.

Parameters:

nextStateName - state designator for the next state

Returns:

state transition descriptor

setTimer

public final void setTimer(java.lang.String name,
                           java.lang.Object msg,
                           scala.concurrent.duration.FiniteDuration timeout)

Schedule named timer to deliver message after given delay, possibly repeating. Any existing timer with the same name will automatically be canceled before adding the new timer.

Parameters:

name - identifier to be used with cancelTimer()

msg - message to be delivered

timeout - delay of first message delivery and between subsequent messages

Normal

public PersistentFSM.Reason Normal()

Default reason if calling stop().

Returns:

(undocumented)

Shutdown

public PersistentFSM.Reason Shutdown()

Reason given when someone was calling system.stop(fsm) from outside; also applies to Stop supervision directive.

Returns:

(undocumented)