Class AsUnmodifiableGraph<V,E>
- java.lang.Object
-
- org.jgrapht.graph.AbstractGraph<V,E>
-
- org.jgrapht.graph.GraphDelegator<V,E>
-
- org.jgrapht.graph.AsUnmodifiableGraph<V,E>
-
- Type Parameters:
V
- the graph vertex typeE
- the graph edge type
- All Implemented Interfaces:
java.io.Serializable
,Graph<V,E>
public class AsUnmodifiableGraph<V,E> extends GraphDelegator<V,E> implements java.io.Serializable
An unmodifiable view of the backing graph specified in the constructor. This graph allows modules to provide users with "read-only" access to internal graphs. Query operations on this graph "read through" to the backing graph, and attempts to modify this graph result in anUnsupportedOperationException
.This graph does not pass the hashCode and equals operations through to the backing graph, but relies on
Object
'sequals
andhashCode
methods. This graph will be serializable if the backing graph is serializable.- Author:
- Barak Naveh
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from interface org.jgrapht.Graph
DEFAULT_EDGE_WEIGHT
-
-
Constructor Summary
Constructors Constructor Description AsUnmodifiableGraph(Graph<V,E> g)
Creates a new unmodifiable graph based on the specified backing graph.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description E
addEdge(V sourceVertex, V targetVertex)
Creates a new edge in this graph, going from the source vertex to the target vertex, and returns the created edge.boolean
addEdge(V sourceVertex, V targetVertex, E e)
Adds the specified edge to this graph, going from the source vertex to the target vertex.boolean
addVertex(V v)
Adds the specified vertex to this graph if not already present.GraphType
getType()
Get the graph type.boolean
removeAllEdges(java.util.Collection<? extends E> edges)
Removes all the edges in this graph that are also contained in the specified edge collection.java.util.Set<E>
removeAllEdges(V sourceVertex, V targetVertex)
Removes all the edges going from the specified source vertex to the specified target vertex, and returns a set of all removed edges.boolean
removeAllVertices(java.util.Collection<? extends V> vertices)
Removes all the vertices in this graph that are also contained in the specified vertex collection.boolean
removeEdge(E e)
Removes the specified edge from the graph.E
removeEdge(V sourceVertex, V targetVertex)
Removes an edge going from source vertex to target vertex, if such vertices and such edge exist in this graph.boolean
removeVertex(V v)
Removes the specified vertex from this graph including all its touching edges if present.-
Methods inherited from class org.jgrapht.graph.GraphDelegator
addVertex, containsEdge, containsVertex, degreeOf, edgeSet, edgesOf, getAllEdges, getDelegate, getEdge, getEdgeSource, getEdgeSupplier, getEdgeTarget, getEdgeWeight, getVertexSupplier, incomingEdgesOf, inDegreeOf, outDegreeOf, outgoingEdgesOf, setEdgeWeight, toString, vertexSet
-
Methods inherited from class org.jgrapht.graph.AbstractGraph
assertVertexExist, containsEdge, equals, hashCode, removeAllEdges, toStringFromSets
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.jgrapht.Graph
containsEdge, setEdgeWeight
-
-
-
-
Method Detail
-
addEdge
public E addEdge(V sourceVertex, V targetVertex)
Description copied from class:GraphDelegator
Creates a new edge in this graph, going from the source vertex to the target vertex, and returns the created edge. Some graphs do not allow edge-multiplicity. In such cases, if the graph already contains an edge from the specified source to the specified target, than this method does not change the graph and returnsnull
.The source and target vertices must already be contained in this graph. If they are not found in graph
IllegalArgumentException
is thrown.This method creates the new edge
e
using this graph's edge supplier (seeGraph.getEdgeSupplier()
). For the new edge to be addede
must not be equal to any other edge the graph (even if the graph allows edge-multiplicity). More formally, the graph must not contain any edgee2
such thate2.equals(e)
. If suche2
is found then the newly created edgee
is abandoned, the method leaves this graph unchanged and returnsnull
.If the underlying graph implementation's
Graph.getEdgeSupplier()
returnsnull
, then this method cannot create edges and throws anUnsupportedOperationException
.- Specified by:
addEdge
in interfaceGraph<V,E>
- Overrides:
addEdge
in classGraphDelegator<V,E>
- Parameters:
sourceVertex
- source vertex of the edge.targetVertex
- target vertex of the edge.- Returns:
- The newly created edge if added to the graph, otherwise
null
. - See Also:
Graph.addEdge(Object, Object)
-
addEdge
public boolean addEdge(V sourceVertex, V targetVertex, E e)
Description copied from class:GraphDelegator
Adds the specified edge to this graph, going from the source vertex to the target vertex. More formally, adds the specified edge,e
, to this graph if this graph contains no edgee2
such thate2.equals(e)
. If this graph already contains such an edge, the call leaves this graph unchanged and returnsfalse
. Some graphs do not allow edge-multiplicity. In such cases, if the graph already contains an edge from the specified source to the specified target, than this method does not change the graph and returnsfalse
. If the edge was added to the graph, returnstrue
.The source and target vertices must already be contained in this graph. If they are not found in graph IllegalArgumentException is thrown.
- Specified by:
addEdge
in interfaceGraph<V,E>
- Overrides:
addEdge
in classGraphDelegator<V,E>
- Parameters:
sourceVertex
- source vertex of the edge.targetVertex
- target vertex of the edge.e
- edge to be added to this graph.- Returns:
true
if this graph did not already contain the specified edge.- See Also:
Graph.addEdge(Object, Object, Object)
-
addVertex
public boolean addVertex(V v)
Description copied from class:GraphDelegator
Adds the specified vertex to this graph if not already present. More formally, adds the specified vertex,v
, to this graph if this graph contains no vertexu
such thatu.equals(v)
. If this graph already contains such vertex, the call leaves this graph unchanged and returnsfalse
. In combination with the restriction on constructors, this ensures that graphs never contain duplicate vertices.- Specified by:
addVertex
in interfaceGraph<V,E>
- Overrides:
addVertex
in classGraphDelegator<V,E>
- Parameters:
v
- vertex to be added to this graph.- Returns:
true
if this graph did not already contain the specified vertex.- See Also:
Graph.addVertex(Object)
-
removeAllEdges
public boolean removeAllEdges(java.util.Collection<? extends E> edges)
Description copied from interface:Graph
Removes all the edges in this graph that are also contained in the specified edge collection. After this call returns, this graph will contain no edges in common with the specified edges. This method will invoke theGraph.removeEdge(Object)
method.- Specified by:
removeAllEdges
in interfaceGraph<V,E>
- Overrides:
removeAllEdges
in classAbstractGraph<V,E>
- Parameters:
edges
- edges to be removed from this graph.- Returns:
true
if this graph changed as a result of the call- See Also:
Graph.removeAllEdges(Collection)
-
removeAllEdges
public java.util.Set<E> removeAllEdges(V sourceVertex, V targetVertex)
Description copied from interface:Graph
Removes all the edges going from the specified source vertex to the specified target vertex, and returns a set of all removed edges. Returnsnull
if any of the specified vertices does not exist in the graph. If both vertices exist but no edge is found, returns an empty set. This method will either invoke theGraph.removeEdge(Object)
method, or theGraph.removeEdge(Object, Object)
method.- Specified by:
removeAllEdges
in interfaceGraph<V,E>
- Overrides:
removeAllEdges
in classAbstractGraph<V,E>
- Parameters:
sourceVertex
- source vertex of the edge.targetVertex
- target vertex of the edge.- Returns:
- the removed edges, or
null
if either vertex is not part of graph - See Also:
Graph.removeAllEdges(Object, Object)
-
removeAllVertices
public boolean removeAllVertices(java.util.Collection<? extends V> vertices)
Description copied from interface:Graph
Removes all the vertices in this graph that are also contained in the specified vertex collection. After this call returns, this graph will contain no vertices in common with the specified vertices. This method will invoke theGraph.removeVertex(Object)
method.- Specified by:
removeAllVertices
in interfaceGraph<V,E>
- Overrides:
removeAllVertices
in classAbstractGraph<V,E>
- Parameters:
vertices
- vertices to be removed from this graph.- Returns:
true
if this graph changed as a result of the call- See Also:
Graph.removeAllVertices(Collection)
-
removeEdge
public boolean removeEdge(E e)
Description copied from class:GraphDelegator
Removes the specified edge from the graph. Removes the specified edge from this graph if it is present. More formally, removes an edgee2
such thate2.equals(e)
, if the graph contains such edge. Returnstrue
if the graph contained the specified edge. (The graph will not contain the specified edge once the call returns).If the specified edge is
null
returnsfalse
.- Specified by:
removeEdge
in interfaceGraph<V,E>
- Overrides:
removeEdge
in classGraphDelegator<V,E>
- Parameters:
e
- edge to be removed from this graph, if present.- Returns:
true
if and only if the graph contained the specified edge.- See Also:
Graph.removeEdge(Object)
-
removeEdge
public E removeEdge(V sourceVertex, V targetVertex)
Description copied from class:GraphDelegator
Removes an edge going from source vertex to target vertex, if such vertices and such edge exist in this graph. Returns the edge if removed ornull
otherwise.- Specified by:
removeEdge
in interfaceGraph<V,E>
- Overrides:
removeEdge
in classGraphDelegator<V,E>
- Parameters:
sourceVertex
- source vertex of the edge.targetVertex
- target vertex of the edge.- Returns:
- The removed edge, or
null
if no edge removed. - See Also:
Graph.removeEdge(Object, Object)
-
removeVertex
public boolean removeVertex(V v)
Description copied from class:GraphDelegator
Removes the specified vertex from this graph including all its touching edges if present. More formally, if the graph contains a vertexu
such thatu.equals(v)
, the call removes all edges that touchu
and then removesu
itself. If no suchu
is found, the call leaves the graph unchanged. Returnstrue
if the graph contained the specified vertex. (The graph will not contain the specified vertex once the call returns).If the specified vertex is
null
returnsfalse
.- Specified by:
removeVertex
in interfaceGraph<V,E>
- Overrides:
removeVertex
in classGraphDelegator<V,E>
- Parameters:
v
- vertex to be removed from this graph, if present.- Returns:
true
if the graph contained the specified vertex;false
otherwise.- See Also:
Graph.removeVertex(Object)
-
getType
public GraphType getType()
Get the graph type. The graph type can be used to query for additional metadata such as whether the graph supports directed or undirected edges, self-loops, multiple (parallel) edges, weights, etc.
-
-