ValueGraphBuilder

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

@Beta
public final class ValueGraphBuilder<N,V>
extends java.lang.Object

A builder for constructing instances of MutableValueGraph with user-defined properties.

A graph built by this class will have the following properties by default:

does not allow self-loops
orders Graph.nodes() in the order in which the elements were added

Example of use:

MutableValueGraph<String, Double> graph =
     ValueGraphBuilder.undirected().allowsSelfLoops(true).build();
 graph.putEdgeValue("San Francisco", "San Francisco", 0.0);
 graph.putEdgeValue("San Jose", "San Jose", 0.0);
 graph.putEdgeValue("San Francisco", "San Jose", 48.4);

Since:: 20.0

Method Summary

Methods
Modifier and Type	Method and Description
`ValueGraphBuilder<N,V>`	`allowsSelfLoops(boolean allowsSelfLoops)` Specifies whether the graph will allow self-loops (edges that connect a node to itself).
`<N1 extends N,V1 extends V> MutableValueGraph<N1,V1>`	`build()` Returns an empty `MutableValueGraph` with the properties of this `ValueGraphBuilder`.
`static ValueGraphBuilder<java.lang.Object,java.lang.Object>`	`directed()` Returns a `ValueGraphBuilder` for building directed graphs.
`ValueGraphBuilder<N,V>`	`expectedNodeCount(int expectedNodeCount)` Specifies the expected number of nodes in the graph.
`static <N> ValueGraphBuilder<N,java.lang.Object>`	`from(Graph<N> graph)` Returns a `ValueGraphBuilder` initialized with all properties queryable from `graph`.
`<N1 extends N> ValueGraphBuilder<N1,V>`	`nodeOrder(ElementOrder<N1> nodeOrder)` Specifies the order of iteration for the elements of `Graph.nodes()`.
`static ValueGraphBuilder<java.lang.Object,java.lang.Object>`	`undirected()` Returns a `ValueGraphBuilder` for building undirected graphs.

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

- Method Detail
  - directed
```
public static ValueGraphBuilder<java.lang.Object,java.lang.Object> directed()
```
    Returns a ValueGraphBuilder for building directed graphs.
  - undirected
```
public static ValueGraphBuilder<java.lang.Object,java.lang.Object> undirected()
```
    Returns a ValueGraphBuilder for building undirected graphs.
  - from
```
public static <N> ValueGraphBuilder<N,java.lang.Object> from(Graph<N> graph)
```
    Returns a ValueGraphBuilder initialized with all properties queryable from graph.
    The "queryable" properties are those that are exposed through the Graph interface, such as Graph.isDirected(). Other properties, such as expectedNodeCount(int), are not set in the new builder.
  - allowsSelfLoops
```
public ValueGraphBuilder<N,V> allowsSelfLoops(boolean allowsSelfLoops)
```
    Specifies whether the graph will allow 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 UnsupportedOperationException.
  - expectedNodeCount
```
public ValueGraphBuilder<N,V> expectedNodeCount(int expectedNodeCount)
```
    Specifies the expected number of nodes in the graph.
    
    Throws:
    
    java.lang.IllegalArgumentException - if expectedNodeCount is negative
  - nodeOrder
```
public <N1 extends N> ValueGraphBuilder<N1,V> nodeOrder(ElementOrder<N1> nodeOrder)
```
    Specifies the order of iteration for the elements of Graph.nodes().
  - build
```
public <N1 extends N,V1 extends V> MutableValueGraph<N1,V1> build()
```
    Returns an empty MutableValueGraph with the properties of this ValueGraphBuilder.

Class ValueGraphBuilder<N,V>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

directed

undirected

from

allowsSelfLoops

expectedNodeCount

nodeOrder

build