Interface MutableValueGraph<N,V>

Type Parameters:

N - Node parameter type

V - Value parameter type

All Superinterfaces:

PredecessorsFunction<N>, SuccessorsFunction<N>, ValueGraph<N,V>

public interface MutableValueGraph<N,V>
extends ValueGraph<N,V>

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

Since:

20.0

Author:

James Sexton

Method Summary

Modifier and Type	Method	Description
boolean	addNode(N node)	Adds node if it is not already present.
Network<N, EndpointPair<N>>	asNetwork()	Returns a live view of this graph as a Network whose edges E are EndpointPair<N> objects (that is, a Network<N, EndpointPair<N>>).
@Nullable 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).
@Nullable 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).
@Nullable V	removeEdge(EndpointPair<N> endpoints)	Removes the edge connecting endpoints, if it is present.
@Nullable V	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 ValueGraph

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

Modifier and Type	Method	Description
Set<N>	adjacentNodes(N node)	Returns a live view of the nodes which have an incident edge in common with node in this graph.
boolean	allowsSelfLoops()	Returns true if this graph allows self-loops (edges that connect a node to itself).
Graph<N>	asGraph()	Returns a live view of this graph as a Graph.
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).
Set<EndpointPair<N>>	edges()	Returns all edges in this graph.
V	edgeValueOrDefault(EndpointPair<N> endpoints, V defaultValue)	Returns the value of the edge that connects endpoints (in the order, if any, specified by endpoints), if one is present; otherwise, returns defaultValue.
V	edgeValueOrDefault(N nodeU, N nodeV, V defaultValue)	Returns the value of the edge that connects nodeU to nodeV, if one is present; otherwise, returns defaultValue.
boolean	equals(@Nullable Object object)	Returns true iff object is a ValueGraph that has the same elements and the same structural relationships as those in this graph.
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.
int	hashCode()	Returns the hash code for this graph.
ElementOrder<N>	incidentEdgeOrder()	Returns an ElementOrder that specifies the order of iteration for the elements of ValueGraph.edges(), ValueGraph.adjacentNodes(Object), ValueGraph.predecessors(Object), ValueGraph.successors(Object) and ValueGraph.incidentEdges(Object).
Set<EndpointPair<N>>	incidentEdges(N node)	Returns a live view of the edges in this graph whose endpoints include node.
int	inDegree(N node)	Returns the count of node's incoming edges (equal to predecessors(node).size()) in a directed graph.
boolean	isDirected()	Returns true if the edges in this graph are directed.
ElementOrder<N>	nodeOrder()	Returns the order of iteration for the elements of ValueGraph.nodes().
Set<N>	nodes()	Returns all nodes in this graph, in the order specified by ValueGraph.nodeOrder().
int	outDegree(N node)	Returns the count of node's outgoing edges (equal to successors(node).size()) in a directed graph.
Set<N>	predecessors(N node)	Returns a live view of 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 a live view of 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.

Method Details

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

putEdgeValue

@CanIgnoreReturnValue
@Nullable 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:

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

Throws:

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

putEdgeValue

@CanIgnoreReturnValue
@Nullable 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:

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

Throws:

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

IllegalArgumentException - if the endpoints are unordered and the graph is directed

Since:

27.1

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
@Nullable V removeEdge(N nodeU,
 N nodeV)

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

Returns:

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

removeEdge

@CanIgnoreReturnValue
@Nullable V removeEdge(EndpointPair<N> endpoints)

Removes the edge connecting endpoints, if it is present.

If this graph is directed, endpoints must be ordered.

Returns:

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

Since:

27.1

asNetwork

Network<N, EndpointPair<N>> asNetwork()

Returns a live view of this graph as a Network whose edges E are EndpointPair<N> objects (that is, a Network<N, EndpointPair<N>>). The resulting Network's edge-oriented methods (such as inEdges()) will return views transformed from the corresponding node-oriented methods (such as predecessors()).

This capability facilitates writing implementations of edge-oriented code.

Since:

33.6.0