Package rekit.util.state

Class State

java.lang.Object

rekit.util.state.State

public abstract class State
extends Object

Abstract State whose concrete implementations that a TimeStateMachine can be in.

Concrete classes may add functionality to enter(TimeStateMachine parent) (that is called upon entering this state), leave() (that is called upon leaving this state) and logicLoop() (that is called periodically by the TimeStateMachine).

For automatic switching states, the implementations must supply a getTimerTime() that specifies how (in millis) the TimeStateMachine is supposed to be in this state as well as a getNextState() that returns the next state to enter after that time.

Author:

Angelo Aracri

Field Summary

Fields

Modifier and Type	Field	Description
protected TimeStateMachine	parent	A reference to the parenting TimeStateMachine that is used to switch States.
protected Timer	timer	Timer that is used to keep track of how much time this State is remaining before it switches to the next State.

Constructor Summary

Constructors

Constructor	Description
State()	Constructor that initializes the timer using getTimerTime().

Method Summary

Modifier and Type	Method	Description
void	enter(TimeStateMachine parent)	Method that is called by the TimeStateMachine upon entering this State.
abstract State	getNextState()	Must supply a fully instantiated State that the parenting TimeStateMachine will enter after this State is out of time as specified in getTimerTime().
abstract long	getTimerTime()	Must supply the time in millis how long the TimeStateMachine is supposed to be in this State before switching to the next as specified in getNextState().
protected void	internalLogicLoop()	Method that may or may not be implemented by a concrete state to perform periodic actions
void	leave()	Method that is called by the TimeStateMachine upon leaving this State.
void	logicLoop()	Method that is periodically called by the TimeStateMachine.

Methods inherited from class java.lang.Object

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

Field Details

parent

protected TimeStateMachine parent

A reference to the parenting TimeStateMachine that is used to switch States.

timer

protected Timer timer

Timer that is used to keep track of how much time this State is remaining before it switches to the next State.

Constructor Details

State

public State()

Constructor that initializes the timer using getTimerTime().

Method Details

enter

public void enter(TimeStateMachine parent)

Method that is called by the TimeStateMachine upon entering this State.

Parameters:

parent - the parenting TimeStateMachine that handles this (and probably other) States.

leave

public void leave()

Method that is called by the TimeStateMachine upon leaving this State.

logicLoop

public void logicLoop()

Method that is periodically called by the TimeStateMachine.

internalLogicLoop

protected void internalLogicLoop()

Method that may or may not be implemented by a concrete state to perform periodic actions

getNextState

public abstract State getNextState()

Must supply a fully instantiated State that the parenting TimeStateMachine will enter after this State is out of time as specified in getTimerTime().

Returns:

the next State to enter.

getTimerTime

public abstract long getTimerTime()

Must supply the time in millis how long the TimeStateMachine is supposed to be in this State before switching to the next as specified in getNextState().

Returns:

the time in millis to stay in this State.