DefaultStateMachine (fxgl 0.4.2 API)

java.lang.Object
- com.almasb.fxgl.ai.fsm.DefaultStateMachine<E,S>

Type Parameters:

E - the type of the entity owning this state machine

S - the type of the states of this state machine

All Implemented Interfaces:

StateMachine<E,S>, Telegraph

Direct Known Subclasses:

StackStateMachine
```
public class DefaultStateMachine<E,S extends State<E>>
extends Object
implements StateMachine<E,S>
```
Default implementation of the StateMachine interface.

Author:

davebaol

Field Summary

Fields
Modifier and Type	Field and Description
`protected S`	`currentState` The current state the owner is in.
`protected S`	`globalState` The global state of the owner.
`protected E`	`owner` The entity that owns this state machine.
`protected S`	`previousState` The last state the owner was in.

Constructor Summary

Constructors
Constructor and Description
`DefaultStateMachine()` Creates a `DefaultStateMachine` with no owner, initial state and global state.
`DefaultStateMachine(E owner)` Creates a `DefaultStateMachine` for the specified owner.
`DefaultStateMachine(E owner, S initialState)` Creates a `DefaultStateMachine` for the specified owner and initial state.
`DefaultStateMachine(E owner, S initialState, S globalState)` Creates a `DefaultStateMachine` for the specified owner, initial state and global state.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`changeState(S newState)` Performs a transition to the specified state.
`S`	`getCurrentState()` Returns the current state of this state machine.
`S`	`getGlobalState()` Returns the global state of this state machine.
`E`	`getOwner()` Returns the owner of this state machine.
`S`	`getPreviousState()` Returns the last state of this state machine.
`boolean`	`handleMessage(Telegram telegram)` Handles received telegrams.
`boolean`	`isInState(S state)` Indicates whether the state machine is in the given state.
`boolean`	`revertToPreviousState()` Changes the state back to the previous state.
`void`	`setGlobalState(S state)` Sets the global state of this state machine.
`void`	`setInitialState(S state)` Sets the initial state of this state machine.
`void`	`setOwner(E owner)` Sets the owner of this state machine.
`void`	`update()` Updates the state machine by invoking first the `execute` method of the global state (if any) then the `execute` method of the current state.

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

- Field Detail
  - owner
```
protected E owner
```
    The entity that owns this state machine.
  - currentState
```
protected S extends State<E> currentState
```
    The current state the owner is in.
  - previousState
```
protected S extends State<E> previousState
```
    The last state the owner was in.
  - globalState
```
protected S extends State<E> globalState
```
    The global state of the owner. Its logic is called every time the FSM is updated.
- Constructor Detail
  - DefaultStateMachine
```
public DefaultStateMachine()
```
    Creates a DefaultStateMachine with no owner, initial state and global state.
  - DefaultStateMachine
```
public DefaultStateMachine(E owner)
```
    Creates a DefaultStateMachine for the specified owner.
    
    Parameters:
    
    owner - the owner of the state machine
  - DefaultStateMachine
```
public DefaultStateMachine(E owner,
                           S initialState)
```
    Creates a DefaultStateMachine for the specified owner and initial state.
    
    Parameters:
    
    owner - the owner of the state machine
    
    initialState - the initial state
  - DefaultStateMachine
```
public DefaultStateMachine(E owner,
                           S initialState,
                           S globalState)
```
    Creates a DefaultStateMachine for the specified owner, initial state and global state.
    
    Parameters:
    
    owner - the owner of the state machine
    
    initialState - the initial state
    
    globalState - the global state
- Method Detail
  - getOwner
```
public E getOwner()
```
    Returns the owner of this state machine.
  - setOwner
```
public void setOwner(E owner)
```
    Sets the owner of this state machine.
    
    Parameters:
    
    owner - the owner.
  - setInitialState
```
public void setInitialState(S state)
```
    Description copied from interface: StateMachine
    
    Sets the initial state of this state machine.
    
    Specified by:
    
    setInitialState in interface StateMachine<E,S extends State<E>>
    
    Parameters:
    
    state - the initial state.
  - setGlobalState
```
public void setGlobalState(S state)
```
    Description copied from interface: StateMachine
    
    Sets the global state of this state machine.
    
    Specified by:
    
    setGlobalState in interface StateMachine<E,S extends State<E>>
    
    Parameters:
    
    state - the global state.
  - getCurrentState
```
public S getCurrentState()
```
    Description copied from interface: StateMachine
    
    Returns the current state of this state machine.
    
    Specified by:
    
    getCurrentState in interface StateMachine<E,S extends State<E>>
  - getGlobalState
```
public S getGlobalState()
```
    Description copied from interface: StateMachine
    
    Returns the global state of this state machine.
    Implementation classes should invoke the update method of the global state every time the FSM is updated. Also, they should never invoke its enter and exit method.
    
    Specified by:
    
    getGlobalState in interface StateMachine<E,S extends State<E>>
  - getPreviousState
```
public S getPreviousState()
```
    Description copied from interface: StateMachine
    
    Returns the last state of this state machine.
    
    Specified by:
    
    getPreviousState in interface StateMachine<E,S extends State<E>>
  - update
```
public void update()
```
    Updates the state machine by invoking first the execute method of the global state (if any) then the execute method of the current state.
    
    Specified by:
    
    update in interface StateMachine<E,S extends State<E>>
  - changeState
```
public void changeState(S newState)
```
    Description copied from interface: StateMachine
    
    Performs a transition to the specified state.
    
    Specified by:
    
    changeState in interface StateMachine<E,S extends State<E>>
    
    Parameters:
    
    newState - the state to transition to
  - revertToPreviousState
```
public boolean revertToPreviousState()
```
    Description copied from interface: StateMachine
    
    Changes the state back to the previous state.
    
    Specified by:
    
    revertToPreviousState in interface StateMachine<E,S extends State<E>>
    
    Returns:
    
    true in case there was a previous state that we were able to revert to. In case there is no previous state, no state change occurs and false will be returned.
  - isInState
```
public boolean isInState(S state)
```
    Indicates whether the state machine is in the given state.
    This implementation assumes states are singletons (typically an enum) so they are compared with the == operator instead of the equals method.
    
    Specified by:
    
    isInState in interface StateMachine<E,S extends State<E>>
    
    Parameters:
    
    state - the state to be compared with the current state
    
    Returns:
    
    true if the current state and the given state are the same object.
  - handleMessage
```
public boolean handleMessage(Telegram telegram)
```
    Handles received telegrams. The telegram is first routed to the current state. If the current state does not deal with the message, it's routed to the global state's message handler.
    
    Specified by:
    
    handleMessage in interface StateMachine<E,S extends State<E>>
    
    Specified by:
    
    handleMessage in interface Telegraph
    
    Parameters:
    
    telegram - the received telegram
    
    Returns:
    
    true if telegram has been successfully handled; false otherwise.

Class DefaultStateMachine<E,S extends State<E>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

owner

currentState

previousState

globalState

Constructor Detail

DefaultStateMachine

DefaultStateMachine

DefaultStateMachine

DefaultStateMachine

Method Detail

getOwner

setOwner

setInitialState

setGlobalState

getCurrentState

getGlobalState

getPreviousState

update

changeState

revertToPreviousState

isInState

handleMessage