net.sourceforge.anotherfsm

Class SynchronizedStateMachine

java.lang.Object

net.sourceforge.anotherfsm.ProcessorAdapter

net.sourceforge.anotherfsm.DeterministicStateMachine

net.sourceforge.anotherfsm.SynchronizedStateMachine

All Implemented Interfaces:

java.lang.AutoCloseable, Processor, StateMachine

Direct Known Subclasses:

TimeoutStateMachine

public class SynchronizedStateMachine
extends DeterministicStateMachine

The deterministic state machine for use in multithreaded environment. Building of the object is NOT synchronized and should be done just in one thread. Only the processing of the events is synchronized.

Author:

Michal Turek

See Also:

Processor.process(Event), StateMachine.getActiveState(), StateMachine.getActiveStates(), StateMachine.isInFinalState()

Field Summary

Fields inherited from class net.sourceforge.anotherfsm.ProcessorAdapter

logger

Fields inherited from interface net.sourceforge.anotherfsm.StateMachine

INITIAL_STATE_NAME

Constructor Summary

Constructors

Constructor and Description
SynchronizedStateMachine(java.lang.String name) Create the object.

Method Summary

Methods

Modifier and Type	Method and Description
State	getActiveState() Get the currently active state.
java.util.Set<State>	getActiveStates() Get the currently active states.
boolean	isInFinalState() Is the active state a final state?
Event	process(Event event) Process the event.

Methods inherited from class net.sourceforge.anotherfsm.DeterministicStateMachine

addListener, addListener, addPreprocessor, addState, addTransition, close, easterEgg, getStates, getTransition, getTransitions, notifyEnter, notifyExit, notifyTransition, setStartState, start, toString

Methods inherited from class net.sourceforge.anotherfsm.ProcessorAdapter

getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.anotherfsm.Processor

getName

Constructor Detail

SynchronizedStateMachine

public SynchronizedStateMachine(java.lang.String name)

Create the object.

Parameters:

name - the name of the state machine

Method Detail

process

public Event process(Event event)
              throws FsmException

Description copied from interface: Processor

Process the event.

Specified by:

process in interface Processor

Overrides:

process in class DeterministicStateMachine

Parameters:

event - the input event

Returns:

the processed event

Throws:

FsmException - if something fails

getActiveState

public State getActiveState()

Description copied from interface: StateMachine

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

Specified by:

getActiveState in interface StateMachine

Overrides:

getActiveState in class DeterministicStateMachine

Returns:

the currently active state

See Also:

StateMachine.getActiveStates()

getActiveStates

public java.util.Set<State> getActiveStates()

Description copied from interface: StateMachine

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

Specified by:

getActiveStates in interface StateMachine

Overrides:

getActiveStates in class DeterministicStateMachine

Returns:

the currently active states

See Also:

StateMachine.getActiveState()

isInFinalState

public boolean isInFinalState()

Description copied from interface: StateMachine

Is the active state a final state?

Specified by:

isInFinalState in interface StateMachine

Overrides:

isInFinalState in class DeterministicStateMachine

Returns:

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