StateTransitionMap (state-machine 1.2.0 API)

java.lang.Object
- com.github.pnavais.machine.impl.StateTransitionMap

All Implemented Interfaces:

TransitionIndex<State,Message,StateTransition>
```
public class StateTransitionMap
extends Object
implements TransitionIndex<State,Message,StateTransition>
```
The State Machine contains a simple map of Transitions between different nodes (States) triggered by incoming messages. This transition index is implemented as a map using as key the source of the transition and as key another map containing the association between messages and destination states.
For example, the transition [ A -- m --> B ] would be stored in a map as represented in the table below :
```
 Key    | Transitions
 --------------------
 A      | [ m ->  B ]
 B      | []
 
```
It is important to note that target states will be also stored as key in the transitions map. In case a new transition from A is added , [ A --- n ---> C ] , the transitions would be updated as :
```
 Key    | Transitions
 --------------------
 A      | [ m ->  B,  n ->  C ]
 B      | []
 C      | []
 
```
In case a transition is added from this state using the same message [ A --- m ---> C, the transition map would be updated as follows :
```
 Key    | Transitions
 --------------------
 A      | [ m ->  C,  n ->  C ]
 B      | []
 C      | []
 
```
After this operation State B is not reachable

Constructor Summary

Constructors
Constructor and Description
`StateTransitionMap()` Creates the state machine.
`StateTransitionMap(@NonNull Map<State,Map<Message,State>> transitionMap)` Creates the state machine with a given transition map.
`StateTransitionMap(@NonNull Map<State,Map<Message,State>> transitionMap, @NonNull TransitionValidator<State,Message,StateTransition> transitionValidator)` Creates the state machine with a custom transition map and validator.
`StateTransitionMap(@NonNull TransitionValidator<State,Message,StateTransition> transitionValidator)` Creates the state machine with a custom transition validator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(StateTransition transition)` Adds a new Transition to the statemachine.
`void`	`addAll(@NonNull Collection<StateTransition> transitions)` Adds all supplied transitions to the index.
`void`	`clear()` Clear all states and transitions from the map
`boolean`	`contains(@NonNull State state)` Checks the presence of the given state in the index.
`boolean`	`contains(@NonNull StateTransition transition)` Checks the presence of the given transition in the index.
`Optional<State>`	`find(String stateName)` Finds the given state by its name.
`Collection<StateTransition>`	`getAllTransitions()` Retrieve all the transitions stored in the transition map.
`Optional<State>`	`getFirst()` Retrieves the first state in the transition map
`Optional<State>`	`getNext(@NonNull State source, @NonNull Message m)` Retrieves the next state in the transition from source state upon message m reception
`Optional<State>`	`getPrevious(State source, Message m)` Retrieves the previous node upon reception of the message on the given source node.
`Collection<StateTransition>`	`getTransitions(State state)` Retrieves the transitions from the given state or throws a `NullStateException` if not found.
`Collection<StateTransition>`	`getTransitions(String stateName)` Retrieves the transitions from the given state or throws a `NullStateException` if not found.
`Map<State,Map<Message,State>>`	`getTransitionsAsMap()` Retrieves the transitions as a map
`List<State>`	`prune()` Remove orphan states from the transition map i.e.
`void`	`remove(@NonNull State state)` Removes the current state from the machine including defined transitions.
`void`	`remove(StateTransition transition)` Removes an existing Transition from the state machine.
`void`	`remove(@NonNull String stateName)` Removes the current state from the machine including defined transitions.
`void`	`removeAllTransitions()` Clear all transitions from the map
`int`	`size()` Retrieves the number of states in the transition map

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

- Constructor Detail
  - StateTransitionMap
```
public StateTransitionMap()
```
    Creates the state machine.
  - StateTransitionMap
```
public StateTransitionMap(@NonNull
                          @NonNull Map<State,Map<Message,State>> transitionMap)
```
    Creates the state machine with a given transition map.
    
    Parameters:
    
    transitionMap - the transition map
  - StateTransitionMap
```
public StateTransitionMap(@NonNull
                          @NonNull TransitionValidator<State,Message,StateTransition> transitionValidator)
```
    Creates the state machine with a custom transition validator.
    
    Parameters:
    
    transitionValidator - transition validator
  - StateTransitionMap
```
public StateTransitionMap(@NonNull
                          @NonNull Map<State,Map<Message,State>> transitionMap,
                          @NonNull
                          @NonNull TransitionValidator<State,Message,StateTransition> transitionValidator)
```
    Creates the state machine with a custom transition map and validator.
    
    Parameters:
    
    transitionMap - the transition map
    
    transitionValidator - transition validator
- Method Detail
  - add
```
public void add(StateTransition transition)
```
    Adds a new Transition to the statemachine. If already present, it is replaced silently i.e if a transition is found from a source state with the input message, the destination is updated by the one given in the transition.
    
    Specified by:
    
    add in interface TransitionIndex<State,Message,StateTransition>
    
    Parameters:
    
    transition - the transition to add
  - remove
```
public void remove(StateTransition transition)
```
    Removes an existing Transition from the state machine. In case the state does not exists is it ignored silently.
    
    Specified by:
    
    remove in interface TransitionIndex<State,Message,StateTransition>
    
    Parameters:
    
    transition - the transition to remove
  - remove
```
public void remove(@NonNull
                   @NonNull State state)
```
    Removes the current state from the machine including defined transitions.
    
    Specified by:
    
    remove in interface TransitionIndex<State,Message,StateTransition>
    
    Parameters:
    
    state - the state to remove
  - remove
```
public void remove(@NonNull
                   @NonNull String stateName)
```
    Removes the current state from the machine including defined transitions.
    
    Specified by:
    
    remove in interface TransitionIndex<State,Message,StateTransition>
    
    Parameters:
    
    stateName - the state to remove
  - removeAllTransitions
```
public void removeAllTransitions()
```
    Clear all transitions from the map
    
    Specified by:
    
    removeAllTransitions in interface TransitionIndex<State,Message,StateTransition>
  - clear
```
public void clear()
```
    Clear all states and transitions from the map
    
    Specified by:
    
    clear in interface TransitionIndex<State,Message,StateTransition>
  - getNext
```
public Optional<State> getNext(@NonNull
                               @NonNull State source,
                               @NonNull
                               @NonNull Message m)
```
    Retrieves the next state in the transition from source state upon message m reception
    
    Specified by:
    
    getNext in interface TransitionIndex<State,Message,StateTransition>
    
    Parameters:
    
    source - the origin state
    
    m - the received message
    
    Returns:
    
    the next state if found or empty otherwise
  - getPrevious
```
public Optional<State> getPrevious(State source,
                                   Message m)
```
    Retrieves the previous node upon reception of the message on the given source node.
    
    Specified by:
    
    getPrevious in interface TransitionIndex<State,Message,StateTransition>
    
    Parameters:
    
    source - the origin node
    
    m - the message
    
    Returns:
    
    the next node if found or empty otherwise
  - find
```
public Optional<State> find(String stateName)
```
    Finds the given state by its name.
    
    Specified by:
    
    find in interface TransitionIndex<State,Message,StateTransition>
    
    Parameters:
    
    stateName - the name of the state
    
    Returns:
    
    the state if found or empty otherwise
  - contains
```
public boolean contains(@NonNull
                        @NonNull State state)
```
    Checks the presence of the given state in the index.
    
    Specified by:
    
    contains in interface TransitionIndex<State,Message,StateTransition>
    
    Parameters:
    
    state - the state to find
    
    Returns:
    
    true if state present, false otherwise
  - contains
```
public boolean contains(@NonNull
                        @NonNull StateTransition transition)
```
    Checks the presence of the given transition in the index.
    
    Specified by:
    
    contains in interface TransitionIndex<State,Message,StateTransition>
    
    Parameters:
    
    transition - the transition to find
    
    Returns:
    
    true if transition present, false otherwise
  - getFirst
```
public Optional<State> getFirst()
```
    Retrieves the first state in the transition map
    
    Specified by:
    
    getFirst in interface TransitionIndex<State,Message,StateTransition>
    
    Returns:
    
    the first state in the transition map
  - size
```
public int size()
```
    Retrieves the number of states in the transition map
    
    Specified by:
    
    size in interface TransitionIndex<State,Message,StateTransition>
    
    Returns:
    
    the number of states in the transition map
  - prune
```
public List<State> prune()
```
    Remove orphan states from the transition map i.e. States with no transitions and not involved in other state transitions.
    
    Specified by:
    
    prune in interface TransitionIndex<State,Message,StateTransition>
    
    Returns:
    
    the list of removed nodes
  - getTransitions
```
public Collection<StateTransition> getTransitions(String stateName)
```
    Retrieves the transitions from the given state or throws a NullStateException if not found.
    
    Specified by:
    
    getTransitions in interface TransitionIndex<State,Message,StateTransition>
    
    Parameters:
    
    stateName - the state's name
    
    Returns:
    
    the transitions
  - getTransitions
```
public Collection<StateTransition> getTransitions(State state)
```
    Retrieves the transitions from the given state or throws a NullStateException if not found.
    
    Specified by:
    
    getTransitions in interface TransitionIndex<State,Message,StateTransition>
    
    Parameters:
    
    state - the state
    
    Returns:
    
    the transitions
  - getTransitionsAsMap
```
public Map<State,Map<Message,State>> getTransitionsAsMap()
```
    Retrieves the transitions as a map
    
    Specified by:
    
    getTransitionsAsMap in interface TransitionIndex<State,Message,StateTransition>
    
    Returns:
    
    the transitions as a map
  - getAllTransitions
```
public Collection<StateTransition> getAllTransitions()
```
    Retrieve all the transitions stored in the transition map.
    
    Specified by:
    
    getAllTransitions in interface TransitionIndex<State,Message,StateTransition>
    
    Returns:
    
    the collection of transitions
  - addAll
```
public void addAll(@NonNull
                   @NonNull Collection<StateTransition> transitions)
```
    Adds all supplied transitions to the index.
    
    Specified by:
    
    addAll in interface TransitionIndex<State,Message,StateTransition>
    
    Parameters:
    
    transitions - the transitions to add

Class StateTransitionMap

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StateTransitionMap

StateTransitionMap

StateTransitionMap

StateTransitionMap

Method Detail

add

remove

remove

remove

removeAllTransitions

clear

getNext

getPrevious

find

contains

contains

getFirst

size

prune

getTransitions

getTransitions

getTransitionsAsMap

getAllTransitions

addAll