com.googlecode.jinahya.fsm

Class Machine

java.lang.Object

com.googlecode.jinahya.fsm.Machine

public abstract class Machine
extends Object

A Finite State Machine.

Author:

Jin Kwon

Constructor Summary

Constructors

Constructor and Description
Machine(List<Task> tasks) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
State	getState() Returns current state of this machine.
protected abstract boolean	isAllowed(Transition transition) Checks if given transition is allowed.
protected abstract boolean	isFinishing(Transition transition) Checks if given transition is an finishing condition.
protected abstract boolean	isStarting(Transition transition) Checks if given transition is a starting condition.
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(List<Task> tasks)

Creates a new instance.

Parameters:

tasks - tasks

Method Detail

getState

public final State getState()

Returns current state of this machine.

Returns:

current state

setState

public final void setState(State state)
                    throws FSMException

Sets state.

Parameters:

state - new state

Throws:

FSMException - if an error occurs.

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 if given transition is a starting condition; false otherwise.

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 if given transition is allowed; false if not allowed.

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:

true if given transition is a finishing condition; false otherwise.