com.github.pnavais.machine.api.transition

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

Type Parameters:

N - the type of nodes

M - the type of messages

T - the type of transitions

All Known Implementing Classes:

StateMachine

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

An interface for defining methods common to entities handling transitions between nodes.

Method Summary

Modifier and Type	Method and Description
void	add(T transition) Adds a new transition
void	addAll(Collection<T> transitions) Adds a collection of Transition to the state machine.
void	clear() Removes all transitions from the state machine
Optional<N>	find(String nodeName) Finds the node in the transition associated with the give name.
Collection<T>	getAllTransitions() Retrieves all state transitions currently defined.
N	getCurrent() Retrieves the node of the last transition performed.
Optional<N>	getNext(M m) Retrieves the next node upon transitioning from the current node on message reception.
Collection<N>	getSiblings(String nodeName) Retrieves the adjacent nodes i.e.
Collection<T>	getTransitions(String nodeName) Retrieves the transitions currently defined for the given node.
TransitionIndex<N,M,T>	getTransitionsIndex() Retrieves the transition index used by the transition.
void	init() Performs generic initialization e.g.
Transitioner<N,M,T>	next() Sends an empty message to the transitioner triggering a potential transition in case the current node supports empty messages.
List<N>	prune() Remove orphan nodes.
void	remove(N node) Removes an existing node and all its transitions.
void	remove(String nodeName) Removes a node matching the given name and allits transitions
void	remove(T transition) Removes an existing transition
void	removeAllTransitions() Removes all existing Transitions from the state machine.
Transitioner<N,M,T>	send(M message) Sends a message to the transitioner triggering a potential transition.
void	setCurrent(String nodeName) Sets the current node to the one supplied by the the given name.
int	size() Retrieves the number of nodes currently handled by the transition.

Method Detail

add

void add(T transition)

Adds a new transition

Parameters:

transition - the transition to add

addAll

void addAll(Collection<T> transitions)

Adds a collection of Transition to the state machine.

Parameters:

transitions - the transitions to add

remove

void remove(T transition)

Removes an existing transition

Parameters:

transition - the transition to remove

remove

void remove(String nodeName)

Removes a node matching the given name and allits transitions

Parameters:

nodeName - the node mame to remove

remove

void remove(N node)

Removes an existing node and all its transitions.

Parameters:

node - the node to remove

removeAllTransitions

void removeAllTransitions()

Removes all existing Transitions from the state machine.

clear

void clear()

Removes all transitions from the state machine

find

Optional<N> find(String nodeName)

Finds the node in the transition associated with the give name.

Parameters:

nodeName - the node's name

Returns:

the node with the given name

init

void init()

Performs generic initialization e.g. setting the initial node.

setCurrent

void setCurrent(String nodeName)

Sets the current node to the one supplied by the the given name.

Parameters:

nodeName - the node's name

getCurrent

N getCurrent()

Retrieves the node of the last transition performed.

Returns:

the current node

getNext

Optional<N> getNext(M m)

Retrieves the next node upon transitioning from the current node on message reception.

Parameters:

m - the message

Returns:

the next node

next

Transitioner<N,M,T> next()

Sends an empty message to the transitioner triggering a potential transition in case the current node supports empty messages.

Returns:

the Transitioner instance for chaining purposes

send

Transitioner<N,M,T> send(M message)

Sends a message to the transitioner triggering a potential transition.

Parameters:

message - the message

Returns:

the transitioner for chaining purposes

size

int size()

Retrieves the number of nodes currently handled by the transition.

Returns:

the number of elements

getTransitions

Collection<T> getTransitions(String nodeName)

Retrieves the transitions currently defined for the given node.

Parameters:

nodeName - the node's name

Returns:

the transitions for the given node

getSiblings

Collection<N> getSiblings(String nodeName)

Retrieves the adjacent nodes i.e. the nodes that can be reached from the given node by any transition.

Parameters:

nodeName - the node's name

Returns:

the adjacent nodes

getAllTransitions

Collection<T> getAllTransitions()

Retrieves all state transitions currently defined.

Returns:

all defined transitions

getTransitionsIndex

TransitionIndex<N,M,T> getTransitionsIndex()

Retrieves the transition index used by the transition.

Returns:

the transition index

prune

List<N> prune()

Remove orphan nodes. i.e. With no transitions and involved in no other node transitions.

Returns:

the list of removed nodes