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

Method Summary

Modifier and Type	Method 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 V	Returns: the value previously associated with the edge connecting `nodeU` to `nodeV`, or null if there was no such edge. putEdgeValue(N nodeU, N nodeV, V value) Adds an edge connecting `nodeU` to `nodeV` if one is not already present, and sets a value for that edge to `value` (overwriting the existing value, if any).
public V	Returns: the value previously associated with the edge connecting `nodeU` to `nodeV`, or null if there was no such edge. putEdgeValue(EndpointPair<N> endpoints, V value) Adds an edge connecting `endpoints` if one is not already present, and sets a value for that edge to `value` (overwriting the existing value, if any).
public V	Returns: the value previously associated with the edge connecting `nodeU` to `nodeV`, or null if there was no such edge. removeEdge(N nodeU, N nodeV) Removes the edge connecting `nodeU` to `nodeV`, if it is present.
public V	Returns: the value previously associated with the edge connecting `endpoints`, or null if there was no such edge. 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.

Method Detail

addNode back to summary

addNode	back 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

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

putEdgeValue back to summary

putEdgeValue	back to summary
public V putEdgeValue(N nodeU, N nodeV, V value) Adds an edge connecting `nodeU` to `nodeV` if one is not already present, and sets a value for that edge to `value` (overwriting the existing value, if any). If the graph is directed, the resultant edge will be directed; otherwise, it will be undirected. Values do not have to be unique. However, values must be non-null. If `nodeU` and `nodeV` are not already present in this graph, this method will silently `add` `nodeU` and `nodeV` to the graph. Returns:V the value previously associated with the edge connecting `nodeU` to `nodeV`, or null if there was no such edge. Annotations @CanIgnoreReturnValue @CheckForNull Exceptions IllegalArgumentException: if the introduction of the edge would violate `allowsSelfLoops()`

public V putEdgeValue(N nodeU, N nodeV, V value)

Adds an edge connecting nodeU to nodeV if one is not already present, and sets a value for that edge to value (overwriting the existing value, if any).

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

Values do not have to be unique. However, values must be non-null.

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

Returns:V

the value previously associated with the edge connecting nodeU to nodeV, or null if there was no such edge.

Annotations

@CanIgnoreReturnValue
@CheckForNull

Exceptions

IllegalArgumentException:: if the introduction of the edge would violate allowsSelfLoops()

putEdgeValue back to summary

putEdgeValue	back to summary
public V putEdgeValue(EndpointPair<N> endpoints, V value) Adds an edge connecting `endpoints` if one is not already present, and sets a value for that edge to `value` (overwriting the existing value, if any). If the graph is directed, the resultant edge will be directed; otherwise, it will be undirected. If this graph is directed, `endpoints` must be ordered. Values do not have to be unique. However, values must be non-null. If either or both endpoints are not already present in this graph, this method will silently `add` each missing endpoint to the graph. Returns:V the value previously associated with the edge connecting `nodeU` to `nodeV`, or null if there was no such edge. Annotations @CanIgnoreReturnValue @CheckForNull Exceptions IllegalArgumentException: if the introduction of the edge would violate `allowsSelfLoops()` if the endpoints are unordered and the graph is directed Since 27.1

public V putEdgeValue(EndpointPair<N> endpoints, V value)

Adds an edge connecting endpoints if one is not already present, and sets a value for that edge to value (overwriting the existing value, if any).

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

If this graph is directed, endpoints must be ordered.

Values do not have to be unique. However, values must be non-null.

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

Returns:V

the value previously associated with the edge connecting nodeU to nodeV, or null if there was no such edge.

Annotations

@CanIgnoreReturnValue
@CheckForNull

Exceptions

IllegalArgumentException:

if the introduction of the edge would violate allowsSelfLoops()
if the endpoints are unordered and the graph is directed

Since

27.1

removeEdge back to summary

removeEdge	back to summary
public V removeEdge(N nodeU, N nodeV) Removes the edge connecting `nodeU` to `nodeV`, if it is present. Returns:V the value previously associated with the edge connecting `nodeU` to `nodeV`, or null if there was no such edge. Annotations @CanIgnoreReturnValue @CheckForNull

public V removeEdge(N nodeU, N nodeV)

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

Returns:V

the value previously associated with the edge connecting nodeU to nodeV, or null if there was no such edge.

Annotations

@CanIgnoreReturnValue
@CheckForNull

removeEdge back to summary

removeEdge	back to summary
public V removeEdge(EndpointPair<N> endpoints) Removes the edge connecting `endpoints`, if it is present. If this graph is directed, `endpoints` must be ordered. Returns:V the value previously associated with the edge connecting `endpoints`, or null if there was no such edge. Annotations @CanIgnoreReturnValue @CheckForNull Since 27.1

public V removeEdge(EndpointPair<N> endpoints)

Removes the edge connecting endpoints, if it is present.

If this graph is directed, endpoints must be ordered.

Returns:V

the value previously associated with the edge connecting endpoints, or null if there was no such edge.

Annotations

@CanIgnoreReturnValue
@CheckForNull

Since

27.1

removeNode back to summary

removeNode	back 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

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

public Interface MutableValueGraph<N, V>

Method Summary

Method Detail