Interface MutableGraph<N>
- Type Parameters:
N- Node parameter type
- All Superinterfaces:
Graph<N>, PredecessorsFunction<N>, SuccessorsFunction<N>
-
Method Summary
Modifier and TypeMethodDescriptionbooleanAddsnodeif it is not already present.Network<N, EndpointPair<N>> Returns a live view of this graph as aNetworkwhose edgesEareEndpointPair<N>objects (that is, aNetwork<N, EndpointPair<N>>).booleanputEdge(EndpointPair<N> endpoints) Adds an edge connectingendpoints(in the order, if any, specified byendpoints) if one is not already present.booleanAdds an edge connectingnodeUtonodeVif one is not already present.booleanremoveEdge(EndpointPair<N> endpoints) Removes the edge connectingendpoints, if it is present.booleanremoveEdge(N nodeU, N nodeV) Removes the edge connectingnodeUtonodeV, if it is present.booleanremoveNode(N node) Removesnodeif it is present; all edges incident tonodewill also be removed.Methods inherited from interface Graph
adjacentNodes, allowsSelfLoops, degree, edges, equals, hasEdgeConnecting, hasEdgeConnecting, hashCode, incidentEdgeOrder, incidentEdges, inDegree, isDirected, nodeOrder, nodes, outDegree, predecessors, successors
-
Method Details
-
addNode
Addsnodeif it is not already present.Nodes must be unique, just as
Mapkeys must be. They must also be non-null.- Returns:
trueif the graph was modified as a result of this call
-
putEdge
Adds an edge connectingnodeUtonodeVif one is not already present.If the graph is directed, the resultant edge will be directed; otherwise, it will be undirected.
If
nodeUandnodeVare not already present in this graph, this method will silentlyaddnodeUandnodeVto the graph.- Returns:
trueif the graph was modified as a result of this call- Throws:
IllegalArgumentException- if the introduction of the edge would violateGraph.allowsSelfLoops()
-
putEdge
Adds an edge connectingendpoints(in the order, if any, specified byendpoints) if one is not already present.If this graph is directed,
endpointsmust be ordered and the added edge will be directed; if it is undirected, the added edge will be undirected.If this graph is directed,
endpointsmust be ordered.If either or both endpoints are not already present in this graph, this method will silently
addeach missing endpoint to the graph.- Returns:
trueif the graph was modified as a result of this call- Throws:
IllegalArgumentException- if the introduction of the edge would violateGraph.allowsSelfLoops()IllegalArgumentException- if the endpoints are unordered and the graph is directed- Since:
- 27.1
-
removeNode
Removesnodeif it is present; all edges incident tonodewill also be removed.- Returns:
trueif the graph was modified as a result of this call
-
removeEdge
Removes the edge connectingnodeUtonodeV, if it is present.- Returns:
trueif the graph was modified as a result of this call
-
removeEdge
Removes the edge connectingendpoints, if it is present.If this graph is directed,
endpointsmust be ordered.- Returns:
trueif the graph was modified as a result of this call- Throws:
IllegalArgumentException- if the endpoints are unordered and the graph is directed- Since:
- 27.1
-
asNetwork
Network<N, EndpointPair<N>> asNetwork()Returns a live view of this graph as aNetworkwhose edgesEareEndpointPair<N>objects (that is, aNetwork<N, EndpointPair<N>>). The resultingNetwork's edge-oriented methods (such asinEdges()) will return views transformed from the corresponding node-oriented methods (such aspredecessors()).This capability facilitates writing implementations of edge-oriented code.
- Since:
- NEXT
-