Package dev.prozilla.pine.core.state

Interface StateMachineProvider<Context,S extends State<Context>>

All Superinterfaces:

MutableStateProvider<Context,S>, StateProvider<Context,S>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface StateMachineProvider<Context,S extends State<Context>>
extends MutableStateProvider<Context,S>

Method Summary

Modifier and Type	Method	Description
default void	changeState(S newState)	Exits the current state and enters a new state, unless both are equal.
default S	getState()
StateMachine<Context,S>	getStateMachine()

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

changeState, toggleState

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

isAnyState, isState

Method Details

getStateMachine

StateMachine<Context,S> getStateMachine()

getState

default S getState()

Specified by:

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

Returns:

The current state of the state machine.

changeState

default void changeState(S 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,S extends State<Context>>

Parameters:

newState - The new state to enter