Class DefaultListenableGraph<V,E>
- All Implemented Interfaces:
Serializable
,Cloneable
,Graph<V,
,E> ListenableGraph<V,
E>
- Direct Known Subclasses:
ListenableDirectedGraph
,ListenableUndirectedGraph
GraphListener
s and by
VertexSetListener
s. Operations on this graph "pass through" to the to
the backing graph. Any modification made to this graph or the backing graph
is reflected by the other.
This graph does not pass the hashCode and equals operations through to the backing graph, but relies on Object's equals and hashCode methods.
- Since:
- Jul 20, 2003
- Author:
- Barak Naveh
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new listenable graph.DefaultListenableGraph
(Graph<V, E> g, boolean reuseEvents) Creates a new listenable graph. -
Method Summary
Modifier and TypeMethodDescriptionCreates a new edge in this graph, going from the source vertex to the target vertex, and returns the created edge.boolean
Adds the specified edge to this graph, going from the source vertex to the target vertex.void
Adds the specified graph listener to this graph, if not already present.boolean
Adds the specified vertex to this graph if not already present.void
Adds the specified vertex set listener to this graph, if not already present.clone()
protected void
fireEdgeAdded
(E edge) Notify listeners that the specified edge was added.protected void
fireEdgeRemoved
(E edge) Notify listeners that the specified edge was removed.protected void
fireVertexAdded
(V vertex) Notify listeners that the specified vertex was added.protected void
fireVertexRemoved
(V vertex) Notify listeners that the specified vertex was removed.boolean
Tests whether thereuseEvents
flag is set.boolean
removeEdge
(E e) Removes the specified edge from the graph.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.void
Removes the specified graph listener from this graph, if present.boolean
removeVertex
(V v) Removes the specified vertex from this graph including all its touching edges if present.void
Removes the specified vertex set listener from this graph, if present.void
setReuseEvents
(boolean reuseEvents) If thereuseEvents
flag is set totrue
this class will reuse previously fired events and will not create a new object for each event.Methods inherited from class org.jgrapht.graph.GraphDelegator
containsEdge, containsVertex, degreeOf, edgeSet, edgesOf, getAllEdges, getEdge, getEdgeFactory, getEdgeSource, getEdgeTarget, getEdgeWeight, incomingEdgesOf, inDegreeOf, outDegreeOf, outgoingEdgesOf, setEdgeWeight, toString, vertexSet
Methods inherited from class org.jgrapht.graph.AbstractGraph
assertVertexExist, containsEdge, removeAllEdges, removeAllEdges, removeAllEdges, removeAllVertices, toStringFromSets
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.jgrapht.Graph
containsEdge, containsEdge, containsVertex, edgeSet, edgesOf, getAllEdges, getEdge, getEdgeFactory, getEdgeSource, getEdgeTarget, getEdgeWeight, removeAllEdges, removeAllEdges, removeAllVertices, vertexSet
-
Constructor Details
-
DefaultListenableGraph
Creates a new listenable graph.- Parameters:
g
- the backing graph.
-
DefaultListenableGraph
Creates a new listenable graph. If thereuseEvents
flag is set totrue
this class will reuse previously fired events and will not create a new object for each event. This option increases performance but should be used with care, especially in multithreaded environment.- Parameters:
g
- the backing graph.reuseEvents
- whether to reuse previously fired event objects instead of creating a new event object for each event.- Throws:
IllegalArgumentException
- if the backing graph is already a listenable graph.
-
-
Method Details
-
setReuseEvents
public void setReuseEvents(boolean reuseEvents) If thereuseEvents
flag is set totrue
this class will reuse previously fired events and will not create a new object for each event. This option increases performance but should be used with care, especially in multithreaded environment.- Parameters:
reuseEvents
- whether to reuse previously fired event objects instead of creating a new event object for each event.
-
isReuseEvents
public boolean isReuseEvents()Tests whether thereuseEvents
flag is set. If the flag is set totrue
this class will reuse previously fired events and will not create a new object for each event. This option increases performance but should be used with care, especially in multithreaded environment.- Returns:
- the value of the
reuseEvents
flag.
-
addEdge
Description copied from interface:Graph
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'sEdgeFactory
. 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 returnsnull
. -
addEdge
Description copied from interface:Graph
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 returns false. 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:
-
addGraphListener
Description copied from interface:ListenableGraph
Adds the specified graph listener to this graph, if not already present.- Specified by:
addGraphListener
in interfaceListenableGraph<V,
E> - Parameters:
l
- the listener to be added.- See Also:
-
addVertex
Description copied from interface:Graph
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 returns false. In combination with the restriction on constructors, this ensures that graphs never contain duplicate vertices. -
addVertexSetListener
Description copied from interface:ListenableGraph
Adds the specified vertex set listener to this graph, if not already present.- Specified by:
addVertexSetListener
in interfaceListenableGraph<V,
E> - Parameters:
l
- the listener to be added.- See Also:
-
clone
-
removeEdge
Description copied from interface:Graph
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:
-
removeEdge
Description copied from interface:Graph
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. Returns true 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:
-
removeGraphListener
Description copied from interface:ListenableGraph
Removes the specified graph listener from this graph, if present.- Specified by:
removeGraphListener
in interfaceListenableGraph<V,
E> - Parameters:
l
- the listener to be removed.- See Also:
-
removeVertex
Description copied from interface:Graph
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. Returns true 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:
-
removeVertexSetListener
Description copied from interface:ListenableGraph
Removes the specified vertex set listener from this graph, if present.- Specified by:
removeVertexSetListener
in interfaceListenableGraph<V,
E> - Parameters:
l
- the listener to be removed.- See Also:
-
fireEdgeAdded
Notify listeners that the specified edge was added.- Parameters:
edge
- the edge that was added.
-
fireEdgeRemoved
Notify listeners that the specified edge was removed.- Parameters:
edge
- the edge that was removed.
-
fireVertexAdded
Notify listeners that the specified vertex was added.- Parameters:
vertex
- the vertex that was added.
-
fireVertexRemoved
Notify listeners that the specified vertex was removed.- Parameters:
vertex
- the vertex that was removed.
-