Package dev.prozilla.pine.core.state

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

All Known Subinterfaces:
MutableStateProvider<Context,S>, StateMachineProvider<Context,S>
All Known Implementing Classes:
Application, StateMachine
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@ProviderOf(State.class) @FunctionalInterface public interface StateProvider<Context,S extends State<Context>>
Provides information about the state in a certain context.

  • Method Summary

    Modifier and Type
    Method
    Description
    S
    getState()
     
    default boolean
    isAnyState(S... states)
    Checks whether the state machine is in any of the given states.
    default boolean
    isState(S state)
    Checks whether the state machine is in a given state.

  • Method Details

    • getState

      S getState()
      Returns:
      The current state of the state machine.

    • isState

      default boolean isState(S state)
      Checks whether the state machine is in a given state.

    • isAnyState

      default boolean isAnyState(S... states)
      Checks whether the state machine is in any of the given states.