Class ImmutableGraph<N>
 java.lang.Object

 com.google.common.graph.AbstractGraph<N>

 com.google.common.graph.ImmutableGraph<N>

 Type Parameters:
N
 Node parameter type
 All Implemented Interfaces:
Graph<N>
,PredecessorsFunction<N>
,SuccessorsFunction<N>
@Beta @Immutable(containerOf="N") public class ImmutableGraph<N> extends AbstractGraph<N>
AGraph
whose elements and structural relationships will never change. Instances of this class may be obtained withcopyOf(Graph)
.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, Joshua O'Madadhain, Omar Darwish, Jens Nyman


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

Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Set<N>
adjacentNodes(N node)
Returns 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).static <N> ImmutableGraph<N>
copyOf(Graph<N> graph)
Returns an immutable copy ofgraph
.static <N> ImmutableGraph<N>
copyOf(ImmutableGraph<N> graph)
Deprecated.no need to use thisint
degree(N node)
Returns the count ofnode
's incident edges, counting selfloops twice (equivalently, the number of times an edge touchesnode
).protected long
edgeCount()
Defer toBaseGraph.edges()
(based onGraph.successors(Object)
) for full edges() implementation.Set<EndpointPair<N>>
edges()
An implementation ofBaseGraph.edges()
defined in terms ofnodes()
andSuccessorsFunction.successors(Object)
.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 ofGraph.edges()
,Graph.adjacentNodes(Object)
,Graph.predecessors(Object)
,Graph.successors(Object)
andGraph.incidentEdges(Object)
.Set<EndpointPair<N>>
incidentEdges(N node)
Returns the edges in this graph whose endpoints includenode
.int
inDegree(N node)
Returns the count ofnode
's incoming edges (equal topredecessors(node).size()
) in a directed graph.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.ElementOrder<N>
nodeOrder()
Returns the order of iteration for the elements ofGraph.nodes()
.Set<N>
nodes()
Returns all nodes in this graph, in the order specified byGraph.nodeOrder()
.int
outDegree(N node)
Returns the count ofnode
's outgoing edges (equal tosuccessors(node).size()
) in a directed graph.Set<N>
predecessors(N node)
Returns all nodes in this graph adjacent tonode
which can be reached by traversingnode
's incoming edges against the direction (if any) of the edge.Set<N>
successors(N node)
Returns 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.AbstractGraph
equals, hashCode, toString




Method Detail

copyOf
public static <N> ImmutableGraph<N> copyOf(Graph<N> graph)
Returns an immutable copy ofgraph
.

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

incidentEdgeOrder
public ElementOrder<N> incidentEdgeOrder()
Description copied from interface:Graph
Returns anElementOrder
that specifies the order of iteration for the elements ofGraph.edges()
,Graph.adjacentNodes(Object)
,Graph.predecessors(Object)
,Graph.successors(Object)
andGraph.incidentEdges(Object)
. Specified by:
incidentEdgeOrder
in interfaceGraph<N>

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

edgeCount
protected long edgeCount()
Defer toBaseGraph.edges()
(based onGraph.successors(Object)
) for full edges() implementation.

isDirected
public boolean isDirected()
Description copied from interface:Graph
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:Graph
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:Graph
Returns the order of iteration for the elements ofGraph.nodes()
.

adjacentNodes
public Set<N> adjacentNodes(N node)
Description copied from interface:Graph
Returns the nodes which have an incident edge in common withnode
in this graph.This is equal to the union of
Graph.predecessors(Object)
andGraph.successors(Object)
.

predecessors
public Set<N> predecessors(N node)
Description copied from interface:Graph
Returns 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
Graph.adjacentNodes(Object)
.

successors
public Set<N> successors(N node)
Description copied from interface:Graph
Returns 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
Graph.adjacentNodes(Object)
.This is not the same as "all nodes reachable from
node
by following outgoing edges". For that functionality, seeGraphs.reachableNodes(Graph, Object)
.

incidentEdges
public Set<EndpointPair<N>> incidentEdges(N node)
Description copied from interface:Graph
Returns the edges in this graph whose endpoints includenode
.This is equal to the union of incoming and outgoing edges.
 Specified by:
incidentEdges
in interfaceGraph<N>

degree
public int degree(N node)
Description copied from interface:Graph
Returns the count ofnode
's incident edges, counting selfloops twice (equivalently, the number of times an edge touchesnode
).For directed graphs, this is equal to
inDegree(node) + outDegree(node)
.For undirected graphs, this is equal to
incidentEdges(node).size()
+ (number of selfloops incident tonode
).If the count is greater than
Integer.MAX_VALUE
, returnsInteger.MAX_VALUE
.

inDegree
public int inDegree(N node)
Description copied from interface:Graph
Returns the count ofnode
's incoming edges (equal topredecessors(node).size()
) in a directed graph. In an undirected graph, returns theGraph.degree(Object)
.If the count is greater than
Integer.MAX_VALUE
, returnsInteger.MAX_VALUE
.

outDegree
public int outDegree(N node)
Description copied from interface:Graph
Returns the count ofnode
's outgoing edges (equal tosuccessors(node).size()
) in a directed graph. In an undirected graph, returns theGraph.degree(Object)
.If the count is greater than
Integer.MAX_VALUE
, returnsInteger.MAX_VALUE
.

hasEdgeConnecting
public boolean hasEdgeConnecting(N nodeU, N nodeV)
Description copied from interface:Graph
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 interfaceGraph<N>

hasEdgeConnecting
public boolean hasEdgeConnecting(EndpointPair<N> endpoints)
Description copied from interface:Graph
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 interfaceGraph<N>

edges
public Set<EndpointPair<N>> edges()
An implementation ofBaseGraph.edges()
defined in terms ofnodes()
andSuccessorsFunction.successors(Object)
.

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.

