Guava: Google Core Libraries for Java 33.1.0-jre · com.google.common.graph.NetworkBuilder

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();

Modifier and Type	Field and Description
pack-priv boolean	allowsParallelEdges
pack-priv ElementOrder<? super E>	edgeOrder
pack-priv Optional<Integer>	expectedEdgeCount

Constructor Summary

Access	Constructor and Description
private	NetworkBuilder(boolean directed) Creates a new instance with the specified edge directionality.

Method Summary

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

Field Detail

allowsParallelEdges	back to summary
pack-priv boolean allowsParallelEdges

edgeOrder	back to summary
pack-priv ElementOrder<? super E> edgeOrder

expectedEdgeCount	back to summary
pack-priv Optional<Integer> expectedEdgeCount

Constructor Detail

NetworkBuilder	back to summary
private NetworkBuilder(boolean directed) Creates a new instance with the specified edge directionality.

Method Detail

allowsParallelEdges back to summary

allowsParallelEdges	back to summary
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`. Annotations @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.

Annotations

@CanIgnoreReturnValue

allowsSelfLoops back to summary

allowsSelfLoops	back to summary
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`. Annotations @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.

Annotations

@CanIgnoreReturnValue

build	back to summary
public <N1 extends N, E1 extends E> MutableNetwork<N1, E1> build() Returns an empty `MutableNetwork` with the properties of this `NetworkBuilder`.

cast	back to summary
private <N1 extends N, E1 extends E> NetworkBuilder<N1, E1> cast() Annotations @SuppressWarnings:unchecked

directed	back to summary
public static NetworkBuilder<Object, Object> directed() Returns a `NetworkBuilder` for building directed networks.

edgeOrder back to summary

edgeOrder	back to summary
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`.

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.

expectedEdgeCount back to summary

expectedEdgeCount	back to summary
public NetworkBuilder<N, E> expectedEdgeCount(int expectedEdgeCount) Specifies the expected number of edges in the network. Annotations @CanIgnoreReturnValue Exceptions IllegalArgumentException: if `expectedEdgeCount` is negative

public NetworkBuilder<N, E> expectedEdgeCount(int expectedEdgeCount)

Specifies the expected number of edges in the network.

Annotations

@CanIgnoreReturnValue

Exceptions

IllegalArgumentException:: if expectedEdgeCount is negative

expectedNodeCount back to summary

expectedNodeCount	back to summary
public NetworkBuilder<N, E> expectedNodeCount(int expectedNodeCount) Specifies the expected number of nodes in the network. Annotations @CanIgnoreReturnValue Exceptions IllegalArgumentException: if `expectedNodeCount` is negative

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

Specifies the expected number of nodes in the network.

Annotations

@CanIgnoreReturnValue

Exceptions

IllegalArgumentException:: if expectedNodeCount is negative

from back to summary

from	back to summary
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.

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 back to summary

immutable	back to summary
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

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

nodeOrder back to summary

nodeOrder	back to summary
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`.

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.

undirected	back to summary
public static NetworkBuilder<Object, Object> undirected() Returns a `NetworkBuilder` for building undirected networks.

public final Class NetworkBuilder<N, E>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail