org.helenus.commons.collections.graph

Class ConcurrentHashDirectedGraph<T>

java.lang.Object

org.helenus.commons.collections.graph.ConcurrentHashDirectedGraph<T>

Type Parameters:

T - the type of elements in this graph

All Implemented Interfaces:

Serializable, Cloneable, Iterable<T>, Collection<T>, Set<T>, DirectedGraph<T>

public class ConcurrentHashDirectedGraph<T>
extends Object
implements DirectedGraph<T>, Cloneable, Serializable

The ConcurrentHashDirectedGraph class provides an implementation of the DirectedGraph interface that uses a ConcurrentHashMap to keep track of the graph.

Since:

2.0

Version:

1 - Jan 15, 2015 - paouelle - Creation

Author:

The Helenus Driver Project Authors

See Also:

Serialized Form

Copyright:

2015-2015 The Helenus Driver Project Authors

Nested Class Summary

Nested classes/interfaces inherited from interface org.helenus.commons.collections.DirectedGraph

DirectedGraph.Node<T>

Constructor Summary

Constructors

Constructor and Description
ConcurrentHashDirectedGraph() Instantiates a new ConcurrentHashDirectedGraph object with the default initial capacity (16) and the default load factor (0.75).
ConcurrentHashDirectedGraph(int initialCapacity) Instantiates a new ConcurrentHashDirectedGraph object with the specified initial capacity and the default load factor (0.75).
ConcurrentHashDirectedGraph(int initialCapacity, float loadFactor) Instantiates a new ConcurrentHashDirectedGraph object with the specified initial capacity and load factor.

Method Summary

Modifier and Type	Method and Description
boolean	add(T e)
void	add(T start, java.util.stream.Stream<T> dests) Adds the specified nodes if they don't exist in the graph and build arcs from the starting node to all the destination ones.
void	add(T start, T dest) Adds the specified nodes if they don't exist in the graph and build an arc from the starting node to the destination one.
boolean	addAll(Collection<? extends T> c)
void	addEdge(T start, T dest) Adds an arc from the starting node to the destination one.
void	clear()
Object	clone() Returns a shallow copy of this ConcurrentHashDirectedGraph instance: the values themselves are not cloned.
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	edgeExists(T start, T dest) Given two nodes in the graph, returns whether there is an edge from the first node to the second node.
java.util.stream.Stream<T>	edgesFrom(T node) Given a node in the graph, returns a stream of the edges leaving that node.
boolean	equals(Object obj)
void	forEach(java.util.function.Consumer<? super T> action)
DirectedGraph.Node<T>	get(T val) Gets a node from this graph given its value.
Set<T>	getEdgesFrom(T node) Given a node in the graph, returns an immutable view of the edges leaving that node as a set of endpoints.
int	hashCode()
boolean	isEmpty()
Iterator<T>	iterator()
Set<DirectedGraph.Node<T>>	nodeSet() Gets a Set view of all the nodes contained in this directed graph.
java.util.stream.Stream<T>	parallelStream()
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	removeEdge(T start, T dest) Removes the edge from the specified starting node to the specified destination node from the graph.
boolean	retainAll(Collection<?> c)
int	size()
java.util.stream.Stream<T>	stream()
Object[]	toArray()
<A> A[]	toArray(A[] a)
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

spliterator

Methods inherited from interface java.util.Collection

removeIf

Constructor Detail

ConcurrentHashDirectedGraph

public ConcurrentHashDirectedGraph()

Instantiates a new ConcurrentHashDirectedGraph object with the default initial capacity (16) and the default load factor (0.75).

ConcurrentHashDirectedGraph

public ConcurrentHashDirectedGraph(int initialCapacity)

Instantiates a new ConcurrentHashDirectedGraph object with the specified initial capacity and the default load factor (0.75).

Parameters:

initialCapacity - the initial capacity

Throws:

IllegalArgumentException - if the initial capacity is negative

ConcurrentHashDirectedGraph

public ConcurrentHashDirectedGraph(int initialCapacity,
                                   float loadFactor)

Instantiates a new ConcurrentHashDirectedGraph object with the specified initial capacity and load factor.

Parameters:

initialCapacity - the initial capacity

loadFactor - he load factor

Throws:

IllegalArgumentException - if the initial capacity is negative or the load factor is non-positive

Method Detail

size

public int size()

Specified by:

size in interface Collection<T>

Specified by:

size in interface Set<T>

See Also:

Set.size()

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface Set<T>

See Also:

Set.isEmpty()

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface Set<T>

See Also:

Set.contains(java.lang.Object)

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Set<T>

See Also:

Set.iterator()

stream

public java.util.stream.Stream<T> stream()

Specified by:

stream in interface Collection<T>

See Also:

Collection.stream()

parallelStream

public java.util.stream.Stream<T> parallelStream()

Specified by:

parallelStream in interface Collection<T>

See Also:

Collection.parallelStream()

forEach

public void forEach(java.util.function.Consumer<? super T> action)

Specified by:

forEach in interface Iterable<T>

See Also:

Iterable.forEach(java.util.function.Consumer)

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface Set<T>

See Also:

Set.toArray()

toArray

public <A> A[] toArray(A[] a)

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface Set<T>

See Also:

Set.toArray(java.lang.Object[])

get

public DirectedGraph.Node<T> get(T val)

Gets a node from this graph given its value.

Specified by:

get in interface DirectedGraph<T>

Parameters:

val - the value for the node to retrieve

Returns:

the corresponding node from this graph or null if the graph doesn't contain a node with the specified value

See Also:

DirectedGraph.get(java.lang.Object)

add

public boolean add(T e)

Specified by:

add in interface Collection<T>

Specified by:

add in interface Set<T>

See Also:

Set.add(java.lang.Object)

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface Set<T>

See Also:

Set.remove(java.lang.Object)

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T>

Specified by:

containsAll in interface Set<T>

See Also:

Set.containsAll(java.util.Collection)

addAll

public boolean addAll(Collection<? extends T> c)

Specified by:

addAll in interface Collection<T>

Specified by:

addAll in interface Set<T>

See Also:

Set.addAll(java.util.Collection)

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<T>

Specified by:

retainAll in interface Set<T>

See Also:

Set.retainAll(java.util.Collection)

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<T>

Specified by:

removeAll in interface Set<T>

See Also:

Set.removeAll(java.util.Collection)

clear

public void clear()

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface Set<T>

See Also:

Set.clear()

nodeSet

public Set<DirectedGraph.Node<T>> nodeSet()

Gets a Set view of all the nodes contained in this directed graph.

The set is backed by the graph, so changes to the graph are reflected in the set, and vice-versa. If the graph is modified while an iteration over the set is in progress (except through the iterator's own remove() operation, or through the addEdge() or removeEdge() operations on a graph node returned by the iterator) the results of the iteration are undefined. The set supports node removal, which removes the corresponding node from the graph, via the Iterator.remove(), Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Specified by:

nodeSet in interface DirectedGraph<T>

Returns:

a set view of the nodes contained in this graph

See Also:

DirectedGraph.nodeSet()

add

public void add(T start,
                T dest)

Adds the specified nodes if they don't exist in the graph and build an arc from the starting node to the destination one.

Specified by:

add in interface DirectedGraph<T>

Parameters:

start - the starting node

dest - the destination node

See Also:

DirectedGraph.add(java.lang.Object, java.lang.Object)

add

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

Adds the specified nodes if they don't exist in the graph and build arcs from the starting node to all the destination ones.

Specified by:

add in interface DirectedGraph<T>

Parameters:

start - the starting node

dests - the destination nodes

See Also:

DirectedGraph.add(java.lang.Object, java.util.stream.Stream)

addEdge

public void addEdge(T start,
                    T dest)

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

Specified by:

addEdge in interface DirectedGraph<T>

Parameters:

start - the starting node

dest - the destination node

See Also:

DirectedGraph.addEdge(java.lang.Object, java.lang.Object)

removeEdge

public boolean removeEdge(T start,
                          T dest)

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

Specified by:

removeEdge in interface DirectedGraph<T>

Parameters:

start - the starting node

dest - the destination node

Returns:

true if an edge was removed; false otherwise

See Also:

DirectedGraph.removeEdge(java.lang.Object, java.lang.Object)

edgeExists

public boolean edgeExists(T start,
                          T dest)

Given two nodes in the graph, returns whether there is an edge from the first node to the second node.

Specified by:

edgeExists in interface DirectedGraph<T>

Parameters:

start - the starting node

dest - the destination node

Returns:

true if an edge exists from start to dest; falseotherwise

See Also:

DirectedGraph.edgeExists(java.lang.Object, java.lang.Object)

edgesFrom

public java.util.stream.Stream<T> edgesFrom(T node)

Given a node in the graph, returns a stream of the edges leaving that node.

Specified by:

edgesFrom in interface DirectedGraph<T>

Parameters:

node - the node whose edges should be queried

Returns:

a stream of the edges leaving that node

See Also:

DirectedGraph.edgesFrom(java.lang.Object)

getEdgesFrom

public Set<T> getEdgesFrom(T node)

Given a node in the graph, returns an immutable view of the edges leaving that node as a set of endpoints.

Specified by:

getEdgesFrom in interface DirectedGraph<T>

Parameters:

node - the node whose edges should be queried

Returns:

an immutable view of the edges leaving that node

See Also:

DirectedGraph.getEdgesFrom(java.lang.Object)

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<T>

Specified by:

hashCode in interface Set<T>

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<T>

Specified by:

equals in interface Set<T>

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

clone

public Object clone()

Returns a shallow copy of this ConcurrentHashDirectedGraph instance: the values themselves are not cloned.

Overrides:

clone in class Object

Returns:

a shallow copy of this graph

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()