com.github.pnavais.machine.api

Class AbstractNode

java.lang.Object

com.github.pnavais.machine.api.AbstractNode

All Implemented Interfaces:

Mergeable<AbstractNode>, Node

Direct Known Subclasses:

State

public abstract class AbstractNode
extends Object
implements Node, Mergeable<AbstractNode>

Represents an arbitrary node of a given directed graph

Field Summary

Fields

Modifier and Type	Field and Description
protected UUID	id The identifier of the node
protected String	name The shorthand name associated to the node

Constructor Summary

Constructors

Constructor and Description
AbstractNode(@NonNull String name) Constructor with node name

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
UUID	getId() Retrieves the identifier of the node
String	getName() Retrieves the name of the node
int	hashCode()
boolean	isFinal() Retrieves the final state condition flag.
AbstractNode	merge(AbstractNode node) Merges the information of the given node into the current instance.
void	setFinal(boolean finalState) Sets whether the state is final or not.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

protected String name

The shorthand name associated to the node

id

protected final UUID id

The identifier of the node

Constructor Detail

AbstractNode

public AbstractNode(@NonNull
                    @NonNull String name)

Constructor with node name

Parameters:

name - the name of the node

Method Detail

getId

public UUID getId()

Retrieves the identifier of the node

Returns:

the identifier of the node

setFinal

public void setFinal(boolean finalState)

Sets whether the state is final or not.

Parameters:

finalState - the final state flag

isFinal

public boolean isFinal()

Retrieves the final state condition flag. If final, no further transitions can be allowed from this state.

Returns:

the final state flag

getName

public String getName()

Retrieves the name of the node

Specified by:

getName in interface Node

Returns:

the name of the node

merge

public AbstractNode merge(AbstractNode node)

Merges the information of the given node into the current instance.

Specified by:

merge in interface Mergeable<AbstractNode>

Parameters:

node - the node to merge

Returns:

the merged node instance

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object