com.googlecode.jinahya.util.fsm

Class Machine

java.lang.Object

com.googlecode.jinahya.util.fsm.Machine

public abstract class Machine
extends java.lang.Object

A Finite State Machine.

Author:

Jin Kwon

Constructor Summary

Constructors

Constructor and Description
Machine(java.util.Map<java.lang.String,Task> tasks) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
State	getState() Returns current state.
protected abstract boolean	isAllowed(Transition transition) Checks if given transition is allowed.
boolean	isFinished() Returns finished flag value.
protected abstract boolean	isFinishing(Transition transition) Checks if given transition is an finishing condition.
boolean	isStarted() Returns started flag value.
protected abstract boolean	isStarting(Transition transition) Checks if given transition is a starting condition.
protected void	perform(TransitionContext context, Task... tasks) Performs each of given tasks with specified context.
void	setState(State state) Sets state.

Methods inherited from class java.lang.Object

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

Constructor Detail

Machine

public Machine(java.util.Map<java.lang.String,Task> tasks)

Creates a new instance.

Parameters:

tasks - tasks

Method Detail

getState

public final State getState()

Returns current state.

Returns:

state

setState

public final void setState(State state)
                    throws FSMException

Sets state.

Parameters:

state - new state

Throws:

FSMException - if an error occurs.

perform

protected void perform(TransitionContext context,
           Task... tasks)
                throws FSMException

Performs each of given tasks with specified context. Each task can be performed concurrently. This method must guarantee that all tasks are performed before return.

Parameters:

context - transition context

tasks - tasks

Throws:

FSMException - if an error occurs.

isStarted

public final boolean isStarted()

Returns started flag value.

Returns:

true if this machine has been started; false otherwise.

isFinished

public final boolean isFinished()

Returns finished flag value.

Returns:

true if this machine has been finished; false otherwise.

isStarting

protected abstract boolean isStarting(Transition transition)

Checks if given transition is a starting condition. Default implementation always returns true. Override this method if customizations are needed.

Parameters:

transition - transition to check

Returns:

true

isAllowed

protected abstract boolean isAllowed(Transition transition)

Checks if given transition is allowed. Default implementation always returns true. Override this method if customizations are needed.

Parameters:

transition - transition to check.

Returns:

true

isFinishing

protected abstract boolean isFinishing(Transition transition)

Checks if given transition is an finishing condition. Default implementation always returns false. Override this method if customizations are needed.

Parameters:

transition - transition to check

Returns:

false