TerminalState (Interacto Java API 4.2 API)

java.lang.Object
- io.github.interacto.fsm.TerminalState<E>

Type Parameters:

E - The type of events the FSM processes.

All Implemented Interfaces:

InputState<E>, State<E>
```
public class TerminalState<E>
extends Object
implements InputState<E>
```
An FSM state. A terminal state ends normally an FSM.

Field Summary

Fields
Modifier and Type Field Description

protected FSM<E> fsm

protected String name

Constructor Summary

Constructors
Constructor Description

TerminalState(FSM<E> stateMachine, String stateName)
Creates the terminal state.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`enter()`	Actions done while entering this state.
`FSM<E>`	`getFSM()`
`String`	`getName()`
`String`	`toString()`

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

Methods inherited from interface io.github.interacto.fsm.State
checkStartingState, getFSM, getName, uninstall

- Field Detail
  - fsm
```
protected final FSM<E> fsm
```
  - name
```
protected final String name
```
- Constructor Detail
  - TerminalState
```
public TerminalState(FSM<E> stateMachine,
                     String stateName)
```
    Creates the terminal state.
    
    Parameters:
    
    stateMachine - The FSM that will contain the state.
    
    stateName - The name of this state.
- Method Detail
  - enter
```
public void enter()
           throws CancelFSMException
```
    Description copied from interface: InputState
    
    Actions done while entering this state.
    
    Specified by:
    
    enter in interface InputState<E>
    
    Throws:
    
    CancelFSMException - If entering the state leads to a cancelling of the FSM execution.
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface State<E>
    
    Returns:
    
    The name of the state.
  - getFSM
```
public FSM<E> getFSM()
```
    Specified by:
    
    getFSM in interface State<E>
    
    Returns:
    
    The FSM that contains the state.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object