A B C D E F G H I J N O P R S T V W

A

addEdge(TVertex, TVertex) - Method in class jcommon.graph.DirectedAcyclicGraph

addEdge(TVertex, TVertex) - Method in interface jcommon.graph.IGraph

Adds a new IEdge instance to this IGraph.

addEdge(TNumber, TNumber) - Method in class jcommon.graph.NumberGraph

addEdge(TValue, TValue) - Method in class jcommon.graph.ObjectGraph

addEdge(String, String) - Method in class jcommon.graph.StringGraph

addVertex(TVertex) - Method in class jcommon.graph.DirectedAcyclicGraph

addVertex(TVertex) - Method in interface jcommon.graph.IGraph

Adds a new IVertex instance of TVertex to this IGraph.

addVertex(TNumber) - Method in class jcommon.graph.NumberGraph

addVertex(TValue) - Method in class jcommon.graph.ObjectGraph

addVertex(String) - Method in class jcommon.graph.StringGraph

AdjacencyList<TVertex extends IVertex<TValue>,TValue,TProcessedValue> - Class in jcommon.graph.impl

AdjacencyList(Set<TVertex>, Set<IEdge<TVertex>>) - Constructor for class jcommon.graph.impl.AdjacencyList

AdjacencyListPair<TVertex extends IVertex> - Class in jcommon.graph.impl

AdjacencyListPair(TVertex, List<TVertex>) - Constructor for class jcommon.graph.impl.AdjacencyListPair

await() - Method in interface jcommon.graph.ITopologicalSortAsyncResult

Provided for conveniency.

await(long, TimeUnit) - Method in interface jcommon.graph.ITopologicalSortAsyncResult

Provided for conveniency.

awaitUninterruptibly() - Method in interface jcommon.graph.ITopologicalSortAsyncResult

Provided for conveniency.

awaitUninterruptibly(long, TimeUnit) - Method in interface jcommon.graph.ITopologicalSortAsyncResult

Provided for conveniency.

B

build(TVertex...) - Static method in class jcommon.graph.DirectedAcyclicGraph

Convenience method for easily constructing an instance of IGraph with the provided vertices.

buildFromNumbers(TNumber...) - Static method in class jcommon.graph.NumberGraph

buildFromObjects(TValue...) - Static method in class jcommon.graph.ObjectGraph

buildFromStrings(String...) - Static method in class jcommon.graph.StringGraph

C

calculateInDegrees() - Method in interface jcommon.graph.IAdjacencyList

Scans the IAdjacencyList and for each vertex it counts the number of other vertices referencing it.

calculateInDegrees() - Method in class jcommon.graph.impl.AdjacencyList

Calculates an integer array where the value at each index is the number of times that vertex is referenced elsewhere.

contains(TValue) - Method in class jcommon.graph.impl.TopologicalSortInput

contains(TValue) - Method in interface jcommon.graph.ITopologicalSortAsyncResult

Returns a boolean indicating if the results contain a key for the provided value.

contains(TValue) - Method in interface jcommon.graph.ITopologicalSortInput

Returns a boolean indicating if the input contains a key for the provided vertex value.

copy() - Method in class jcommon.graph.DirectedAcyclicGraph

copy() - Method in interface jcommon.graph.IGraph

More type-safe version of Object.clone().

copyAsNumberGraph() - Method in class jcommon.graph.NumberGraph

copyAsObjectGraph() - Method in class jcommon.graph.ObjectGraph

copyAsStringGraph() - Method in class jcommon.graph.StringGraph

create() - Static method in class jcommon.graph.DirectedAcyclicGraph

Convenience method for easily constructing an instance of IGraph with an empty set of vertices.

createForNumbers() - Static method in class jcommon.graph.NumberGraph

createForObjects() - Static method in class jcommon.graph.ObjectGraph

createForStrings() - Static method in class jcommon.graph.StringGraph

createResultMap() - Method in interface jcommon.graph.IAdjacencyList

Creates an instance of a Map that's properly sized for holding a mapping of values to their processed result.

createResultMap() - Method in class jcommon.graph.impl.AdjacencyList

CyclicGraphException - Exception in jcommon.graph

Exception thrown when a cycle has been detected during a topological sort.

CyclicGraphException() - Constructor for exception jcommon.graph.CyclicGraphException

Constructs a new exception with null as its detail message.

CyclicGraphException(String) - Constructor for exception jcommon.graph.CyclicGraphException

Constructs a new exception with the specified detail message.

CyclicGraphException(String, Throwable) - Constructor for exception jcommon.graph.CyclicGraphException

Constructs a new exception with the specified detail message and cause.

CyclicGraphException(Throwable) - Constructor for exception jcommon.graph.CyclicGraphException

Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

D

DirectedAcyclicGraph<TVertex extends IVertex<TValue>,TValue,TProcessedValue> - Class in jcommon.graph

Factory and implementation of a dependency graph that can topologically sort its vertices.

discontinueScheduling() - Method in interface jcommon.graph.ITopologicalSortAsyncResult

Discontinues further scheduling of additional vertices for processing.

discontinueScheduling() - Method in interface jcommon.graph.ITopologicalSortCoordinator

Requests the driver (which is typically done by an instance of ITopologicalSortStrategy) to stop further processing.

E

Edge<TVertex extends IVertex> - Class in jcommon.graph.impl

Edge(TVertex, TVertex) - Constructor for class jcommon.graph.impl.Edge

Create a new directed edge for a graph that defines the relationship between two graph vertices.

EMPTY_VERTICES - Static variable in interface jcommon.graph.IGraph

Reference for an array of empty vertices that can be reused instead of having to allocate a new empty array on the heap every time.

endingValues() - Method in interface jcommon.graph.ITopologicalSortAsyncResult

Returns the list of ending values (values for vertices that have no out neighbors) that generated the result.

equals(Object) - Method in class jcommon.graph.impl.Edge

equals(Object) - Method in class jcommon.graph.ObjectVertex

equals(Object) - Method in class jcommon.graph.Pair

F

first() - Method in class jcommon.graph.impl.TopologicalSortInput

first() - Method in interface jcommon.graph.ITopologicalSortAsyncResult

Retrieves the result for the first ending value.

first() - Method in interface jcommon.graph.ITopologicalSortInput

Retrieves the value of the first provided input.

from - Variable in class jcommon.graph.impl.Edge

The object we are connecting from.

from(TValue) - Static method in class jcommon.graph.ObjectVertex

Convenience method for instantiating a new ObjectVertex.

G

get(TValue) - Method in class jcommon.graph.impl.TopologicalSortInput

get(TValue) - Method in interface jcommon.graph.ITopologicalSortAsyncResult

Gets the result for an ending value.

get(TValue) - Method in interface jcommon.graph.ITopologicalSortInput

Gets the output of an out neighbor vertex value.

get() - Method in interface jcommon.graph.IVertex

Returns the value associated with this IVertex.

get() - Method in class jcommon.graph.ObjectVertex

Retrieves the value that this ObjectVertex represents.

getEdges() - Method in class jcommon.graph.DirectedAcyclicGraph

getEdges() - Method in interface jcommon.graph.IGraph

Retrieves the set of IEdge edges represented by this IGraph.

getEndingVertices() - Method in interface jcommon.graph.IAdjacencyList

Provides a Set that contains vertices who have no out neighbors.

getEndingVertices() - Method in class jcommon.graph.impl.AdjacencyList

getExecutorService() - Method in interface jcommon.graph.ITopologicalSortAsyncResult

Provides a reference to the ExecutorService that asynchronous processing was called with.

getFrom() - Method in interface jcommon.graph.IEdge

Retrieves a reference of IVertex of type TVertex that will begin the edge.

getFrom() - Method in class jcommon.graph.impl.Edge

Retrieves the Edge.from instance.

getOutNeighbors() - Method in interface jcommon.graph.IAdjacencyListPair

The list of out-neighbors for the vertex provided by IAdjacencyListPair.getVertex().

getOutNeighbors() - Method in class jcommon.graph.impl.AdjacencyListPair

getTo() - Method in interface jcommon.graph.IEdge

Retrieves a reference of IVertex of type TVertex that is being pointed to.

getTo() - Method in class jcommon.graph.impl.Edge

Retrieves the Edge.to instance.

getValue() - Method in interface jcommon.graph.IVertex

Returns the value associated with this IVertex.

getValue() - Method in class jcommon.graph.ObjectVertex

Retrieves the value that this ObjectVertex represents.

getValue1() - Method in class jcommon.graph.Pair

Retrieves a reference to the first value provided.

getValue2() - Method in class jcommon.graph.Pair

Retrieves a reference to the second value provided.

getVertex() - Method in interface jcommon.graph.IAdjacencyListPair

The vertex for this pair.

getVertex() - Method in class jcommon.graph.impl.AdjacencyListPair

getVertices() - Method in class jcommon.graph.DirectedAcyclicGraph

getVertices() - Method in interface jcommon.graph.IGraph

Retrieves the set of IVertex vertices of TVertex represented by this IGraph.

H

handle(TValue, ITopologicalSortInput<TValue, TProcessedValue>, IVertex<TValue>, ITopologicalSortCoordinator) - Method in interface jcommon.graph.ITopologicalSortCallback

The callback that will be executed inside a thread other than the one invoking the sort.

handleError(TValue, Throwable, IVertex<TValue>, ITopologicalSortCoordinator) - Method in interface jcommon.graph.ITopologicalSortErrorCallback

The callback that will be executed inside a thread pool other than the one invoking the sort.

hashCode() - Method in class jcommon.graph.impl.Edge

hashCode() - Method in class jcommon.graph.ObjectVertex

hashCode() - Method in class jcommon.graph.Pair

I

IAdjacencyList<TVertex extends IVertex<TValue>,TValue,TProcessedValue> - Interface in jcommon.graph

An adjacency list is essentially an array of size n where A[i] is the list of out-neighbors of node i.

IAdjacencyListPair<TVertex extends IVertex> - Interface in jcommon.graph

Maintains a reference between a IVertex (IAdjacencyListPair.getVertex()) and its out-neighbors (IAdjacencyListPair.getOutNeighbors()).

IEdge<TVertex extends IVertex> - Interface in jcommon.graph

Represents a connection between two instances of IVertex of type TVertex.

IGraph<TVertex extends IVertex<TValue>,TValue,TProcessedValue> - Interface in jcommon.graph

This is a simple graph holding IVertex vertices and IEdge edges connecting them.

indexOf(TVertex) - Method in interface jcommon.graph.IAdjacencyList

Find the index in the IAdjacencyList at which the provided vertex argument can be found.

indexOf(IVertex) - Method in class jcommon.graph.impl.AdjacencyList

inputs() - Method in class jcommon.graph.impl.TopologicalSortInput

inputs() - Method in interface jcommon.graph.ITopologicalSortInput

Generates an instance of Iterable that allows traversing the contents of the input.

isDone() - Method in interface jcommon.graph.ITopologicalSortAsyncResult

Determines if all processing of vertices has completed.

isEmpty() - Method in interface jcommon.graph.IAdjacencyList

Determines if the adjacency list is empty.

isEmpty() - Method in class jcommon.graph.impl.AdjacencyList

isEmpty() - Method in class jcommon.graph.impl.TopologicalSortInput

isEmpty() - Method in interface jcommon.graph.ITopologicalSortAsyncResult

Determines if the results are empty.

isEmpty() - Method in interface jcommon.graph.ITopologicalSortInput

Determines if the input is empty.

isEndingVertex(TVertex) - Method in interface jcommon.graph.IAdjacencyList

Determines if the provided vertex parameter is in the set of ending vertices.

isEndingVertex(TVertex) - Method in class jcommon.graph.impl.AdjacencyList

isProcessingDiscontinued() - Method in interface jcommon.graph.ITopologicalSortAsyncResult

Determines if ITopologicalSortAsyncResult.discontinueScheduling() has been called previously.

isStart() - Method in class jcommon.graph.impl.TopologicalSortInput

isStart() - Method in interface jcommon.graph.ITopologicalSortInput

Indicates if this is a starting vertex (one with an in-degree of zero) we're processing.

isSuccessful() - Method in interface jcommon.graph.ITopologicalSortAsyncResult

Determines if all vertices have been processed without incident.

iterator() - Method in class jcommon.graph.impl.AdjacencyList

ITopologicalSortAsyncResult<TValue,TProcessedValue> - Interface in jcommon.graph

Returned by an asynchronous sort call.

ITopologicalSortCallback<TValue,TProcessedValue> - Interface in jcommon.graph

A callback for when a vertex has been found in topological order.

ITopologicalSortCoordinator - Interface in jcommon.graph

Provides a means for communication with the asynchronous sorting driver (which is typically done by an instance of ITopologicalSortStrategy).

ITopologicalSortErrorCallback<TValue> - Interface in jcommon.graph

A callback for when an error has occurred during asynchronous processing.

ITopologicalSortInput<TValue,TProcessedValue> - Interface in jcommon.graph

Aggregates the output of out neighbor vertices as input to a vertex being processed.

ITopologicalSortStrategy<TVertex extends IVertex<TValue>,TValue,TProcessedValue> - Interface in jcommon.graph

Provides a strategy for implementing a topological sort of an IGraph.

IVertex<TValue> - Interface in jcommon.graph

Marker interface that designates an object as something that can be reasoned about in an IGraph instance.

J

jcommon.graph - package jcommon.graph

Contains the standard API for interfacing with the jcommon-graph library.

jcommon.graph.impl - package jcommon.graph.impl

Contains implementations for key portions of the API.

N

NumberGraph<TNumber extends Number> - Class in jcommon.graph

Factory and implementation of a dependency graph that can topologically sort vertices that are Numbers.

O

ObjectGraph<TValue,TProcessedValue> - Class in jcommon.graph

Factory and implementation of a dependency graph that can topologically sort vertices that are Objects.

ObjectVertex<TValue> - Class in jcommon.graph

A representation of an IVertex instance using Objects.

ObjectVertex(TValue) - Constructor for class jcommon.graph.ObjectVertex

Instantiates a new instance of ObjectVertex.

outNeighborsAt(int) - Method in interface jcommon.graph.IAdjacencyList

Gets the list of out-neighbors for a given vertex of TVertex at the provided index argument.

outNeighborsAt(int) - Method in class jcommon.graph.impl.AdjacencyList

outNeighborsFor(TVertex) - Method in interface jcommon.graph.IAdjacencyList

Gets the list of out-neighbors for a given vertex of TVertex.

outNeighborsFor(TVertex) - Method in class jcommon.graph.impl.AdjacencyList

P

Pair<TValue1,TValue2> - Class in jcommon.graph

Associates two values together.

Pair(TValue1, TValue2) - Constructor for class jcommon.graph.Pair

Creates a new instance of Pair.

pairAt(int) - Method in interface jcommon.graph.IAdjacencyList

Retrieves an instance of IAdjacencyListPair at the specified index.

pairAt(int) - Method in class jcommon.graph.impl.AdjacencyList

R

removeEdge(TVertex, TVertex) - Method in class jcommon.graph.DirectedAcyclicGraph

removeEdge(TVertex, TVertex) - Method in interface jcommon.graph.IGraph

Removes an existing edge from this IGraph.

removeEdge(TNumber, TNumber) - Method in class jcommon.graph.NumberGraph

removeEdge(TValue, TValue) - Method in class jcommon.graph.ObjectGraph

removeEdge(String, String) - Method in class jcommon.graph.StringGraph

removeVertex(TVertex) - Method in class jcommon.graph.DirectedAcyclicGraph

removeVertex(TVertex) - Method in interface jcommon.graph.IGraph

Removes an IVertex instance of TVertex from this IGraph.

removeVertex(TNumber) - Method in class jcommon.graph.NumberGraph

removeVertex(TValue) - Method in class jcommon.graph.ObjectGraph

removeVertex(String) - Method in class jcommon.graph.StringGraph

resultFor(TValue) - Method in interface jcommon.graph.ITopologicalSortAsyncResult

Retrieves the result for an ending value.

results() - Method in interface jcommon.graph.ITopologicalSortAsyncResult

Generates an instance of Iterable that allows traversing the contents of the results.

S

SimpleTopologicalSort<TVertex extends IVertex<TValue>,TValue,TProcessedValue> - Class in jcommon.graph.impl

Implements ITopologicalSortStrategy for doing iterative and concurrent topological sorts.

SimpleTopologicalSort() - Constructor for class jcommon.graph.impl.SimpleTopologicalSort

size() - Method in interface jcommon.graph.IAdjacencyList

The size of the IAdjacencyList.

size() - Method in class jcommon.graph.impl.AdjacencyList

size() - Method in class jcommon.graph.impl.TopologicalSortInput

size() - Method in interface jcommon.graph.ITopologicalSortAsyncResult

The number of returned results.

size() - Method in interface jcommon.graph.ITopologicalSortInput

The size of the ITopologicalSortInput.

sort() - Method in class jcommon.graph.DirectedAcyclicGraph

sort(ITopologicalSortStrategy<TVertex, TValue, TProcessedValue>) - Method in class jcommon.graph.DirectedAcyclicGraph

sort() - Method in interface jcommon.graph.IGraph

Provides a topologically sorted list of IVertex vertices.

sort(ITopologicalSortStrategy<TVertex, TValue, TProcessedValue>) - Method in interface jcommon.graph.IGraph

Provides a topologically sorted list of IVertex vertices.

sort(IAdjacencyList<TVertex, TValue, TProcessedValue>) - Method in class jcommon.graph.impl.SimpleTopologicalSort

sort(IAdjacencyList<TVertex, TValue, TProcessedValue>) - Method in interface jcommon.graph.ITopologicalSortStrategy

Given an instance of IAdjacencyList, topologically sorts the graph.

sortAsync(ITopologicalSortCallback<TValue, TProcessedValue>) - Method in class jcommon.graph.DirectedAcyclicGraph

sortAsync(ITopologicalSortCallback<TValue, TProcessedValue>, ITopologicalSortErrorCallback<TValue>) - Method in class jcommon.graph.DirectedAcyclicGraph

sortAsync(ITopologicalSortStrategy<TVertex, TValue, TProcessedValue>, ITopologicalSortCallback<TValue, TProcessedValue>) - Method in class jcommon.graph.DirectedAcyclicGraph

sortAsync(ITopologicalSortStrategy<TVertex, TValue, TProcessedValue>, ITopologicalSortCallback<TValue, TProcessedValue>, ITopologicalSortErrorCallback<TValue>) - Method in class jcommon.graph.DirectedAcyclicGraph

sortAsync(ExecutorService, ITopologicalSortCallback<TValue, TProcessedValue>) - Method in class jcommon.graph.DirectedAcyclicGraph

sortAsync(ExecutorService, ITopologicalSortCallback<TValue, TProcessedValue>, ITopologicalSortErrorCallback<TValue>) - Method in class jcommon.graph.DirectedAcyclicGraph

sortAsync(ExecutorService, ITopologicalSortStrategy<TVertex, TValue, TProcessedValue>, ITopologicalSortCallback<TValue, TProcessedValue>) - Method in class jcommon.graph.DirectedAcyclicGraph

sortAsync(ExecutorService, ITopologicalSortStrategy<TVertex, TValue, TProcessedValue>, ITopologicalSortCallback<TValue, TProcessedValue>, ITopologicalSortErrorCallback<TValue>) - Method in class jcommon.graph.DirectedAcyclicGraph

sortAsync(ITopologicalSortCallback<TValue, TProcessedValue>) - Method in interface jcommon.graph.IGraph

Allows you to asynchronously and in-parallel process the vertices of a graph topologically.

sortAsync(ITopologicalSortCallback<TValue, TProcessedValue>, ITopologicalSortErrorCallback<TValue>) - Method in interface jcommon.graph.IGraph

Allows you to asynchronously and in-parallel process the vertices of a graph topologically.

sortAsync(ITopologicalSortStrategy<TVertex, TValue, TProcessedValue>, ITopologicalSortCallback<TValue, TProcessedValue>) - Method in interface jcommon.graph.IGraph

Allows you to asynchronously and in-parallel process the vertices of a graph topologically.

sortAsync(ITopologicalSortStrategy<TVertex, TValue, TProcessedValue>, ITopologicalSortCallback<TValue, TProcessedValue>, ITopologicalSortErrorCallback<TValue>) - Method in interface jcommon.graph.IGraph

Allows you to asynchronously and in-parallel process the vertices of a graph topologically.

sortAsync(ExecutorService, ITopologicalSortCallback<TValue, TProcessedValue>) - Method in interface jcommon.graph.IGraph

Allows you to asynchronously and in-parallel process the vertices of a graph topologically.

sortAsync(ExecutorService, ITopologicalSortCallback<TValue, TProcessedValue>, ITopologicalSortErrorCallback<TValue>) - Method in interface jcommon.graph.IGraph

Allows you to asynchronously and in-parallel process the vertices of a graph topologically.

sortAsync(ExecutorService, ITopologicalSortStrategy<TVertex, TValue, TProcessedValue>, ITopologicalSortCallback<TValue, TProcessedValue>) - Method in interface jcommon.graph.IGraph

Allows you to asynchronously and in-parallel process the vertices of a graph topologically.

sortAsync(ExecutorService, ITopologicalSortStrategy<TVertex, TValue, TProcessedValue>, ITopologicalSortCallback<TValue, TProcessedValue>, ITopologicalSortErrorCallback<TValue>) - Method in interface jcommon.graph.IGraph

Allows you to asynchronously and in-parallel process the vertices of a graph topologically.

sortAsync(ExecutorService, IAdjacencyList<TVertex, TValue, TProcessedValue>, ITopologicalSortCallback<TValue, TProcessedValue>, ITopologicalSortErrorCallback<TValue>) - Method in class jcommon.graph.impl.SimpleTopologicalSort

sortAsync(ExecutorService, IAdjacencyList<TVertex, TValue, TProcessedValue>, ITopologicalSortCallback<TValue, TProcessedValue>, ITopologicalSortErrorCallback<TValue>) - Method in interface jcommon.graph.ITopologicalSortStrategy

Allows you to asynchronously and in-parallel process the vertices of a graph topologically.

STANDARD_CYCLE_MESSAGE - Static variable in interface jcommon.graph.ITopologicalSortStrategy

String available for use when throwing CyclicGraphExceptions.

StringGraph - Class in jcommon.graph

Factory and implementation of a dependency graph that can topologically sort vertices that are Strings.

T

to - Variable in class jcommon.graph.impl.Edge

The object we are connecting to.

TopologicalSortInput<TValue,TProcessedValue> - Class in jcommon.graph.impl

TopologicalSortInput(boolean, Map<TValue, TProcessedValue>) - Constructor for class jcommon.graph.impl.TopologicalSortInput

Instantiates a new instance of TopologicalSortInput.

toString() - Method in class jcommon.graph.impl.Edge

toString() - Method in class jcommon.graph.impl.TopologicalSortInput

toString() - Method in class jcommon.graph.ObjectVertex

toString() - Method in class jcommon.graph.Pair

V

validate() - Method in class jcommon.graph.DirectedAcyclicGraph

validate() - Method in interface jcommon.graph.IGraph

Does a simple sanity check on the structure of the graph.

values() - Method in class jcommon.graph.impl.TopologicalSortInput

values() - Method in interface jcommon.graph.ITopologicalSortInput

Returns the set of vertex values that generated the input.

W

waitForCompletion() - Method in interface jcommon.graph.ITopologicalSortAsyncResult

Waits indefinitely and uninterruptibly for the asynchronous sort to signal that it's done processing.

waitForCompletion(long, TimeUnit) - Method in interface jcommon.graph.ITopologicalSortAsyncResult

Waits indefinitely and uninterruptibly for the asynchronous sort to signal that it's done processing.

A B C D E F G H I J N O P R S T V W