Package com.google.common.graph

Class DirectedGraphConnections<N,V>

java.lang.Object

com.google.common.graph.DirectedGraphConnections<N,V>

Type Parameters:

N - Node parameter type

V - Value parameter type

All Implemented Interfaces:

GraphConnections<N,V>

final class DirectedGraphConnections<N,V>
extends java.lang.Object
implements GraphConnections<N,V>

An implementation of GraphConnections for directed graphs.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	DirectedGraphConnections.NodeConnection<N>	A value class representing single connection between the origin node and another node.
private static class	DirectedGraphConnections.PredAndSucc	A wrapper class to indicate a node is both a predecessor and successor while still providing the successor value.

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Map<N,java.lang.Object>	adjacentNodeValues
private java.util.List<DirectedGraphConnections.NodeConnection<N>>	orderedNodeConnections	All node connections in this graph, in edge insertion order.
private static java.lang.Object	PRED
private int	predecessorCount
private int	successorCount

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DirectedGraphConnections(java.util.Map<N,java.lang.Object> adjacentNodeValues, java.util.List<DirectedGraphConnections.NodeConnection<N>> orderedNodeConnections, int predecessorCount, int successorCount)

Method Summary

Modifier and Type	Method	Description
void	addPredecessor(N node, V unused)	Add node as a predecessor to the origin node.
V	addSuccessor(N node, V value)	Add node as a successor to the origin node.
java.util.Set<N>	adjacentNodes()
java.util.Iterator<EndpointPair<N>>	incidentEdgeIterator(N thisNode)	Returns an iterator over the incident edges.
private static boolean	isPredecessor(java.lang.Object value)
private static boolean	isSuccessor(java.lang.Object value)
(package private) static <N,V> DirectedGraphConnections<N,V>	of(ElementOrder<N> incidentEdgeOrder)
(package private) static <N,V> DirectedGraphConnections<N,V>	ofImmutable(N thisNode, java.lang.Iterable<EndpointPair<N>> incidentEdges, Function<N,V> successorNodeToValueFn)
java.util.Set<N>	predecessors()
void	removePredecessor(N node)	Remove node from the set of predecessors.
V	removeSuccessor(java.lang.Object node)	Remove node from the set of successors.
java.util.Set<N>	successors()
V	value(N node)	Returns the value associated with the edge connecting the origin node to node, or null if there is no such edge.

Methods inherited from class java.lang.Object

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

Field Detail

PRED

private static final java.lang.Object PRED

adjacentNodeValues

private final java.util.Map<N,java.lang.Object> adjacentNodeValues

orderedNodeConnections

private final java.util.List<DirectedGraphConnections.NodeConnection<N>> orderedNodeConnections

All node connections in this graph, in edge insertion order.

Note: This field and adjacentNodeValues cannot be combined into a single LinkedHashMap because one target node may be mapped to both a predecessor and a successor. A LinkedHashMap combines two such edges into a single node-value pair, even though the edges may not have been inserted consecutively.

predecessorCount

private int predecessorCount

successorCount

private int successorCount

Constructor Detail

DirectedGraphConnections

private DirectedGraphConnections(java.util.Map<N,java.lang.Object> adjacentNodeValues,
                                 java.util.List<DirectedGraphConnections.NodeConnection<N>> orderedNodeConnections,
                                 int predecessorCount,
                                 int successorCount)

Method Detail

of

static <N,V> DirectedGraphConnections<N,V> of(ElementOrder<N> incidentEdgeOrder)

ofImmutable

static <N,V> DirectedGraphConnections<N,V> ofImmutable(N thisNode,
                                                                   java.lang.Iterable<EndpointPair<N>> incidentEdges,
                                                                   Function<N,V> successorNodeToValueFn)

adjacentNodes

public java.util.Set<N> adjacentNodes()

Specified by:

adjacentNodes in interface GraphConnections<N,V>

predecessors

public java.util.Set<N> predecessors()

Specified by:

predecessors in interface GraphConnections<N,V>

successors

public java.util.Set<N> successors()

Specified by:

successors in interface GraphConnections<N,V>

incidentEdgeIterator

public java.util.Iterator<EndpointPair<N>> incidentEdgeIterator(N thisNode)

Description copied from interface: GraphConnections

Returns an iterator over the incident edges.

Specified by:

incidentEdgeIterator in interface GraphConnections<N,V>

Parameters:

thisNode - The node that this all of the connections in this class are connected to.

value

public V value(N node)

Description copied from interface: GraphConnections

Returns the value associated with the edge connecting the origin node to node, or null if there is no such edge.

Specified by:

value in interface GraphConnections<N,V>

removePredecessor

public void removePredecessor(N node)

Description copied from interface: GraphConnections

Remove node from the set of predecessors.

Specified by:

removePredecessor in interface GraphConnections<N,V>

removeSuccessor

public V removeSuccessor(java.lang.Object node)

Description copied from interface: GraphConnections

Remove node from the set of successors. Returns the value previously associated with the edge connecting the two nodes.

Specified by:

removeSuccessor in interface GraphConnections<N,V>

addPredecessor

public void addPredecessor(N node,
                           V unused)

Description copied from interface: GraphConnections

Add node as a predecessor to the origin node. In the case of an undirected graph, it also becomes a successor. Associates value with the edge connecting the two nodes.

Specified by:

addPredecessor in interface GraphConnections<N,V>

addSuccessor

public V addSuccessor(N node,
                      V value)

Description copied from interface: GraphConnections

Add node as a successor to the origin node. In the case of an undirected graph, it also becomes a predecessor. Associates value with the edge connecting the two nodes. Returns the value previously associated with the edge connecting the two nodes.

Specified by:

addSuccessor in interface GraphConnections<N,V>

isPredecessor

private static boolean isPredecessor(java.lang.Object value)

isSuccessor

private static boolean isSuccessor(java.lang.Object value)