Top Description Methods
com.google.common.graph

public Interface MutableGraph<N>

extends Graph<N>
Known Direct Implementers
com.google.common.graph.StandardMutableGraph
Annotations
@Beta
@ElementTypesAreNonnullByDefault
Type Parameters
<N>
Node parameter type
Imports
com.google.common.annotations.Beta, com.google.errorprone.annotations.CanIgnoreReturnValue

A subinterface of Graph which adds mutation methods. When mutation is not required, users should prefer the Graph interface.
Authors
James Sexton, Joshua O'Madadhain
Since
20.0

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the graph was modified as a result of this call
addNode
(N node)

Adds node if it is not already present.

public boolean

Returns:

true if the graph was modified as a result of this call
putEdge
(N nodeU, N nodeV)

Adds an edge connecting nodeU to nodeV if one is not already present.

public boolean

Returns:

true if the graph was modified as a result of this call
putEdge
(EndpointPair<N> endpoints)

Adds an edge connecting endpoints (in the order, if any, specified by endpoints) if one is not already present.

public boolean

Returns:

true if the graph was modified as a result of this call
removeEdge
(N nodeU, N nodeV)

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

public boolean

Returns:

true if the graph was modified as a result of this call
removeEdge
(EndpointPair<N> endpoints)

Removes the edge connecting endpoints, if it is present.

public boolean

Returns:

true if the graph was modified as a result of this call
removeNode
(N node)

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

Inherited from com.google.common.graph.Graph:
adjacentNodesallowsSelfLoopsdegreeedgesequalshasEdgeConnectinghasEdgeConnectinghashCodeincidentEdgeOrderincidentEdgesinDegreeisDirectednodeOrdernodesoutDegreepredecessorssuccessors

Method Detail

addNodeback to summary
public 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:boolean

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

Annotations
@CanIgnoreReturnValue
putEdgeback to summary
public boolean putEdge(N nodeU, N nodeV)

Adds an edge connecting nodeU to nodeV if one is not already present.

If the graph is directed, the resultant edge will be directed; otherwise, it will be undirected.

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

Returns:boolean

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

Annotations
@CanIgnoreReturnValue
Exceptions
IllegalArgumentException:
if the introduction of the edge would violate allowsSelfLoops()
putEdgeback to summary
public boolean putEdge(EndpointPair<N> endpoints)

Adds an edge connecting endpoints (in the order, if any, specified by endpoints) if one is not already present.

If this graph is directed, endpoints must be ordered and the added edge will be directed; if it is undirected, the added edge will be undirected.

If this graph is directed, endpoints must be ordered.

If either or both endpoints are not already present in this graph, this method will silently add each missing endpoint to the graph.

Returns:boolean

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

Annotations
@CanIgnoreReturnValue
Exceptions
IllegalArgumentException:
  • if the introduction of the edge would violate allowsSelfLoops()
  • if the endpoints are unordered and the graph is directed
Since
27.1
removeEdgeback to summary
public boolean removeEdge(N nodeU, N nodeV)

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

Returns:boolean

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

Annotations
@CanIgnoreReturnValue
removeEdgeback to summary
public boolean removeEdge(EndpointPair<N> endpoints)

Removes the edge connecting endpoints, if it is present.

If this graph is directed, endpoints must be ordered.

Returns:boolean

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

Annotations
@CanIgnoreReturnValue
Exceptions
IllegalArgumentException:
if the endpoints are unordered and the graph is directed
Since
27.1
removeNodeback to summary
public boolean removeNode(N node)

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

Returns:boolean

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

Annotations
@CanIgnoreReturnValue