StateMachine (robopupu-api API)

java.lang.Object
- com.robopupu.api.fsm.StateMachine

All Implemented Interfaces:

StateEngineObserver
```
public abstract class StateMachine
extends java.lang.Object
implements StateEngineObserver
```
StateMachine provides an abstract base class for implementing a Finite State Machine (FMS). An instance of concrete StateMachine uses a code generated concrete implementation of StateEngine to implement and execute the state machine.

Constructor Summary

Constructors
Modifier Constructor and Description

protected StateMachine()

Constructors
Modifier	Constructor and Description
`protected`	`StateMachine()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected StateEngine<?>`	`createStateEngine()` Creates the `StateEngine`.
`<T extends StateEngine<?>> T`	`getCurrentState()` Gets the current state `StateEngine` that is an instance of code generated class.
`<T extends StateEngine<?>> T`	`getStateEngine()` Gets the `StateEngine` that is an instance of concrete implementation of a `StateEngine` code generated by Fuusio FSM Annotation Processor.
`boolean`	`isCurrentState(java.lang.Class<? extends StateEngine<?>> stateClass)` Tests if the current state is the specified one.
`boolean`	`isCurrentSuperState(java.lang.Class<? extends StateEngine<?>> superStateClass)` Tests if the current state has the specified super state.
`boolean`	`isStarted()` Tests if this `StateMachine` has been started.
`void`	`onDispose(StateEngine<?> stateEngine)` Invoked when the observed `StateEngine` is being disposed.
`void`	`onError(StateEngine<?> stateEngine, StateEngine.Error error, java.lang.String message)` Invoked when the specified error is deteceted in the observed `StateEngine`.
`void`	`onReset(StateEngine<?> stateEngine)` Invoked when the observed `StateEngine` is resetted.
`void`	`onStart(StateEngine<?> stateEngine)` Invoked when the observed `StateEngine` is started.
`protected void`	`onStateEngineCreated(StateEngine<?> stateEngine)`
`void`	`onStop(StateEngine<?> stateEngine)` Invoked when the observed `StateEngine` is stopped.
`void`	`reset()` Reset this `StateMachine`.
`abstract void`	`start()` Starts this `StateMachine` by starting the concrete implementation of `StateEngine`.
`protected <T extends StateEngine<?>> T`	`start(java.lang.Class<T> initialStateClass)` Starts the concrete implementation of `StateMachine`.
`void`	`stop()` Stops this `StateMachine`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StateMachine
```
protected StateMachine()
```
- Method Detail
  - getStateEngine
```
public final <T extends StateEngine<?>> T getStateEngine()
```
    Gets the StateEngine that is an instance of concrete implementation of a StateEngine code generated by Fuusio FSM Annotation Processor.
    
    Returns:
    
    A StateEngine.
  - getCurrentState
```
public final <T extends StateEngine<?>> T getCurrentState()
```
    Gets the current state StateEngine that is an instance of code generated class.
    
    Returns:
    
    The current state as a StateEngine. May not return null for started state machine.
  - isStarted
```
public boolean isStarted()
```
    Tests if this StateMachine has been started.
    
    Returns:
    
    A boolean value.
  - isCurrentSuperState
```
public boolean isCurrentSuperState(java.lang.Class<? extends StateEngine<?>> superStateClass)
```
    Tests if the current state has the specified super state.
    
    Parameters:
    
    superStateClass - A Class specifying the super state.
    
    Returns:
    
    A boolean value.
  - isCurrentState
```
public boolean isCurrentState(java.lang.Class<? extends StateEngine<?>> stateClass)
```
    Tests if the current state is the specified one.
    
    Parameters:
    
    stateClass - A Class specifying the state.
    
    Returns:
    
    A boolean value.
  - onStateEngineCreated
```
protected void onStateEngineCreated(StateEngine<?> stateEngine)
```
  - createStateEngine
```
protected StateEngine<?> createStateEngine()
```
    Creates the StateEngine. This method can be overridden in concrete implementations, but if not overridden, the default instantiation method will be used.
    
    Returns:
    
    A StateEngine. The default implementation returns null.
  - start
```
protected final <T extends StateEngine<?>> T start(java.lang.Class<T> initialStateClass)
```
    Starts the concrete implementation of StateMachine.
    
    Parameters:
    
    initialStateClass - A Class that implements an initial state for the state machine.
    
    Returns:
    
    The entered state as a class derived from StateEngine.
  - start
```
public abstract void start()
```
    Starts this StateMachine by starting the concrete implementation of StateEngine. The concrete implementation has to override this method and invoke start(Class) method.
  - stop
```
public final void stop()
```
    Stops this StateMachine. A stopped StateMachine can be restarted after resetting it.
  - reset
```
public final void reset()
```
    Reset this StateMachine. A StateMachine can be restarted after resetting.
  - onDispose
```
public void onDispose(StateEngine<?> stateEngine)
```
    Description copied from interface: StateEngineObserver
    
    Invoked when the observed StateEngine is being disposed.
    
    Specified by:
    
    onDispose in interface StateEngineObserver
    
    Parameters:
    
    stateEngine - The observed StateEngine.
  - onError
```
public void onError(StateEngine<?> stateEngine,
                    StateEngine.Error error,
                    java.lang.String message)
```
    Description copied from interface: StateEngineObserver
    
    Invoked when the specified error is deteceted in the observed StateEngine.
    
    Specified by:
    
    onError in interface StateEngineObserver
    
    Parameters:
    
    stateEngine - The observed StateEngine.
    
    error - An Error.
    
    message - A error message.
  - onReset
```
public void onReset(StateEngine<?> stateEngine)
```
    Description copied from interface: StateEngineObserver
    
    Invoked when the observed StateEngine is resetted.
    
    Specified by:
    
    onReset in interface StateEngineObserver
    
    Parameters:
    
    stateEngine - The observed StateEngine.
  - onStart
```
public void onStart(StateEngine<?> stateEngine)
```
    Description copied from interface: StateEngineObserver
    
    Invoked when the observed StateEngine is started.
    
    Specified by:
    
    onStart in interface StateEngineObserver
    
    Parameters:
    
    stateEngine - The observed StateEngine.
  - onStop
```
public void onStop(StateEngine<?> stateEngine)
```
    Description copied from interface: StateEngineObserver
    
    Invoked when the observed StateEngine is stopped.
    
    Specified by:
    
    onStop in interface StateEngineObserver
    
    Parameters:
    
    stateEngine - The observed StateEngine.

Class StateMachine

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StateMachine

Method Detail

getStateEngine

getCurrentState

isStarted

isCurrentSuperState

isCurrentState

onStateEngineCreated

createStateEngine

start

start

stop

reset

onDispose

onError

onReset

onStart

onStop