net.sourceforge.anotherfsm

Interface StateMachine

All Superinterfaces:

java.lang.AutoCloseable, Processor

All Known Implementing Classes:

DeterministicStateMachine, SearchFsm, SearchFsmProcessor, SearchStringFsm, SearchStringProcessor, SynchronizedStateMachine, TimeoutConnectionFsm, TimeoutConnectionProcessor, TimeoutStateMachine

public interface StateMachine
extends Processor, java.lang.AutoCloseable

Interface for all state machines.

Author:

Michal Turek

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INITIAL_STATE_NAME The name of temporary generated initial state.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(StateListener listener) Add a new listener.
void	addListener(TransitionListener listener) Add a new listener.
void	addPreprocessor(Preprocessor preprocessor) Add a new preprocessor.
void	addState(State state) Add a new state.
void	addTransition(Transition transition) Add a new transition.
void	close() Finish processing of the events and free all allocated resources.
State	getActiveState() Get the currently active state.
java.util.Set<State>	getActiveStates() Get the currently active states.
java.util.Set<State>	getStates() Get all defined states.
java.util.Set<Transition>	getTransitions() Get all defined transitions.
boolean	isInFinalState() Is the active state a final state?
void	setStartState(State state) Set the start state.
void	start() Listeners of start state will be notified with non-loop transition from temporary generated initial state and StartEvent object.

Methods inherited from interface net.sourceforge.anotherfsm.Processor

getName, process

Field Detail

INITIAL_STATE_NAME

static final java.lang.String INITIAL_STATE_NAME

The name of temporary generated initial state.

See Also:

Constant Field Values

Method Detail

setStartState

void setStartState(State state)
                   throws FsmException

Set the start state.

Parameters:

state - the state

Throws:

FsmException

See Also:

start(), Processor.process(Event)

addState

void addState(State state)
              throws FsmException

Add a new state.

Parameters:

state - the state

Throws:

FsmException - if something fails

addTransition

void addTransition(Transition transition)
                   throws FsmException

Add a new transition.

Parameters:

transition - the transition

Throws:

FsmException - if something fails

addPreprocessor

void addPreprocessor(Preprocessor preprocessor)

Add a new preprocessor. The preprocessors will be called in the registration order during preprocessing of the events. The state machine is responsible for starting and stopping of the registered preprocessors.

Parameters:

preprocessor - the preprocessor

See Also:

Processor.process(Event), start(), close()

addListener

void addListener(StateListener listener)

Add a new listener.

Parameters:

listener - the listener

addListener

void addListener(TransitionListener listener)

Add a new listener.

Parameters:

listener - the listener

start

void start()
           throws FsmException

Listeners of start state will be notified with non-loop transition from temporary generated initial state and StartEvent object.

Specified by:

start in interface Processor

Throws:

FsmException - if something fails

See Also:

StartEvent, INITIAL_STATE_NAME

close

void close()

Description copied from interface: Processor

Finish processing of the events and free all allocated resources. This method can be called multiple times. Calling methods of the object after its Processor.close() should be avoided. The behavior is not defined and may cause unpredictable behavior, e.g. NullPointerException.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface Processor

See Also:

Processor.start()

getActiveState

State getActiveState()

Get the currently active state. Intended use is in deterministic state machines, for nondeterministic state machines only one of the active states is returned.

Returns:

the currently active state

See Also:

getActiveStates()

getActiveStates

java.util.Set<State> getActiveStates()

Get the currently active states. Intended use is in nondeterministic state machines.

Returns:

the currently active states

See Also:

getActiveState()

getStates

java.util.Set<State> getStates()

Get all defined states.

Returns:

the states

getTransitions

java.util.Set<Transition> getTransitions()

Get all defined transitions.

Returns:

the transitions

isInFinalState

boolean isInFinalState()

Is the active state a final state?

Returns:

true if at least one of the active states is final otherwise false