Class ImmutableValueGraph<N,V>
 java.lang.Object

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

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

 Type Parameters:
N
 Node parameter typeV
 Value parameter type
 All Implemented Interfaces:
PredecessorsFunction<N>
,SuccessorsFunction<N>
,ValueGraph<N,V>
@Beta @Immutable(containerOf={"N","V"}) public final class ImmutableValueGraph<N,V> extends AbstractValueGraph<N,V>
AValueGraph
whose elements and structural relationships will never change. Instances of this class may be obtained withcopyOf(ValueGraph)
.See the Guava User's Guide's discussion of the
Immutable*
types for more information on the properties and guarantees provided by this class. Since:
 20.0
 Author:
 James Sexton, Jens Nyman


Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ImmutableValueGraph.Builder<N,V>
A builder for creatingImmutableValueGraph
instances, especiallystatic final
graphs.

Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.util.Set<N>
adjacentNodes(N node)
Returns a live view of the nodes which have an incident edge in common withnode
in this graph.boolean
allowsSelfLoops()
Returns true if this graph allows selfloops (edges that connect a node to itself).ImmutableGraph<N>
asGraph()
Returns a live view of this graph as aGraph
.static <N,V>
ImmutableValueGraph<N,V>copyOf(ImmutableValueGraph<N,V> graph)
Deprecated.no need to use thisstatic <N,V>
ImmutableValueGraph<N,V>copyOf(ValueGraph<N,V> graph)
Returns an immutable copy ofgraph
.int
degree(N node)
protected long
edgeCount()
Returns the number of edges in this graph; used to calculate the size ofGraph.edges()
.java.util.Set<EndpointPair<N>>
edges()
An implementation ofBaseGraph.edges()
defined in terms ofGraph.nodes()
andSuccessorsFunction.successors(Object)
.V
edgeValueOrDefault(EndpointPair<N> endpoints, V defaultValue)
Returns the value of the edge that connectsendpoints
(in the order, if any, specified byendpoints
), if one is present; otherwise, returnsdefaultValue
.V
edgeValueOrDefault(N nodeU, N nodeV, V defaultValue)
Returns the value of the edge that connectsnodeU
tonodeV
, if one is present; otherwise, returnsdefaultValue
.boolean
hasEdgeConnecting(EndpointPair<N> endpoints)
Returns true if there is an edge that directly connectsendpoints
(in the order, if any, specified byendpoints
).boolean
hasEdgeConnecting(N nodeU, N nodeV)
Returns true if there is an edge that directly connectsnodeU
tonodeV
.ElementOrder<N>
incidentEdgeOrder()
Returns anElementOrder
that specifies the order of iteration for the elements ofValueGraph.edges()
,ValueGraph.adjacentNodes(Object)
,ValueGraph.predecessors(Object)
,ValueGraph.successors(Object)
andValueGraph.incidentEdges(Object)
.java.util.Set<EndpointPair<N>>
incidentEdges(N node)
Returns a live view of the edges in this graph whose endpoints includenode
.int
inDegree(N node)
boolean
isDirected()
Returns true if the edges in this graph are directed.protected boolean
isOrderingCompatible(EndpointPair<?> endpoints)
Returnstrue
iffendpoints
' ordering is compatible with the directionality of this graph.protected <T> java.util.Set<T>
nodeInvalidatableSet(java.util.Set<T> set, N node)
ElementOrder<N>
nodeOrder()
Returns the order of iteration for the elements ofValueGraph.nodes()
.protected <T> java.util.Set<T>
nodePairInvalidatableSet(java.util.Set<T> set, N nodeU, N nodeV)
java.util.Set<N>
nodes()
Returns all nodes in this graph, in the order specified byValueGraph.nodeOrder()
.int
outDegree(N node)
java.util.Set<N>
predecessors(N node)
Returns a live view of all nodes in this graph adjacent tonode
which can be reached by traversingnode
's incoming edges against the direction (if any) of the edge.java.util.Set<N>
successors(N node)
Returns a live view of all nodes in this graph adjacent tonode
which can be reached by traversingnode
's outgoing edges in the direction (if any) of the edge.protected void
validateEndpoints(EndpointPair<?> endpoints)
ThrowsIllegalArgumentException
if the ordering ofendpoints
is not compatible with the directionality of this graph.
Methods inherited from class com.google.common.graph.AbstractValueGraph
edgeValue, edgeValue, equals, hashCode, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.common.graph.ValueGraph
degree, edges, inDegree, outDegree




Method Detail

copyOf
public static <N,V> ImmutableValueGraph<N,V> copyOf(ValueGraph<N,V> graph)
Returns an immutable copy ofgraph
.

copyOf
@Deprecated public static <N,V> ImmutableValueGraph<N,V> copyOf(ImmutableValueGraph<N,V> graph)
Deprecated.no need to use thisSimply returns its argument.

incidentEdgeOrder
public ElementOrder<N> incidentEdgeOrder()
Description copied from interface:ValueGraph
Returns anElementOrder
that specifies the order of iteration for the elements ofValueGraph.edges()
,ValueGraph.adjacentNodes(Object)
,ValueGraph.predecessors(Object)
,ValueGraph.successors(Object)
andValueGraph.incidentEdges(Object)
. Specified by:
incidentEdgeOrder
in interfaceValueGraph<N,V>

asGraph
public ImmutableGraph<N> asGraph()
Description copied from interface:ValueGraph
Returns a live view of this graph as aGraph
. The resultingGraph
will have an edge connecting node A to node B if thisValueGraph
has an edge connecting A to B. Specified by:
asGraph
in interfaceValueGraph<N,V>
 Overrides:
asGraph
in classAbstractValueGraph<N,V>

nodes
public java.util.Set<N> nodes()
Description copied from interface:ValueGraph
Returns all nodes in this graph, in the order specified byValueGraph.nodeOrder()
.

isDirected
public boolean isDirected()
Description copied from interface:ValueGraph
Returns true if the edges in this graph are directed. Directed edges connect asource node
to atarget node
, while undirected edges connect a pair of nodes to each other.

allowsSelfLoops
public boolean allowsSelfLoops()
Description copied from interface:ValueGraph
Returns true if this graph allows selfloops (edges that connect a node to itself). Attempting to add a selfloop to a graph that does not allow them will throw anIllegalArgumentException
.

nodeOrder
public ElementOrder<N> nodeOrder()
Description copied from interface:ValueGraph
Returns the order of iteration for the elements ofValueGraph.nodes()
.

adjacentNodes
public java.util.Set<N> adjacentNodes(N node)
Description copied from interface:ValueGraph
Returns a live view of the nodes which have an incident edge in common withnode
in this graph.This is equal to the union of
ValueGraph.predecessors(Object)
andValueGraph.successors(Object)
.If
node
is removed from the graph after this method is called, theSet
view
returned by this method will be invalidated, and will throwIllegalStateException
if it is accessed in any way, with the following exceptions:view.equals(view)
evaluates totrue
(but any other `equals()` expression involvingview
will throw)hashCode()
does not throw if
node
is readded to the graph after having been removed,view
's behavior is undefined

predecessors
public java.util.Set<N> predecessors(N node)
Description copied from interface:ValueGraph
Returns a live view of all nodes in this graph adjacent tonode
which can be reached by traversingnode
's incoming edges against the direction (if any) of the edge.In an undirected graph, this is equivalent to
ValueGraph.adjacentNodes(Object)
.If
node
is removed from the graph after this method is called, the `Set` returned by this method will be invalidated, and will throw `IllegalStateException` if it is accessed in any way.

successors
public java.util.Set<N> successors(N node)
Description copied from interface:ValueGraph
Returns a live view of all nodes in this graph adjacent tonode
which can be reached by traversingnode
's outgoing edges in the direction (if any) of the edge.In an undirected graph, this is equivalent to
ValueGraph.adjacentNodes(Object)
.This is not the same as "all nodes reachable from
node
by following outgoing edges". For that functionality, seeGraphs.reachableNodes(Graph, Object)
.If
node
is removed from the graph after this method is called, theSet
view
returned by this method will be invalidated, and will throwIllegalStateException
if it is accessed in any way, with the following exceptions:view.equals(view)
evaluates totrue
(but any other `equals()` expression involvingview
will throw)hashCode()
does not throw if
node
is readded to the graph after having been removed,view
's behavior is undefined

incidentEdges
public java.util.Set<EndpointPair<N>> incidentEdges(N node)
Description copied from interface:ValueGraph
Returns a live view of the edges in this graph whose endpoints includenode
.This is equal to the union of incoming and outgoing edges.
If
node
is removed from the graph after this method is called, theSet
view
returned by this method will be invalidated, and will throwIllegalStateException
if it is accessed in any way, with the following exceptions:view.equals(view)
evaluates totrue
(but any other `equals()` expression involvingview
will throw)hashCode()
does not throw if
node
is readded to the graph after having been removed,view
's behavior is undefined
 Specified by:
incidentEdges
in interfaceValueGraph<N,V>

hasEdgeConnecting
public boolean hasEdgeConnecting(N nodeU, N nodeV)
Description copied from interface:ValueGraph
Returns true if there is an edge that directly connectsnodeU
tonodeV
. This is equivalent tonodes().contains(nodeU) && successors(nodeU).contains(nodeV)
.In an undirected graph, this is equal to
hasEdgeConnecting(nodeV, nodeU)
. Specified by:
hasEdgeConnecting
in interfaceValueGraph<N,V>

hasEdgeConnecting
public boolean hasEdgeConnecting(EndpointPair<N> endpoints)
Description copied from interface:ValueGraph
Returns true if there is an edge that directly connectsendpoints
(in the order, if any, specified byendpoints
). This is equivalent toedges().contains(endpoints)
.Unlike the other
EndpointPair
accepting methods, this method does not throw if the endpoints are unordered and the graph is directed; it simply returnsfalse
. This is for consistency with the behavior ofCollection#contains(Object)
(which does not generally throw if the object cannot be present in the collection), and the desire to have this method's behavior be compatible withedges().contains(endpoints)
. Specified by:
hasEdgeConnecting
in interfaceValueGraph<N,V>

edgeValueOrDefault
@CheckForNull public V edgeValueOrDefault(N nodeU, N nodeV, @CheckForNull V defaultValue)
Description copied from interface:ValueGraph
Returns the value of the edge that connectsnodeU
tonodeV
, if one is present; otherwise, returnsdefaultValue
.In an undirected graph, this is equal to
edgeValueOrDefault(nodeV, nodeU, defaultValue)
.

edgeValueOrDefault
@CheckForNull public V edgeValueOrDefault(EndpointPair<N> endpoints, @CheckForNull V defaultValue)
Description copied from interface:ValueGraph
Returns the value of the edge that connectsendpoints
(in the order, if any, specified byendpoints
), if one is present; otherwise, returnsdefaultValue
.If this graph is directed, the endpoints must be ordered.

edgeCount
protected long edgeCount()
Returns the number of edges in this graph; used to calculate the size ofGraph.edges()
. This implementation requires O(N) time. Classes extending this one may manually keep track of the number of edges as the graph is updated, and override this method for better performance.

edges
public java.util.Set<EndpointPair<N>> edges()
An implementation ofBaseGraph.edges()
defined in terms ofGraph.nodes()
andSuccessorsFunction.successors(Object)
.

degree
public int degree(N node)

inDegree
public int inDegree(N node)

outDegree
public int outDegree(N node)

validateEndpoints
protected final void validateEndpoints(EndpointPair<?> endpoints)
ThrowsIllegalArgumentException
if the ordering ofendpoints
is not compatible with the directionality of this graph.

isOrderingCompatible
protected final boolean isOrderingCompatible(EndpointPair<?> endpoints)
Returnstrue
iffendpoints
' ordering is compatible with the directionality of this graph.

nodeInvalidatableSet
protected final <T> java.util.Set<T> nodeInvalidatableSet(java.util.Set<T> set, N node)

nodePairInvalidatableSet
protected final <T> java.util.Set<T> nodePairInvalidatableSet(java.util.Set<T> set, N nodeU, N nodeV)

