Package dev.prozilla.pine.core.state

Class StateMachine<Context,State extends State<Context>>

java.lang.Object

dev.prozilla.pine.core.state.StateMachine<Context,State>

All Implemented Interfaces:

MutableStateProvider<Context,State>, StateProvider<Context,State>

public class StateMachine<Context,State extends State<Context>>
extends Object
implements MutableStateProvider<Context,State>

Utility class for managing a finite-state machine (FSM).

Field Summary

Fields

Modifier and Type	Field	Description
protected final Context	context
protected State	currentState

Constructor Summary

Constructors

Constructor	Description
StateMachine(State initialState, Context context)	Creates a state machine for a given context and enters its initial state.

Method Summary

Modifier and Type	Method	Description
void	changeState(State newState)	Exits the current state and enters a new state, unless both are equal.
protected Logger	getLogger()
State	getState()

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.prozilla.pine.core.state.MutableStateProvider

changeState, toggleState

Methods inherited from interface dev.prozilla.pine.core.state.StateProvider

isAnyState, isState

Field Details

currentState

protected State extends State<Context> currentState

context

protected final Context context

Constructor Details

StateMachine

public StateMachine(State initialState,
 Context context)

Creates a state machine for a given context and enters its initial state.

Parameters:

initialState - The initial state of the state machine

context - The context of the state

Method Details

changeState

public void changeState(State newState)

Description copied from interface: MutableStateProvider

Exits the current state and enters a new state, unless both are equal.

Specified by:

changeState in interface MutableStateProvider<Context,State extends State<Context>>

Parameters:

newState - The new state to enter

getState

public State getState()

Specified by:

getState in interface StateProvider<Context,State extends State<Context>>

Returns:

The current state of the state machine.

getLogger

protected Logger getLogger()