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:

PredecessorsFunction<N>, SuccessorsFunction<N>, 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, Jens Nyman

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ImmutableValueGraph.Builder<N,V>
A builder for creating ImmutableValueGraph instances, especially static 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 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`.
`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)`
`protected long`	`edgeCount()`	Returns the number of edges in this graph; used to calculate the size of `Graph.edges()`.
`java.util.Set<EndpointPair<N>>`	`edges()`	An implementation of `BaseGraph.edges()` defined in terms of `Graph.nodes()` and `SuccessorsFunction.successors(Object)`.
`V`	`edgeValueOrDefault(EndpointPair<N> endpoints, V defaultValue)`	Returns the value of the edge that connects `endpoints` (in the order, if any, specified by `endpoints`), if one is present; otherwise, returns `defaultValue`.
`V`	`edgeValueOrDefault(N nodeU, N nodeV, V defaultValue)`	Returns the value of the edge that connects `nodeU` to `nodeV`, if one is present; otherwise, returns `defaultValue`.
`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 `ValueGraph.edges()`, `ValueGraph.adjacentNodes(Object)`, `ValueGraph.predecessors(Object)`, `ValueGraph.successors(Object)` and `ValueGraph.incidentEdges(Object)`.
`java.util.Set<EndpointPair<N>>`	`incidentEdges(N node)`	Returns a live view of the edges in this graph whose endpoints include `node`.
`int`	`inDegree(N node)`
`boolean`	`isDirected()`	Returns true if the edges in this graph are directed.
`protected boolean`	`isOrderingCompatible(EndpointPair<?> endpoints)`	Returns `true` iff `endpoints`' 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 of `ValueGraph.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 by `ValueGraph.nodeOrder()`.
`int`	`outDegree(N node)`
`java.util.Set<N>`	`predecessors(N node)`	Returns a live view of 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.
`java.util.Set<N>`	`successors(N node)`	Returns a live view of 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.AbstractValueGraph
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 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.
  - incidentEdgeOrder
```
public ElementOrder<N> incidentEdgeOrder()
```
    Description copied from interface: ValueGraph
    
    Returns an ElementOrder that specifies the order of iteration for the elements of ValueGraph.edges(), ValueGraph.adjacentNodes(Object), ValueGraph.predecessors(Object), ValueGraph.successors(Object) and ValueGraph.incidentEdges(Object).
    
    Specified by:
    
    incidentEdgeOrder in interface ValueGraph<N,V>
  - 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 java.util.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 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 with node in this graph.
    This is equal to the union of ValueGraph.predecessors(Object) and ValueGraph.successors(Object).
    If node is removed from the graph after this method is called, the Set view returned by this method will be invalidated, and will throw IllegalStateException if it is accessed in any way, with the following exceptions:
    
    view.equals(view) evaluates to true (but any other `equals()` expression involving view will throw)
    hashCode() does not throw
    if node is re-added 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 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).
    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 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).
    If node is removed from the graph after this method is called, the Set view returned by this method will be invalidated, and will throw IllegalStateException if it is accessed in any way, with the following exceptions:
    
    view.equals(view) evaluates to true (but any other `equals()` expression involving view will throw)
    hashCode() does not throw
    if node is re-added 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 include node.
    This is equal to the union of incoming and outgoing edges.
    If node is removed from the graph after this method is called, the Set view returned by this method will be invalidated, and will throw IllegalStateException if it is accessed in any way, with the following exceptions:
    
    view.equals(view) evaluates to true (but any other `equals()` expression involving view will throw)
    hashCode() does not throw
    if node is re-added to the graph after having been removed, view's behavior is undefined
    Specified by:
    
    incidentEdges in interface ValueGraph<N,V>
  - hasEdgeConnecting
```
public boolean hasEdgeConnecting(N nodeU,
                                 N nodeV)
```
    Description copied from interface: ValueGraph
    
    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 ValueGraph<N,V>
  - hasEdgeConnecting
```
public boolean hasEdgeConnecting(EndpointPair<N> endpoints)
```
    Description copied from interface: ValueGraph
    
    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 and the graph is directed; 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 ValueGraph<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 connects nodeU to nodeV, if one is present; otherwise, returns defaultValue.
    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 connects endpoints (in the order, if any, specified by endpoints), if one is present; otherwise, returns defaultValue.
    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 of Graph.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 of BaseGraph.edges() defined in terms of Graph.nodes() and SuccessorsFunction.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)
```
    Throws IllegalArgumentException if the ordering of endpoints is not compatible with the directionality of this graph.
  - isOrderingCompatible
```
protected final boolean isOrderingCompatible(EndpointPair<?> endpoints)
```
    Returns true iff endpoints' 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)
```

Class ImmutableValueGraph<N,​V>

Nested Class 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

Method Detail

copyOf

copyOf

incidentEdgeOrder

asGraph

nodes

isDirected

allowsSelfLoops

nodeOrder

adjacentNodes

predecessors

successors

incidentEdges

hasEdgeConnecting

hasEdgeConnecting

edgeValueOrDefault

edgeValueOrDefault

edgeCount

edges

degree

inDegree

outDegree

validateEndpoints

isOrderingCompatible

nodeInvalidatableSet

nodePairInvalidatableSet

Class ImmutableValueGraph<N,V>