ImmutableValueGraph (Guava: Google Core Libraries for Java 26.0-jre API)

java.lang.Object
- com.google.common.graph.AbstractValueGraph<N,V>
- - com.google.common.graph.ImmutableValueGraph<N,V>

Type Parameters:

N - Node parameter type

V - Value parameter type

All Implemented Interfaces:

ValueGraph<N,V>
```
@Beta
 @Immutable(containerOf={"N","V"})
public final class ImmutableValueGraph<N,V>
extends AbstractValueGraph<N,V>
```
A ValueGraph whose elements and structural relationships will never change. Instances of this class may be obtained with copyOf(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

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`edgeCount`
`protected com.google.common.graph.MapIteratorCache<N,com.google.common.graph.GraphConnections<N,V>>`	`nodeConnections`

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).
`ImmutableGraph<N>`	`asGraph()` Returns a live view of this graph as a `Graph`.
`protected com.google.common.graph.GraphConnections<N,V>`	`checkedConnections(N node)`
`protected boolean`	`containsNode(N node)`
`static <N,V> ImmutableValueGraph<N,V>`	`copyOf(ImmutableValueGraph<N,V> graph)` Deprecated. no need to use this
`static <N,V> ImmutableValueGraph<N,V>`	`copyOf(ValueGraph<N,V> graph)` Returns an immutable copy of `graph`.
`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 long`	`edgeCount()` Returns the number of edges in this graph; used to calculate the size of `edges()`.
`Set<EndpointPair<N>>`	`edges()` An implementation of `BaseGraph.edges()` defined in terms of `nodes()` and `successors(Object)`.
`V`	`edgeValueOrDefault(N nodeU, N nodeV, V defaultValue)` Returns the value of the edge connecting `nodeU` to `nodeV`, if one is present; otherwise, returns `defaultValue`.
`boolean`	`hasEdgeConnecting(N nodeU, N nodeV)` Returns true if there is an edge directly connecting `nodeU` to `nodeV`.
`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.
`ElementOrder<N>`	`nodeOrder()` Returns the order of iteration for the elements of `ValueGraph.nodes()`.
`Set<N>`	`nodes()` Returns all nodes in this graph, in the order specified by `ValueGraph.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.

Methods inherited from class com.google.common.graph.AbstractValueGraph
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, incidentEdges, inDegree, outDegree

- Field Detail
  - nodeConnections
```
protected final com.google.common.graph.MapIteratorCache<N,com.google.common.graph.GraphConnections<N,V>> nodeConnections
```
  - edgeCount
```
protected long edgeCount
```
- Method Detail
  - copyOf
```
public static <N,V> ImmutableValueGraph<N,V> copyOf(ValueGraph<N,V> graph)
```
    Returns an immutable copy of graph.
  - copyOf
```
@Deprecated
public static <N,V> ImmutableValueGraph<N,V> copyOf(ImmutableValueGraph<N,V> graph)
```
    Deprecated. no need to use this
    
    Simply returns its argument.
  - asGraph
```
public ImmutableGraph<N> asGraph()
```
    Description copied from interface: ValueGraph
    
    Returns a live view of this graph as a Graph. The resulting Graph will have an edge connecting node A to node B if this ValueGraph has an edge connecting A to B.
    
    Specified by:
    
    asGraph in interface ValueGraph<N,V>
    
    Overrides:
    
    asGraph in class AbstractValueGraph<N,V>
  - nodes
```
public Set<N> nodes()
```
    Description copied from interface: ValueGraph
    
    Returns all nodes in this graph, in the order specified by ValueGraph.nodeOrder().
  - isDirected
```
public boolean isDirected()
```
    Description copied from interface: ValueGraph
    
    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: ValueGraph
    
    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: ValueGraph
    
    Returns the order of iteration for the elements of ValueGraph.nodes().
  - adjacentNodes
```
public Set<N> adjacentNodes(N node)
```
    Description copied from interface: ValueGraph
    
    Returns the nodes which have an incident edge in common with node in this graph.
  - predecessors
```
public Set<N> predecessors(N node)
```
    Description copied from interface: ValueGraph
    
    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 ValueGraph.adjacentNodes(Object).
  - successors
```
public Set<N> successors(N node)
```
    Description copied from interface: ValueGraph
    
    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 ValueGraph.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).
  - hasEdgeConnecting
```
public boolean hasEdgeConnecting(N nodeU,
                                 N nodeV)
```
    Returns true if there is an edge directly connecting 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 ValueGraph<N,V>
  - edgeValueOrDefault
```
public V edgeValueOrDefault(N nodeU,
                            N nodeV,
                            V defaultValue)
```
    Description copied from interface: ValueGraph
    
    Returns the value of the edge connecting nodeU to nodeV, if one is present; otherwise, returns defaultValue.
    In an undirected graph, this is equal to edgeValueOrDefault(nodeV, nodeU, defaultValue).
  - edgeCount
```
protected long edgeCount()
```
    Returns the number of edges in this graph; used to calculate the size of 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.
  - checkedConnections
```
protected final com.google.common.graph.GraphConnections<N,V> checkedConnections(N node)
```
  - containsNode
```
protected final boolean containsNode(N node)
```
  - edges
```
public Set<EndpointPair<N>> edges()
```
    An implementation of BaseGraph.edges() defined in terms of nodes() and successors(Object).
  - incidentEdges
```
public Set<EndpointPair<N>> incidentEdges(N node)
```
    Returns the edges in this graph whose endpoints include node.
  - 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.
  - 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.
  - 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.

Class ImmutableValueGraph<N,V>

Field Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

nodeConnections

edgeCount

Method Detail

copyOf

copyOf

asGraph

nodes

isDirected

allowsSelfLoops

nodeOrder

adjacentNodes

predecessors

successors

hasEdgeConnecting

edgeValueOrDefault

edgeCount

checkedConnections

containsNode

edges

incidentEdges

degree

inDegree

outDegree