Package com.tangosol.util.fsm

Class SimpleModel<S extends Enum<S>>

java.lang.Object

com.tangosol.util.fsm.SimpleModel<S>

Type Parameters:

S - the type of state

All Implemented Interfaces:

Model<S>

public class SimpleModel<S extends Enum<S>>
extends Object
implements Model<S>

A SimpleModel is a basic implementation of a Model for a FiniteStateMachine.

Author:

Brian Oliver

Constructor Summary

Constructors

Constructor	Description
SimpleModel(Class<S> stateClass)	Constructs a SimpleModel given an Enum of the possible states of a FiniteStateMachine.

Method Summary

Modifier and Type	Method	Description
void	addStateEntryAction(S state, StateEntryAction<S> stateEntryAction)	Adds/overrides the StateEntryAction for the specified state in the Model.
void	addStateExitAction(S state, StateExitAction<S> stateExitAction)	Adds/overrides the StateExitAction for the specified state in the Model.
void	addTransition(Transition<S> transition)	Adds the specified Transition to the Model.
S	getState(String sName)	Obtains the state with the specified name from the SimpleModel.
Class<S>	getStateClass()	Obtains the Class of the state of the Model.
Map<S,StateEntryAction<S>>	getStateEntryActions()	Obtains the StateEntryActions defined for the states in the Model.
Map<S,StateExitAction<S>>	getStateExitActions()	Obtains the StateExitActions defined for the states in the Model.
S[]	getStates()	Obtains the valid states defined by the Model.
Iterable<Transition<S>>	getTransitions()	Obtains the Transitions defined by the Model.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleModel

public SimpleModel(Class<S> stateClass)

Constructs a SimpleModel given an Enum of the possible states of a FiniteStateMachine.

Parameters:

stateClass - the Enum class containing the possible states

Method Detail

getStateClass

public Class<S> getStateClass()

Obtains the Class of the state of the Model.

Specified by:

getStateClass in interface Model<S extends Enum<S>>

Returns:

the Class of the state

getStates

public S[] getStates()

Obtains the valid states defined by the Model.

Specified by:

getStates in interface Model<S extends Enum<S>>

Returns:

the valid states of the Model

getStateEntryActions

public Map<S,StateEntryAction<S>> getStateEntryActions()

Obtains the StateEntryActions defined for the states in the Model.

Specified by:

getStateEntryActions in interface Model<S extends Enum<S>>

Returns:

the defined StateEntryActions defined for the states in the Model

addStateEntryAction

public void addStateEntryAction(S state,
                                StateEntryAction<S> stateEntryAction)

Adds/overrides the StateEntryAction for the specified state in the Model.

Parameters:

state - the state

stateEntryAction - the StateEntryAction for the state

getStateExitActions

public Map<S,StateExitAction<S>> getStateExitActions()

Obtains the StateExitActions defined for the states in the Model.

Specified by:

getStateExitActions in interface Model<S extends Enum<S>>

Returns:

the defined StateExitActions defined for the states in the Model

getTransitions

public Iterable<Transition<S>> getTransitions()

Obtains the Transitions defined by the Model.

Specified by:

getTransitions in interface Model<S extends Enum<S>>

Returns:

the Transitions defined by the Model

getState

public S getState(String sName)

Obtains the state with the specified name from the SimpleModel.

Parameters:

sName - the name of the state to obtain

Returns:

the state with the specified name or null if no such state is known by the SimpleModel

addStateExitAction

public void addStateExitAction(S state,
                               StateExitAction<S> stateExitAction)

Adds/overrides the StateExitAction for the specified state in the Model.

Parameters:

state - the state

stateExitAction - the StateExitAction for the state

addTransition

public void addTransition(Transition<S> transition)

Adds the specified Transition to the Model.

Parameters:

transition - the Transition to add