NetworkBuilder (Guava: Google Core Libraries for Java 27.1-jre API)

java.lang.Object
- com.google.common.graph.NetworkBuilder<N,E>

Type Parameters:

N - The most general node type this builder will support. This is normally Object unless it is constrained by using a method like nodeOrder(com.google.common.graph.ElementOrder<N1>), or the builder is constructed based on an existing Network using from(Network).

N - The most general edge type this builder will support. This is normally Object unless it is constrained by using a method like edgeOrder, or the builder is constructed based on an existing Network using from(Network).
```
@Beta
public final class NetworkBuilder<N,E>
extends Object
```
A builder for constructing instances of MutableNetwork with user-defined properties.
A network built by this class will have the following properties by default:
- does not allow parallel edges
- does not allow self-loops
- orders Network.nodes() and Network.edges() in the order in which the elements were added
Example of use:
```
 MutableNetwork<String, Integer> flightNetwork =
     NetworkBuilder.directed().allowsParallelEdges(true).build();
 flightNetwork.addEdge("LAX", "ATL", 3025);
 flightNetwork.addEdge("LAX", "ATL", 1598);
 flightNetwork.addEdge("ATL", "LAX", 2450);
 
```
Since:

20.0

Author:

James Sexton, Joshua O'Madadhain

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NetworkBuilder<N,E>`	`allowsParallelEdges(boolean allowsParallelEdges)` Specifies whether the network will allow parallel edges.
`NetworkBuilder<N,E>`	`allowsSelfLoops(boolean allowsSelfLoops)` Specifies whether the network will allow self-loops (edges that connect a node to itself).
`<N1 extends N,E1 extends E> MutableNetwork<N1,E1>`	`build()` Returns an empty `MutableNetwork` with the properties of this `NetworkBuilder`.
`static NetworkBuilder<Object,Object>`	`directed()` Returns a `NetworkBuilder` for building directed networks.
`<E1 extends E> NetworkBuilder<N,E1>`	`edgeOrder(ElementOrder<E1> edgeOrder)` Specifies the order of iteration for the elements of `Network.edges()`.
`NetworkBuilder<N,E>`	`expectedEdgeCount(int expectedEdgeCount)` Specifies the expected number of edges in the network.
`NetworkBuilder<N,E>`	`expectedNodeCount(int expectedNodeCount)` Specifies the expected number of nodes in the network.
`static <N,E> NetworkBuilder<N,E>`	`from(Network<N,E> network)` Returns a `NetworkBuilder` initialized with all properties queryable from `network`.
`<N1 extends N> NetworkBuilder<N1,E>`	`nodeOrder(ElementOrder<N1> nodeOrder)` Specifies the order of iteration for the elements of `Network.nodes()`.
`static NetworkBuilder<Object,Object>`	`undirected()` Returns a `NetworkBuilder` for building undirected networks.

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

- Method Detail
  - directed
```
public static NetworkBuilder<Object,Object> directed()
```
    Returns a NetworkBuilder for building directed networks.
  - undirected
```
public static NetworkBuilder<Object,Object> undirected()
```
    Returns a NetworkBuilder for building undirected networks.
  - from
```
public static <N,E> NetworkBuilder<N,E> from(Network<N,E> network)
```
    Returns a NetworkBuilder initialized with all properties queryable from network.
    The "queryable" properties are those that are exposed through the Network interface, such as Network.isDirected(). Other properties, such as expectedNodeCount(int), are not set in the new builder.
  - allowsParallelEdges
```
public NetworkBuilder<N,E> allowsParallelEdges(boolean allowsParallelEdges)
```
    Specifies whether the network will allow parallel edges. Attempting to add a parallel edge to a network that does not allow them will throw an UnsupportedOperationException.
  - allowsSelfLoops
```
public NetworkBuilder<N,E> allowsSelfLoops(boolean allowsSelfLoops)
```
    Specifies whether the network will allow self-loops (edges that connect a node to itself). Attempting to add a self-loop to a network that does not allow them will throw an UnsupportedOperationException.
  - expectedNodeCount
```
public NetworkBuilder<N,E> expectedNodeCount(int expectedNodeCount)
```
    Specifies the expected number of nodes in the network.
    
    Throws:
    
    IllegalArgumentException - if expectedNodeCount is negative
  - expectedEdgeCount
```
public NetworkBuilder<N,E> expectedEdgeCount(int expectedEdgeCount)
```
    Specifies the expected number of edges in the network.
    
    Throws:
    
    IllegalArgumentException - if expectedEdgeCount is negative
  - nodeOrder
```
public <N1 extends N> NetworkBuilder<N1,E> nodeOrder(ElementOrder<N1> nodeOrder)
```
    Specifies the order of iteration for the elements of Network.nodes().
  - edgeOrder
```
public <E1 extends E> NetworkBuilder<N,E1> edgeOrder(ElementOrder<E1> edgeOrder)
```
    Specifies the order of iteration for the elements of Network.edges().
  - build
```
public <N1 extends N,E1 extends E> MutableNetwork<N1,E1> build()
```
    Returns an empty MutableNetwork with the properties of this NetworkBuilder.

Class NetworkBuilder<N,E>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

directed

undirected

from

allowsParallelEdges

allowsSelfLoops

expectedNodeCount

expectedEdgeCount

nodeOrder

edgeOrder

build