Class NetworkBuilder<N,E>

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).

E - 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 or ImmutableNetwork with user-defined properties.

A Network built by this class has the following default properties:

• 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 (insertion order)

Networks built by this class also guarantee that each collection-returning accessor returns a (live) unmodifiable view; see the external documentation for details.

Examples of use:

 // Building a mutable network
 MutableNetwork<String, Integer> network =
     NetworkBuilder.directed().allowsParallelEdges(true).build();
 flightNetwork.addEdge("LAX", "ATL", 3025);
 flightNetwork.addEdge("LAX", "ATL", 1598);
 flightNetwork.addEdge("ATL", "LAX", 2450);

 // Building a immutable network
 ImmutableNetwork<String, Integer> immutableNetwork =
     NetworkBuilder.directed()
         .allowsParallelEdges(true)
         .<String, Integer>immutable()
         .addEdge("LAX", "ATL", 3025)
         .addEdge("LAX", "ATL", 1598)
         .addEdge("ATL", "LAX", 2450)
         .build();
 

Since:

20.0

Author:

James Sexton, Joshua O'Madadhain

Method Summary

Modifier and Type	Method	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, E1 extends E> ImmutableNetwork.Builder<N1,E1>	immutable()	Returns an ImmutableNetwork.Builder with the properties of this NetworkBuilder.
<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 Details

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.

immutable

public <N1 extends N,
E1 extends E>
ImmutableNetwork.Builder<N1,E1> immutable()

Returns an ImmutableNetwork.Builder with the properties of this NetworkBuilder.

The returned builder can be used for populating an ImmutableNetwork.

Since:

28.0

allowsParallelEdges

@CanIgnoreReturnValue
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.

The default value is false.

allowsSelfLoops

@CanIgnoreReturnValue
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.

The default value is false.

expectedNodeCount

@CanIgnoreReturnValue
public NetworkBuilder<N,E> expectedNodeCount(int expectedNodeCount)

Specifies the expected number of nodes in the network.

Throws:

IllegalArgumentException - if expectedNodeCount is negative

expectedEdgeCount

@CanIgnoreReturnValue
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().

The default value is insertion order.

edgeOrder

public <E1 extends E> NetworkBuilder<N,E1> edgeOrder(ElementOrder<E1> edgeOrder)

Specifies the order of iteration for the elements of Network.edges().

The default value is insertion order.

build

public <N1 extends N,
E1 extends E>
MutableNetwork<N1,E1> build()

Returns an empty MutableNetwork with the properties of this NetworkBuilder.