Package 

Class FiniteStateMachine

  • 
public final class FiniteStateMachine<S extends Object, E extends Object>

    This class represents a Finite State Machine. It can be only in one possible state at a time out of the set of possible states S. It can handle events from the set E.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private final S state

    • Method Summary

      Modifier and Type Method Description
      final S getState()
      final Unit sendEvent(E event) Sends an event to the state machine.
      final S stay() Keeps the FSM in its current state.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • sendEvent

         final Unit sendEvent(E event)

        Sends an event to the state machine. The entry point to change state.

      • stay

         final S stay()

        Keeps the FSM in its current state. Usually used when handling events that don't need to make a transition.

        onEvent<SomeEvent> { state, event -> stay() }