Class ImmutableNetwork<N,E>

java.lang.Object

com.google.common.graph.AbstractNetwork<N,E>

com.google.common.graph.ImmutableNetwork<N,E>

Type Parameters:

N - Node parameter type

E - Edge parameter type

All Implemented Interfaces:

Network<N,E>, PredecessorsFunction<N>, SuccessorsFunction<N>

@Immutable(containerOf={"N","E"})
public final class ImmutableNetwork<N,E>
extends AbstractNetwork<N,E>

A Network whose elements and structural relationships will never change. Instances of this class may be obtained with copyOf(Network).

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, Joshua O'Madadhain, Omar Darwish, Jens Nyman

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableNetwork.Builder<N,E>	A builder for creating ImmutableNetwork instances, especially static final networks.

Method Summary

Modifier and Type	Method	Description
Set<N>	adjacentNodes(N node)
boolean	allowsParallelEdges()	Returns true if this network allows parallel edges.
boolean	allowsSelfLoops()
ImmutableGraph<N>	asGraph()	Returns a live view of this network as a Graph.
static <N,E> ImmutableNetwork<N,E>	copyOf(ImmutableNetwork<N,E> network)	Deprecated. no need to use this
static <N,E> ImmutableNetwork<N,E>	copyOf(Network<N,E> network)	Returns an immutable copy of network.
ElementOrder<E>	edgeOrder()	Returns the order of iteration for the elements of Network.edges().
Set<E>	edges()	Returns all edges in this network, in the order specified by Network.edgeOrder().
Set<E>	edgesConnecting(N nodeU, N nodeV)	Returns a live view of the set of edges that each directly connect nodeU to nodeV.
Set<E>	incidentEdges(N node)	Returns a live view of the edges whose incident nodes in this network include node.
EndpointPair<N>	incidentNodes(E edge)	Returns the nodes which are the endpoints of edge in this network.
Set<E>	inEdges(N node)	Returns a live view of all edges in this network which can be traversed in the direction (if any) of the edge to end at node.
boolean	isDirected()
ElementOrder<N>	nodeOrder()
Set<N>	nodes()
Set<E>	outEdges(N node)	Returns a live view of all edges in this network which can be traversed in the direction (if any) of the edge starting from node.
Set<N>	predecessors(N node)	Returns 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.
Set<N>	successors(N node)	Returns 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.

Methods inherited from class AbstractNetwork

adjacentEdges, degree, edgeConnectingOrNull, edgeConnectingOrNull, edgeInvalidatableSet, edgesConnecting, equals, hasEdgeConnecting, hasEdgeConnecting, hashCode, inDegree, isOrderingCompatible, nodeInvalidatableSet, nodePairInvalidatableSet, outDegree, toString, validateEndpoints

Modifier and Type	Method	Description
Set<E>	adjacentEdges(E edge)	Returns a live view of the edges which have an incident node in common with edge.
int	degree(N node)	Returns the count of node's incident edges, counting self-loops twice (equivalently, the number of times an edge touches node).
E	edgeConnectingOrNull(EndpointPair<N> endpoints)	Returns the single edge that directly connects endpoints (in the order, if any, specified by endpoints), if one is present, or null if no such edge exists.
E	edgeConnectingOrNull(N nodeU, N nodeV)	Returns the single edge that directly connects nodeU to nodeV, if one is present, or null if no such edge exists.
protected final <T> Set<T>	edgeInvalidatableSet(Set<T> set, E edge)	Returns a Set whose methods throw IllegalStateException when the given edge is not present in this network.
Set<E>	edgesConnecting(EndpointPair<N> endpoints)	Returns a live view of the set of edges that each directly connect endpoints (in the order, if any, specified by endpoints).
final boolean	equals(@Nullable Object obj)	Returns true iff object is a Network that has the same elements and the same structural relationships as those in this network.
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.
final int	hashCode()	Returns the hash code for this network.
int	inDegree(N node)	Returns the count of node's incoming edges in a directed network.
protected final boolean	isOrderingCompatible(EndpointPair<?> endpoints)
protected final <T> Set<T>	nodeInvalidatableSet(Set<T> set, N node)	Returns a Set whose methods throw IllegalStateException when the given node is not present in this network.
protected final <T> Set<T>	nodePairInvalidatableSet(Set<T> set, N nodeU, N nodeV)	Returns a Set whose methods throw IllegalStateException when either of the given nodes is not present in this network.
int	outDegree(N node)	Returns the count of node's outgoing edges in a directed network.
String	toString()	Returns a string representation of this network.
protected final void	validateEndpoints(EndpointPair<?> endpoints)	Throws an IllegalArgumentException if the ordering of endpoints is not compatible with the directionality of this graph.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

copyOf

public static <N,E> ImmutableNetwork<N,E> copyOf(Network<N,E> network)

Returns an immutable copy of network.

copyOf

@InlineMe(replacement="checkNotNull(network)",
          staticImports="com.google.common.base.Preconditions.checkNotNull")
@Deprecated
public static <N,E> ImmutableNetwork<N,E> copyOf(ImmutableNetwork<N,E> network)

Deprecated.

no need to use this

Simply returns its argument.

asGraph

public ImmutableGraph<N> asGraph()

Description copied from interface: Network

Returns a live view of this network as a Graph. The resulting Graph will have an edge connecting node A to node B if this Network has an edge connecting A to B.

If this network allows parallel edges, parallel edges will be treated as if collapsed into a single edge. For example, the Network.degree(Object) of a node in the Graph view may be less than the degree of the same node in this Network.

Specified by:

asGraph in interface Network<N,E>

Overrides:

asGraph in class AbstractNetwork<N,E>

nodes

public Set<N> nodes()

edges

public Set<E> edges()

Description copied from interface: Network

Returns all edges in this network, in the order specified by Network.edgeOrder().

isDirected

public boolean isDirected()

allowsParallelEdges

public boolean allowsParallelEdges()

Description copied from interface: Network

Returns true if this network allows parallel edges. Attempting to add a parallel edge to a network that does not allow them will throw an IllegalArgumentException.

allowsSelfLoops

public boolean allowsSelfLoops()

nodeOrder

public ElementOrder<N> nodeOrder()

edgeOrder

public ElementOrder<E> edgeOrder()

Description copied from interface: Network

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

incidentEdges

public Set<E> incidentEdges(N node)

Description copied from interface: Network

Returns a live view of the edges whose incident nodes in this network include node.

This is equal to the union of Network.inEdges(Object) and Network.outEdges(Object).

If node is removed from the network 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 network after having been removed, view's behavior is undefined

incidentNodes

public EndpointPair<N> incidentNodes(E edge)

Description copied from interface: Network

Returns the nodes which are the endpoints of edge in this network.

adjacentNodes

public Set<N> adjacentNodes(N node)

edgesConnecting

public Set<E> edgesConnecting(N nodeU,
 N nodeV)

Description copied from interface: Network

Returns a live view of the set of edges that each directly connect nodeU to nodeV.

In an undirected network, this is equal to edgesConnecting(nodeV, nodeU).

The resulting set of edges will be parallel (i.e. have equal Network.incidentNodes(Object)). If this network does not allow parallel edges, the resulting set will contain at most one edge (equivalent to edgeConnecting(nodeU, nodeV).asSet()).

If either nodeU or nodeV are removed from the network 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 nodeU or nodeV are re-added to the network after having been removed, view's behavior is undefined

Specified by:

edgesConnecting in interface Network<N,E>

Overrides:

edgesConnecting in class AbstractNetwork<N,E>

inEdges

public Set<E> inEdges(N node)

Description copied from interface: Network

Returns a live view of all edges in this network which can be traversed in the direction (if any) of the edge to end at node.

In a directed network, an incoming edge's EndpointPair.target() equals node.

In an undirected network, this is equivalent to Network.incidentEdges(Object).

If node is removed from the network 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 network after having been removed, view's behavior is undefined

outEdges

public Set<E> outEdges(N node)

Description copied from interface: Network

Returns a live view of all edges in this network which can be traversed in the direction (if any) of the edge starting from node.

In a directed network, an outgoing edge's EndpointPair.source() equals node.

In an undirected network, this is equivalent to Network.incidentEdges(Object).

If node is removed from the network 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 network after having been removed, view's behavior is undefined

predecessors

public Set<N> predecessors(N node)

Description copied from interface: PredecessorsFunction

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

Some algorithms that operate on a PredecessorsFunction may produce undesired results if the returned Iterable contains duplicate elements. Implementations of such algorithms should document their behavior in the presence of duplicates.

The elements of the returned Iterable must each be:

• Non-null
• Usable as Map keys (see the Guava User Guide's section on graph elements for details)

successors

public Set<N> successors(N node)

Description copied from interface: SuccessorsFunction

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

This is not the same as "all nodes reachable from node by following outgoing edges". For that functionality, see Graphs.reachableNodes(Graph, Object).

Some algorithms that operate on a SuccessorsFunction may produce undesired results if the returned Iterable contains duplicate elements. Implementations of such algorithms should document their behavior in the presence of duplicates.

The elements of the returned Iterable must each be:

• Non-null
• Usable as Map keys (see the Guava User Guide's section on graph elements for details)