S
- the type of the state
public interface StateEntryAction<S extends Enum<S>>
StateEntryAction
encapsulates the actions to be performed by a FiniteStateMachine
when a particular state is entered.
A StateEntryAction
for a particular state will be executed when the FiniteStateMachine
has been set (to the said state) or a Transition
(to the said state) has successfully completed.
Modifier and Type | Method and Description |
---|---|
Instruction |
onEnterState(S exitingState, S enteringState, Event<S> event, ExecutionContext context)
Performs the necessary actions when a
FiniteStateMachine enters a particular state. |
Instruction onEnterState(S exitingState, S enteringState, Event<S> event, ExecutionContext context)
FiniteStateMachine
enters a particular state. Once finished, the returned Instruction
is performed.exitingState
- the previous state of the FiniteStateMachine
prior to the state change (may be null
if there was no previous state)enteringState
- the new state of the FiniteStateMachine
event
- the Event
that triggered the actioncontext
- the ExecutionContext
for the actionInstruction
to be performed by the FiniteStateMachine