se.fearless.fettle.impl

Class TemplateBasedStateMachine<S,E,C>

java.lang.Object

se.fearless.fettle.impl.TemplateBasedStateMachine<S,E,C>

All Implemented Interfaces:

StateMachine<S,E,C>

public class TemplateBasedStateMachine<S,E,C>
extends java.lang.Object
implements StateMachine<S,E,C>

Constructor Summary

Constructors

Constructor and Description
TemplateBasedStateMachine(TransitionModel<S,E,C> model, S initial, java.util.concurrent.locks.Lock lock)

Method Summary

Modifier and Type	Method and Description
boolean	fireEvent(E event) Fires an event at the state machine, possibly triggering a state change
boolean	fireEvent(E event, C context) Fires an event at the state machine, possibly triggering a state change
boolean	forceSetState(S forcedState) Forces the state machine to enter the forcedState even if there are no transitions leading to it No transition actions are run but exit actions on the current state and entry actions on the new state are run
S	getCurrentState() Gets the current state of the machine
java.util.Map<E,java.util.Collection<? extends Transition<S,C>>>	getPossibleTransitions(S fromState) Returns all possible transitions from a given state grouped by the event that triggers the transition.
void	rawSetState(S rawState) Sets the state of the state machine to the rawState even if there are no transitions leading to it No transition, entry or exit actions are run

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateBasedStateMachine

public TemplateBasedStateMachine(TransitionModel<S,E,C> model,
                                 S initial,
                                 java.util.concurrent.locks.Lock lock)

Method Detail

getCurrentState

public S getCurrentState()

Description copied from interface: StateMachine

Gets the current state of the machine

Specified by:

getCurrentState in interface StateMachine<S,E,C>

Returns:

the state the machine is currently in

fireEvent

public boolean fireEvent(E event)

Description copied from interface: StateMachine

Fires an event at the state machine, possibly triggering a state change

Specified by:

fireEvent in interface StateMachine<S,E,C>

Parameters:

event - the event that is fired

Returns:

true if the event resulted in a state change, false otherwise

fireEvent

public boolean fireEvent(E event,
                         C context)

Description copied from interface: StateMachine

Fires an event at the state machine, possibly triggering a state change

Specified by:

fireEvent in interface StateMachine<S,E,C>

Parameters:

event - the event that is fired

context - the context to be sent to any actions that are run on a state change. Used to supply parameters to actions and conditions

Returns:

true if the event resulted in a state change, false otherwise

rawSetState

public void rawSetState(S rawState)

Description copied from interface: StateMachine

Sets the state of the state machine to the rawState even if there are no transitions leading to it No transition, entry or exit actions are run

Specified by:

rawSetState in interface StateMachine<S,E,C>

Parameters:

rawState - the state the machine will be in after this method is called

forceSetState

public boolean forceSetState(S forcedState)

Description copied from interface: StateMachine

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

Specified by:

forceSetState in interface StateMachine<S,E,C>

Parameters:

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

Returns:

true if the state machine changed state

getPossibleTransitions

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

Description copied from interface: StateMachine

Returns all possible transitions from a given state grouped by the event that triggers the transition.

Specified by:

getPossibleTransitions in interface StateMachine<S,E,C>

Parameters:

fromState - the state to retrieve the outgoing transitions from.

Returns:

a map from all registered events in the fromState to the transitions they would trigger if fired.