se.fearless.fettle.impl

Class AbstractTransitionModel<S,E,C>

java.lang.Object

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

All Implemented Interfaces:

TransitionModel<S,E,C>

Direct Known Subclasses:

ImmutableTransitionModel, MutableTransitionModelImpl

public abstract class AbstractTransitionModel<S,E,C>
extends java.lang.Object
implements TransitionModel<S,E,C>

Field Summary

Fields

Modifier and Type	Field and Description
protected C	defaultContext
protected java.util.Map<S,java.util.Collection<Action<S,E,C>>>	enterActions
protected java.lang.Class<E>	eventClass
protected java.util.Map<S,java.util.Collection<Action<S,E,C>>>	exitActions
protected java.util.Map<E,java.util.Collection<BasicTransition<S,E,C>>>	fromAllTransitions
protected java.lang.Class<S>	stateClass
protected java.util.Map<S,java.util.Map<E,java.util.Collection<BasicTransition<S,E,C>>>>	transitionMap

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTransitionModel(java.lang.Class<S> stateClass, java.lang.Class<E> eventClass, C defaultContext)

Method Summary

Modifier and Type	Method and Description
protected static <S,T> java.util.Map<S,T>	createMap(java.lang.Class<S> state)
boolean	fireEvent(StateMachine<S,E,C> stateMachine, 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<BasicTransition<S,E,C>>>	getFromAllTransitions()
java.util.Map<E,java.util.Collection<? extends Transition<S,C>>>	getPossibleTransitions(S fromState)
java.util.Map<S,java.util.Map<E,java.util.Collection<BasicTransition<S,E,C>>>>	getStateTransitions()

Methods inherited from class java.lang.Object

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

Field Detail

transitionMap

protected final java.util.Map<S,java.util.Map<E,java.util.Collection<BasicTransition<S,E,C>>>> transitionMap

fromAllTransitions

protected final java.util.Map<E,java.util.Collection<BasicTransition<S,E,C>>> fromAllTransitions

exitActions

protected final java.util.Map<S,java.util.Collection<Action<S,E,C>>> exitActions

enterActions

protected final java.util.Map<S,java.util.Collection<Action<S,E,C>>> enterActions

stateClass

protected final java.lang.Class<S> stateClass

eventClass

protected final java.lang.Class<E> eventClass

defaultContext

protected final C defaultContext

Constructor Detail

AbstractTransitionModel

protected AbstractTransitionModel(java.lang.Class<S> stateClass,
                                  java.lang.Class<E> eventClass,
                                  C defaultContext)

Method Detail

createMap

protected static <S,T> java.util.Map<S,T> createMap(java.lang.Class<S> state)

fireEvent

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

Description copied from interface: TransitionModel

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

Specified by:

fireEvent in interface TransitionModel<S,E,C>

Parameters:

stateMachine - 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

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

Description copied from interface: TransitionModel

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

Specified by:

forceSetState in interface TransitionModel<S,E,C>

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

getStateTransitions

public java.util.Map<S,java.util.Map<E,java.util.Collection<BasicTransition<S,E,C>>>> getStateTransitions()

getFromAllTransitions

public java.util.Map<E,java.util.Collection<BasicTransition<S,E,C>>> getFromAllTransitions()

getDefaultContext

public C getDefaultContext()

Specified by:

getDefaultContext in interface TransitionModel<S,E,C>

getPossibleTransitions

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

Specified by:

getPossibleTransitions in interface TransitionModel<S,E,C>