com.github.pnavais.machine.api.transition

Interface TransitionIndex<N extends Node,M extends Message,T extends Transition<N,M>>

Type Parameters:

N - the type of Node

M - the type of Message

T - the type of Transition

All Known Implementing Classes:

StateTransitionMap

public interface TransitionIndex<N extends Node,M extends Message,T extends Transition<N,M>>

An index allowing to store and fetch defined transitions.

Method Summary

Modifier and Type	Method and Description
void	add(T transition) Adds a new transition to the index
void	addAll(@NonNull Collection<T> transitions) Adds all supplied transitions to the index.
void	clear() Removes all nodes and transitions
boolean	contains(N node) Checks the presence of the given node in the index.
boolean	contains(T transition) Checks the presence of the given transition in the index.
Optional<N>	find(String name) Search the given node in the transition index by its name.
Collection<T>	getAllTransitions() Retrieve all transitions stored in the index.
Optional<N>	getFirst() Retrieves the first node in the index
Optional<N>	getNext(N source, M m) Retrieves the next node after applying the message on the given source node.
Optional<N>	getPrevious(N source, M m) Retrieves the previous node upon reception of the message on the given source node.
Collection<T>	getTransitions(N node) Retrieves the transitions stored in the index for the given node.
Collection<T>	getTransitions(String name) Retrieves the transitions stored in the index for the given named node.
Map<N,Map<M,N>>	getTransitionsAsMap() Retrieves the transitions as a map
List<N>	prune() Remove orphan nodes from the index (i.e.
void	remove(N node) Removes an existing node from the index and all its transitions.
void	remove(String node) Removes an existing node from the index and all its transitions by its name.
void	remove(T transition) Removes an existing transition from the index
void	removeAllTransitions() Removes all transitions from the map
int	size() Retrieves the number of elements in the index

Method Detail

add

void add(T transition)

Adds a new transition to the index

Parameters:

transition - the transition to add

addAll

void addAll(@NonNull
            @NonNull Collection<T> transitions)

Adds all supplied transitions to the index.

Parameters:

transitions - the transitions to add

remove

void remove(T transition)

Removes an existing transition from the index

Parameters:

transition - the transition to remove

remove

void remove(N node)

Removes an existing node from the index and all its transitions.

Parameters:

node - the node to remove

remove

void remove(String node)

Removes an existing node from the index and all its transitions by its name.

Parameters:

node - the node to remove

removeAllTransitions

void removeAllTransitions()

Removes all transitions from the map

clear

void clear()

Removes all nodes and transitions

getNext

Optional<N> getNext(N source,
                    M m)

Retrieves the next node after applying the message on the given source node.

Parameters:

source - the origin node

m - the message

Returns:

the next node if found or empty otherwise

getPrevious

Optional<N> getPrevious(N source,
                        M m)

Retrieves the previous node upon reception of the message on the given source node.

Parameters:

source - the origin node

m - the message

Returns:

the next node if found or empty otherwise

find

Optional<N> find(String name)

Search the given node in the transition index by its name.

Parameters:

name - the node's name to search

Returns:

the node found or empty otherwise

contains

boolean contains(N node)

Checks the presence of the given node in the index.

Parameters:

node - the node to find

Returns:

true if node present, false otherwise

contains

boolean contains(T transition)

Checks the presence of the given transition in the index.

Parameters:

transition - the transition to find

Returns:

true if transition present, false otherwise

getFirst

Optional<N> getFirst()

Retrieves the first node in the index

Returns:

the first element in the index or empty otherwise

size

int size()

Retrieves the number of elements in the index

Returns:

the number of elements in the index

prune

List<N> prune()

Remove orphan nodes from the index (i.e. Nodes that are not connected to other nodes by any transition)

Returns:

the list of removed nodes

getTransitions

Collection<T> getTransitions(N node)

Retrieves the transitions stored in the index for the given node.

Parameters:

node - the node

Returns:

the transitions for the node

getTransitions

Collection<T> getTransitions(String name)

Retrieves the transitions stored in the index for the given named node.

Parameters:

name - the node's name

Returns:

the transitions for the node

getAllTransitions

Collection<T> getAllTransitions()

Retrieve all transitions stored in the index.

Returns:

all transitions currently stored in the index

getTransitionsAsMap

Map<N,Map<M,N>> getTransitionsAsMap()

Retrieves the transitions as a map

Returns:

the transition as a map