jhelp.util.stateMachine

Class StateMachine

java.lang.Object

jhelp.util.thread.ThreadedTask<PARAMETER,java.lang.Void,java.lang.Void>

jhelp.util.thread.ThreadedSimpleTask<java.lang.Void>

jhelp.util.thread.ThreadedVerySimpleTask

jhelp.util.stateMachine.StateMachine

public abstract class StateMachine
extends ThreadedVerySimpleTask

For manage a state machine.
Extends this class.
Call doState(int) when you want pass to an other state

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private int	head Head of waiting states queue
private int	numberMaxOfWaitingState Maximum number of waiting state in queue
private int	queue Queue of waiting state queue
private int	state Actual playing state
private int[]	waitingStates Waiting states queue

Constructor Summary

Constructors

Constructor and Description
StateMachine() Create a new instance of StateMachine
StateMachine(int numberMaxOfWaitingState) Create a new instance of StateMachine

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDoMoreState() Indicates if the waiting state queue has more place or not
protected abstract boolean	canPass(int actualState, int futureState) Called when want check if the passing to a state to an other one is legal
protected void	doState(int state) Call this method to pass to an other state
protected void	doVerySimpleAction() Called when a state have to be played Parent documentation: Do the very simple task in its own thread
protected int	getState() Actual state
protected abstract void	playState(int state) Called when a state have to play
protected abstract void	reportIllegalState(int actualState, int futureState) Called each time a state to an other one is not allowed.

Methods inherited from class jhelp.util.thread.ThreadedVerySimpleTask

doSimpleAction

Methods inherited from class jhelp.util.thread.ThreadedSimpleTask

doThreadAction

Methods inherited from class jhelp.util.thread.ThreadedTask

cancel, canceled, doProgress, postProgress, setResult

Methods inherited from class java.lang.Object

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

Field Detail

head

private int head

Head of waiting states queue

numberMaxOfWaitingState

private final int numberMaxOfWaitingState

Maximum number of waiting state in queue

queue

private int queue

Queue of waiting state queue

state

private int state

Actual playing state

waitingStates

private final int[] waitingStates

Waiting states queue

Constructor Detail

StateMachine

public StateMachine()

Create a new instance of StateMachine

StateMachine

public StateMachine(int numberMaxOfWaitingState)

Create a new instance of StateMachine

Parameters:

numberMaxOfWaitingState - Number maximum of waiting state

Method Detail

canPass

protected abstract boolean canPass(int actualState,
              int futureState)

Called when want check if the passing to a state to an other one is legal

Parameters:

actualState - Actual state

futureState - State that want to go

Returns:

true if it is authorize to got from actual state to future state

doState

protected final void doState(int state)

Call this method to pass to an other state

Parameters:

state - State to go

doVerySimpleAction

protected final void doVerySimpleAction()

Called when a state have to be played

Parent documentation:
Do the very simple task in its own thread

Specified by:

doVerySimpleAction in class ThreadedVerySimpleTask

See Also:

ThreadedVerySimpleTask.doVerySimpleAction()

getState

protected final int getState()

Actual state

Returns:

Actual state

playState

protected abstract void playState(int state)

Called when a state have to play

Parameters:

state - State to play

reportIllegalState

protected abstract void reportIllegalState(int actualState,
                      int futureState)

Called each time a state to an other one is not allowed.

Usually it signal a bug

Parameters:

actualState - Actual state

futureState - Desired state

canDoMoreState

public final boolean canDoMoreState()

Indicates if the waiting state queue has more place or not

Returns:

true if the waiting state queue has more place