net.sourceforge.anotherfsm

Class DeterministicStateMachine

java.lang.Object

net.sourceforge.anotherfsm.DeterministicStateMachine

All Implemented Interfaces:

java.lang.AutoCloseable, Processor, StateMachine

Direct Known Subclasses:

SynchronizedStateMachine

public class DeterministicStateMachine
extends java.lang.Object
implements StateMachine

The deterministic state machine. This class is NOT thread safe.

Author:

Michal Turek

See Also:

SynchronizedStateMachine

Field Summary

Fields

Modifier and Type	Field and Description
protected FsmLogger	logger The logger.

Fields inherited from interface net.sourceforge.anotherfsm.StateMachine

INITIAL_STATE_NAME

Constructor Summary

Constructors

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

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.
boolean	easterEgg() Each software product should contain at least one easter egg.
State	getActiveState() Get the currently active state.
java.util.Set<State>	getActiveStates() Get the currently active states.
java.lang.String	getName() Get the name of the processor.
java.util.Set<State>	getStates() Get all defined states.
protected Transition	getTransition(State state, Event event) Get transition of a specified event type defined for a state.
java.util.Set<Transition>	getTransitions() Get all defined transitions.
boolean	isInFinalState() Is the active state a final state?
Event	process(Event event) Process the event.
void	setStartState(State state) Set the start state.
void	start() Building of the processor is finished, prepare it to the events processing.
java.lang.String	toString()

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

Field Detail

logger

protected final FsmLogger logger

The logger.

Constructor Detail

DeterministicStateMachine

public DeterministicStateMachine(java.lang.String name)

Create the object.

Parameters:

name - the name of the state machine

Method Detail

setStartState

public void setStartState(State state)
                   throws FsmException

Description copied from interface: StateMachine

Set the start state.

Specified by:

setStartState in interface StateMachine

Parameters:

state - the state

Throws:

FsmException

See Also:

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

start

public void start()
           throws FsmException

Description copied from interface: Processor

Building of the processor is finished, prepare it to the events processing. It is expected this method is called just once.

Specified by:

start in interface Processor

Specified by:

start in interface StateMachine

Throws:

FsmException - if something fails

See Also:

Processor.close()

close

public 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

Specified by:

close in interface StateMachine

See Also:

Processor.start()

addState

public void addState(State state)
              throws FsmException

Description copied from interface: StateMachine

Add a new state.

Specified by:

addState in interface StateMachine

Parameters:

state - the state

Throws:

FsmException - if something fails

addTransition

public void addTransition(Transition transition)
                   throws FsmException

Description copied from interface: StateMachine

Add a new transition.

Specified by:

addTransition in interface StateMachine

Parameters:

transition - the transition

Throws:

FsmException - if something fails

addPreprocessor

public void addPreprocessor(Preprocessor preprocessor)

Description copied from interface: StateMachine

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.

Specified by:

addPreprocessor in interface StateMachine

Parameters:

preprocessor - the preprocessor

See Also:

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

addListener

public void addListener(StateListener listener)

Description copied from interface: StateMachine

Add a new listener.

Specified by:

addListener in interface StateMachine

Parameters:

listener - the listener

addListener

public void addListener(TransitionListener listener)

Description copied from interface: StateMachine

Add a new listener.

Specified by:

addListener in interface StateMachine

Parameters:

listener - the listener

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

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

Returns:

the currently active states

See Also:

StateMachine.getActiveState()

process

public Event process(Event event)
              throws FsmException

Description copied from interface: Processor

Process the event.

Specified by:

process in interface Processor

Parameters:

event - the input event

Returns:

the processed event

Throws:

FsmException - if something fails

getStates

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

Description copied from interface: StateMachine

Get all defined states.

Specified by:

getStates in interface StateMachine

Returns:

the states

getTransitions

public java.util.Set<Transition> getTransitions()

Description copied from interface: StateMachine

Get all defined transitions.

Specified by:

getTransitions in interface StateMachine

Returns:

the transitions

getTransition

protected Transition getTransition(State state,
                       Event event)

Get transition of a specified event type defined for a state.

Parameters:

state - the state, it must be defined in the state machine

event - the event

Returns:

the transition or null if not defined

isInFinalState

public boolean isInFinalState()

Description copied from interface: StateMachine

Is the active state a final state?

Specified by:

isInFinalState in interface StateMachine

Returns:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

easterEgg

public boolean easterEgg()

Each software product should contain at least one easter egg.

Returns:

true

getName

public java.lang.String getName()

Description copied from interface: Processor

Get the name of the processor.

Specified by:

getName in interface Processor

Returns:

the name