org.openbase.jul.pattern.statemachine

Class StateRunner

java.lang.Object

org.openbase.jul.pattern.statemachine.StateRunner

All Implemented Interfaces:

Runnable, Initializable<Class<? extends State>>

public class StateRunner
extends Object
implements Runnable, Initializable<Class<? extends State>>

A simple state machine implementation which can execute states which are implementing the org.openbase.jul.pattern.statemachine.State interface. The state graph is defined by the states itself. Whenever a state has finished its task the next state transition is defined by the state itself via the return value of the call method which defines the next state. Start this state machine via the global executor service after initialization. e.g. GlobalCachedExecutorService.submit(stateMaschineInstance)

Author:

Divine Threepwood, malinke

Field Summary

Fields

Modifier and Type	Field and Description
static String	STATE_CHANGE
static String	STATE_ERROR

Constructor Summary

Constructors

Constructor and Description
StateRunner()

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener) Method registers a property change listener which will be informed about state transitions.
State	getCurrentState() Method returns the state which is currently processed.
void	init(Class<? extends State> stateClass) Defines the initial state of the state machine.
boolean	isCurrentState(Class clazz) Method can be used to verify if the given state is currently processed.
void	removePropertyChangeListener(PropertyChangeListener listener) Method removes a previously registered property change listener.
void	run() Method starts the state machine.

Methods inherited from class java.lang.Object

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

Field Detail

STATE_CHANGE

public static final String STATE_CHANGE

See Also:

Constant Field Values

STATE_ERROR

public static final String STATE_ERROR

See Also:

Constant Field Values

Constructor Detail

StateRunner

public StateRunner()

Method Detail

init

public void init(Class<? extends State> stateClass)
          throws InitializationException

Defines the initial state of the state machine.

Specified by:

init in interface Initializable<Class<? extends State>>

Parameters:

stateClass -

Throws:

InitializationException

run

public void run()

Method starts the state machine. Because this class is implementing the runnable interface its not recommended to call this method manually. Start the state machine via the global executor service. e.g. GlobalCachedExecutorService.submit(stateMaschineInstance)

Specified by:

run in interface Runnable

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Method registers a property change listener which will be informed about state transitions.

Parameters:

listener - the change listener to register.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Method removes a previously registered property change listener.

Parameters:

listener - the change listener to remove.

getCurrentState

public State getCurrentState()

Method returns the state which is currently processed.

Returns:

the currently processed state.

isCurrentState

public boolean isCurrentState(Class clazz)

Method can be used to verify if the given state is currently processed.

Parameters:

clazz - the class to define the state type.

Returns:

returns true if the given state is currently processed, otherwise false.