com.google.common.graph

Interface MutableGraph<N>

Type Parameters:

N - Node parameter type

All Superinterfaces:

Graph<N>

@Beta
public interface MutableGraph<N>
extends Graph<N>

A subinterface of Graph which adds mutation methods. When mutation is not required, users should prefer the Graph interface.

Since:

20.0

Author:

James Sexton, Joshua O'Madadhain

Method Summary

Modifier and Type	Method and Description
boolean	addNode(N node) Adds node if it is not already present.
boolean	putEdge(N nodeU, N nodeV) Adds an edge connecting nodeU to nodeV if one is not already present.
boolean	removeEdge(N nodeU, N nodeV) Removes the edge connecting nodeU to nodeV, if it is present.
boolean	removeNode(N node) Removes node if it is present; all edges incident to node will also be removed.

Methods inherited from interface com.google.common.graph.Graph

adjacentNodes, allowsSelfLoops, degree, edges, equals, hasEdgeConnecting, hashCode, incidentEdges, inDegree, isDirected, nodeOrder, nodes, outDegree, predecessors, successors

Method Detail

addNode

@CanIgnoreReturnValue
boolean addNode(N node)

Adds node if it is not already present.

Nodes must be unique, just as Map keys must be. They must also be non-null.

Returns:

true if the graph was modified as a result of this call

putEdge

@CanIgnoreReturnValue
boolean putEdge(N nodeU,
                                      N nodeV)

Adds an edge connecting nodeU to nodeV if one is not already present. In an undirected graph, the edge will also connect nodeV to nodeU.

If nodeU and nodeV are not already present in this graph, this method will silently add nodeU and nodeV to the graph.

Returns:

true if the graph was modified as a result of this call

Throws:

IllegalArgumentException - if the introduction of the edge would violate Graph.allowsSelfLoops()

removeNode

@CanIgnoreReturnValue
boolean removeNode(N node)

Removes node if it is present; all edges incident to node will also be removed.

Returns:

true if the graph was modified as a result of this call

removeEdge

@CanIgnoreReturnValue
boolean removeEdge(N nodeU,
                                         N nodeV)

Removes the edge connecting nodeU to nodeV, if it is present.

Returns:

true if the graph was modified as a result of this call