ImmutableGraph (Guava: Google Core Libraries for Java 29.0-jre API)

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>
```
@Beta
 @Immutable(containerOf="N")
public class ImmutableGraph<N>
extends AbstractGraph<N>
```
A Graph whose elements and structural relationships will never change. Instances of this class may be obtained with copyOf(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 and Description

static class ImmutableGraph.Builder<N>
A builder for creating ImmutableGraph instances, especially static final graphs.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableGraph.Builder<N>` A builder for creating `ImmutableGraph` instances, especially `static final` graphs.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Set<N>`	`adjacentNodes(N node)` Returns the nodes which have an incident edge in common with `node` in this graph.
`boolean`	`allowsSelfLoops()` Returns true if this graph allows self-loops (edges that connect a node to itself).
`static <N> ImmutableGraph<N>`	`copyOf(Graph<N> graph)` Returns an immutable copy of `graph`.
`static <N> ImmutableGraph<N>`	`copyOf(ImmutableGraph<N> graph)` Deprecated. no need to use this
`int`	`degree(N node)` Returns the count of `node`'s incident edges, counting self-loops twice (equivalently, the number of times an edge touches `node`).
`protected com.google.common.graph.BaseGraph<N>`	`delegate()`
`protected long`	`edgeCount()` Defer to `AbstractBaseGraph.edges()` (based on `successors(Object)`) for full edges() implementation.
`Set<EndpointPair<N>>`	`edges()` An implementation of `BaseGraph.edges()` defined in terms of `nodes()` and `successors(Object)`.
`boolean`	`hasEdgeConnecting(EndpointPair<N> endpoints)` Returns true if there is an edge that directly connects `endpoints` (in the order, if any, specified by `endpoints`).
`boolean`	`hasEdgeConnecting(N nodeU, N nodeV)` Returns true if there is an edge that directly connects `nodeU` to `nodeV`.
`ElementOrder<N>`	`incidentEdgeOrder()` Returns an `ElementOrder` that specifies the order of iteration for the elements of `edges()`, `adjacentNodes(Object)`, `predecessors(Object)`, `successors(Object)` and `incidentEdges(Object)`.
`Set<EndpointPair<N>>`	`incidentEdges(N node)` Returns the edges in this graph whose endpoints include `node`.
`int`	`inDegree(N node)` Returns the count of `node`'s incoming edges (equal to `predecessors(node).size()`) in a directed graph.
`boolean`	`isDirected()` Returns true if the edges in this graph are directed.
`protected boolean`	`isOrderingCompatible(EndpointPair<?> endpoints)`
`ElementOrder<N>`	`nodeOrder()` Returns the order of iteration for the elements of `Graph.nodes()`.
`Set<N>`	`nodes()` Returns all nodes in this graph, in the order specified by `Graph.nodeOrder()`.
`int`	`outDegree(N node)` Returns the count of `node`'s outgoing edges (equal to `successors(node).size()`) in a directed graph.
`Set<N>`	`predecessors(N node)` Returns all nodes in this graph adjacent to `node` which can be reached by traversing `node`'s incoming edges against the direction (if any) of the edge.
`Set<N>`	`successors(N node)` Returns all nodes in this graph adjacent to `node` which can be reached by traversing `node`'s outgoing edges in the direction (if any) of the edge.
`protected void`	`validateEndpoints(EndpointPair<?> endpoints)` Throws `IllegalArgumentException` if the ordering of `endpoints` is not compatible with the directionality of this graph.

Methods inherited from class com.google.common.graph.AbstractGraph
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.Graph
edges

- Method Detail
  - copyOf
```
public static <N> ImmutableGraph<N> copyOf(Graph<N> graph)
```
    Returns an immutable copy of graph.
  - copyOf
```
@Deprecated
public static <N> ImmutableGraph<N> copyOf(ImmutableGraph<N> graph)
```
    Deprecated. no need to use this
    
    Simply returns its argument.
  - incidentEdgeOrder
```
public ElementOrder<N> incidentEdgeOrder()
```
    Returns an ElementOrder that specifies the order of iteration for the elements of edges(), adjacentNodes(Object), predecessors(Object), successors(Object) and incidentEdges(Object).
    
    Specified by:
    
    incidentEdgeOrder in interface Graph<N>
  - delegate
```
protected com.google.common.graph.BaseGraph<N> delegate()
```
  - nodes
```
public Set<N> nodes()
```
    Description copied from interface: Graph
    
    Returns all nodes in this graph, in the order specified by Graph.nodeOrder().
  - edgeCount
```
protected long edgeCount()
```
    Defer to AbstractBaseGraph.edges() (based on 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 a source node to a target 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 self-loops (edges that connect a node to itself). Attempting to add a self-loop to a graph that does not allow them will throw an IllegalArgumentException.
  - nodeOrder
```
public ElementOrder<N> nodeOrder()
```
    Description copied from interface: Graph
    
    Returns the order of iteration for the elements of Graph.nodes().
  - adjacentNodes
```
public Set<N> adjacentNodes(N node)
```
    Description copied from interface: Graph
    
    Returns the nodes which have an incident edge in common with node in this graph.
    This is equal to the union of Graph.predecessors(Object) and Graph.successors(Object).
  - predecessors
```
public Set<N> predecessors(N node)
```
    Description copied from interface: Graph
    
    Returns all nodes in this graph adjacent to node which can be reached by traversing node'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 to node which can be reached by traversing node'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, see Graphs.reachableNodes(Graph, Object).
  - incidentEdges
```
public Set<EndpointPair<N>> incidentEdges(N node)
```
    Returns the edges in this graph whose endpoints include node.
    This is equal to the union of incoming and outgoing edges.
    
    Specified by:
    
    incidentEdges in interface Graph<N>
  - degree
```
public int degree(N node)
```
    Returns the count of node's incident edges, counting self-loops twice (equivalently, the number of times an edge touches node).
    For directed graphs, this is equal to inDegree(node) + outDegree(node).
    For undirected graphs, this is equal to incidentEdges(node).size() + (number of self-loops incident to node).
    If the count is greater than Integer.MAX_VALUE, returns Integer.MAX_VALUE.
    
    Specified by:
    
    degree in interface Graph<N>
  - inDegree
```
public int inDegree(N node)
```
    Returns the count of node's incoming edges (equal to predecessors(node).size()) in a directed graph. In an undirected graph, returns the degree(Object).
    If the count is greater than Integer.MAX_VALUE, returns Integer.MAX_VALUE.
    
    Specified by:
    
    inDegree in interface Graph<N>
  - outDegree
```
public int outDegree(N node)
```
    Returns the count of node's outgoing edges (equal to successors(node).size()) in a directed graph. In an undirected graph, returns the degree(Object).
    If the count is greater than Integer.MAX_VALUE, returns Integer.MAX_VALUE.
    
    Specified by:
    
    outDegree in interface Graph<N>
  - hasEdgeConnecting
```
public boolean hasEdgeConnecting(N nodeU,
                                 N nodeV)
```
    Returns true if there is an edge that directly connects nodeU to nodeV. This is equivalent to nodes().contains(nodeU) && successors(nodeU).contains(nodeV).
    In an undirected graph, this is equal to hasEdgeConnecting(nodeV, nodeU).
    
    Specified by:
    
    hasEdgeConnecting in interface Graph<N>
  - hasEdgeConnecting
```
public boolean hasEdgeConnecting(EndpointPair<N> endpoints)
```
    Returns true if there is an edge that directly connects endpoints (in the order, if any, specified by endpoints). This is equivalent to edges().contains(endpoints).
    Unlike the other EndpointPair-accepting methods, this method does not throw if the endpoints are unordered; it simply returns false. This is for consistency with the behavior of Collection#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 with edges().contains(endpoints).
    
    Specified by:
    
    hasEdgeConnecting in interface Graph<N>
  - edges
```
public Set<EndpointPair<N>> edges()
```
    An implementation of BaseGraph.edges() defined in terms of nodes() and successors(Object).
  - validateEndpoints
```
protected final void validateEndpoints(EndpointPair<?> endpoints)
```
    Throws IllegalArgumentException if the ordering of endpoints is not compatible with the directionality of this graph.
  - isOrderingCompatible
```
protected final boolean isOrderingCompatible(EndpointPair<?> endpoints)
```

Class ImmutableGraph<N>

Nested Class Summary

Method Summary

Methods inherited from class com.google.common.graph.AbstractGraph

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.common.graph.Graph

Method Detail

copyOf

copyOf

incidentEdgeOrder

delegate

nodes

edgeCount

isDirected

allowsSelfLoops

nodeOrder

adjacentNodes

predecessors

successors

incidentEdges

degree

inDegree

outDegree

hasEdgeConnecting

hasEdgeConnecting

edges

validateEndpoints

isOrderingCompatible