Package org.antublue.test.engine.internal.util

Class StateMachine<T>

java.lang.Object

org.antublue.test.engine.internal.util.StateMachine<T>

public class StateMachine<T>
extends Object

Class to implement a StateMachine

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StateMachine.Action<T>	Interface to implement an Action

Constructor Summary

Constructors

Constructor	Description
StateMachine(String id)	Constructor

Method Summary

Modifier and Type	Method	Description
StateMachine<T>	afterEach(StateMachine.Action<T> afterEachAction)	Method to add an afterEach action
StateMachine<T>	definition(T state, StateMachine.Action<T> action, T... nextStates)	Method to define a state, the action to perform when the state is encountered, and valid next states
StateMachine<T>	end(T state, StateMachine.Action<T> action)	Method to set the end state and action
void	run(T initialState)	Method to run the state machine
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

StateMachine

public StateMachine(String id)

Constructor

Parameters:

id - id

Method Details

afterEach

public StateMachine<T> afterEach(StateMachine.Action<T> afterEachAction)

Method to add an afterEach action

Parameters:

afterEachAction - afterEachAction

Returns:

this

definition

public StateMachine<T> definition(T state,
 StateMachine.Action<T> action,
 T... nextStates)
                           throws StateMachineException

Method to define a state, the action to perform when the state is encountered, and valid next states

Parameters:

state - state

action - action

nextStates - nextStates

Returns:

this

Throws:

StateMachineException

end

public StateMachine<T> end(T state,
 StateMachine.Action<T> action)

Method to set the end state and action

Parameters:

state - state

action - action

Returns:

this

run

public void run(T initialState)
         throws StateMachineException

Method to run the state machine

Parameters:

initialState - initialState

Throws:

StateMachineException - StateMachineException

toString

public String toString()

Overrides:

toString in class Object