org.helenus.commons.collections

Interface DirectedGraph.Node<T>

Type Parameters:

T - the type of value

Enclosing interface:

DirectedGraph<T>

public static interface DirectedGraph.Node<T>

The Node interface represents a specific node in this directed graph.

Since:

2.0

Version:

1 - Jan 15, 2015 - paouelle - Creation

Author:

The Helenus Driver Project Authors

Copyright:

2015-2015 The Helenus Driver Project Authors

Method Summary

Modifier and Type	Method and Description
void	add(java.util.stream.Stream<T> dests) Adds the specified destination nodes if missing and add arcs from this node to all the destination ones.
void	add(T dest) Adds the specified destination node if missing and add an arc from this node to the destination one.
void	addEdge(T dest) Adds an arc from this node to the destination one.
static <T extends Comparable<? super T>> Comparator<DirectedGraph.Node<T>>	comparingByValue() Gets a comparator that compares DirectedGraph.Node in natural order on value.
static <T> Comparator<DirectedGraph.Node<T>>	comparingByValue(Comparator<? super T> cmp) Gets a comparator that compares DirectedGraph.Node by value using the given Comparator.
boolean	edgeExists(T dest) Checks if there this node has an edge to another node.
java.util.stream.Stream<DirectedGraph.Node<T>>	edges() Gets a stream of the edge nodes leaving this node.
boolean	equals(Object o)
Set<DirectedGraph.Node<T>>	getEdges() Gets an immutable view of the edge nodes leaving this node.
T	getValue() Gets the value for this node.
int	hashCode()
boolean	removeEdge(T dest) Removes the edge from this node to the specified destination node from the graph.

Method Detail

comparingByValue

static <T extends Comparable<? super T>> Comparator<DirectedGraph.Node<T>> comparingByValue()

Gets a comparator that compares DirectedGraph.Node in natural order on value.

The returned comparator is serializable and throws NullPointerException when comparing a node with a null value.

Type Parameters:

T - the type of elements in this graph

Returns:

a comparator that compares DirectedGraph.Node in natural order on value

See Also:

Comparable

comparingByValue

static <T> Comparator<DirectedGraph.Node<T>> comparingByValue(Comparator<? super T> cmp)

Gets a comparator that compares DirectedGraph.Node by value using the given Comparator.

The returned comparator is serializable if the specified comparator is also serializable.

Type Parameters:

T - the type of elements in this graph

Parameters:

cmp - the value Comparator

Returns:

a comparator that compares DirectedGraph.Node by the value

getValue

T getValue()

Gets the value for this node.

Returns:

this node's value

edgeExists

boolean edgeExists(T dest)

Checks if there this node has an edge to another node.

Parameters:

dest - the destination node

Returns:

true if an edge exists from this node to dest; falseotherwise

Throws:

NoSuchElementException - if the destination node does not exist

getEdges

Set<DirectedGraph.Node<T>> getEdges()

Gets an immutable view of the edge nodes leaving this node.

Returns:

an immutable view of the edge nodes leaving this node

edges

java.util.stream.Stream<DirectedGraph.Node<T>> edges()

Gets a stream of the edge nodes leaving this node.

Returns:

a stream of the edge nodes leaving this node

add

void add(T dest)

Adds the specified destination node if missing and add an arc from this node to the destination one.

Parameters:

dest - the destination node

add

void add(java.util.stream.Stream<T> dests)

Adds the specified destination nodes if missing and add arcs from this node to all the destination ones.

Parameters:

dests - the destination nodes

addEdge

void addEdge(T dest)

Adds an arc from this node to the destination one. If an arc already exists, this operation is a no-op.

Parameters:

dest - the destination node

Throws:

NoSuchElementException - if the destination node does not exist

removeEdge

boolean removeEdge(T dest)

Removes the edge from this node to the specified destination node from the graph.

Parameters:

dest - the destination node

Returns:

true if an edge was removed; false otherwise

Throws:

NoSuchElementException - if the destination node does not exist

hashCode

int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

boolean equals(Object o)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)