se.fearless.fettle

Interface TransitionModel<S,E,C>

All Known Subinterfaces:

MutableTransitionModel<S,E,C>

All Known Implementing Classes:

AbstractTransitionModel, ImmutableTransitionModel, MutableTransitionModelImpl

public interface TransitionModel<S,E,C>

Method Summary

Modifier and Type	Method and Description
boolean	fireEvent(StateMachine<S,E,C> machine, E event, C context) Fires the event at the state machine.
boolean	forceSetState(StateMachine<S,E,C> stateMachine, S forcedState) Forces the state machine to enter the forcedState even if there are no transitions to that state.
C	getDefaultContext()
java.util.Map<E,java.util.Collection<? extends Transition<S,C>>>	getPossibleTransitions(S fromState)

Method Detail

fireEvent

boolean fireEvent(StateMachine<S,E,C> machine,
                  E event,
                  C context)

Fires the event at the state machine. This can result in a state change and trigger actions to be run.

Parameters:

machine - the machine to fire the event at

event - the event to fire

context - the context to use for transition conditions and actions. The context can be used to supply arguments to actions.

Returns:

true if a state change was triggered, false otherwise. Note that this will return true if a transition to the same state occurs

forceSetState

boolean forceSetState(StateMachine<S,E,C> stateMachine,
                      S forcedState)

Forces the state machine to enter the forcedState even if there are no transitions to that state. No transition actions are run but exit actions on the current state and entry actions on the new state are run

Parameters:

stateMachine - the state machine to force the state for

forcedState - the state the machine will be in after this method

Returns:

true if the state was changed

getDefaultContext

C getDefaultContext()

getPossibleTransitions

java.util.Map<E,java.util.Collection<? extends Transition<S,C>>> getPossibleTransitions(S fromState)