 Type Parameters:
V
 the graph vertex typeE
 the graph edge type
 All Implemented Interfaces:
Serializable
,Cloneable
,Graph<V,
,E> ListenableGraph<V,
E>
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.
 Author:
 Barak Naveh
 See Also:

Field Summary
Fields inherited from interface org.jgrapht.Graph
DEFAULT_EDGE_WEIGHT

Constructor Summary
ConstructorDescriptionCreates 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.Creates a new vertex in this graph and returns it.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, V source, V target, double weight) Notify listeners that the specified edge was added.protected void
fireEdgeRemoved
(E edge, V source, V target, double weight) Notify listeners that the specified edge was removed.protected void
fireEdgeWeightUpdated
(E edge, V source, V target, double weight) Notify listeners that the weight of an edge has changed.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
setEdgeWeight
(E e, double weight) Assigns a weight to an edge.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, getDelegate, getEdge, getEdgeSource, getEdgeSupplier, getEdgeTarget, getEdgeWeight, getType, getVertexSupplier, incomingEdgesOf, inDegreeOf, outDegreeOf, outgoingEdgesOf, toString, vertexSet
Methods inherited from class org.jgrapht.graph.AbstractGraph
assertVertexExist, containsEdge, equals, hashCode, removeAllEdges, removeAllEdges, removeAllEdges, removeAllVertices, toStringFromSets
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.jgrapht.Graph
containsEdge, containsEdge, containsVertex, degreeOf, edgeSet, edgesOf, getAllEdges, getEdge, getEdgeSource, getEdgeSupplier, getEdgeTarget, getEdgeWeight, getType, getVertexSupplier, incomingEdgesOf, inDegreeOf, iterables, outDegreeOf, outgoingEdgesOf, removeAllEdges, removeAllEdges, removeAllVertices, setEdgeWeight, 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 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 edgemultiplicity. In such cases, if the graph already contains an edge from the specified source to the specified target, then 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 edgemultiplicity). 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
. 
addEdge
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 edgemultiplicity. In such cases, if the graph already contains an edge from the specified source to the specified target, then 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.

addVertex
Description copied from class:GraphDelegator
Creates a new vertex in this graph and returns it.This method creates the new vertex
v
using this graph's vertex supplier (seeGraph.getVertexSupplier()
). For the new vertex to be addedv
must not be equal to any other vertex in the graph. More formally, the graph must not contain any vertexv2
such thatv2.equals(v)
. If suchv2
is found then the newly created vertexv
is abandoned, the method leaves this graph unchanged and throws anIllegalArgumentException
.If the underlying graph implementation's
Graph.getVertexSupplier()
returnsnull
, then this method cannot create vertices and throws anUnsupportedOperationException
.Care must also be taken when interchanging calls to methods
Graph.addVertex(Object)
andGraph.addVertex()
. In such a case the user must make sure never to add vertices in the graph using methodGraph.addVertex(Object)
, which are going to be returned in the future by the supplied vertex supplier. Such a sequence will result into anIllegalArgumentException
when calling methodGraph.addVertex()
. 
addVertex
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. 
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.

clone

removeEdge
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.

removeEdge
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.

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.

removeVertex
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.

setEdgeWeight
Description copied from class:GraphDelegator
Assigns a weight to an edge. Specified by:
setEdgeWeight
in interfaceGraph<V,
E>  Overrides:
setEdgeWeight
in classGraphDelegator<V,
E>  Parameters:
e
 edge on which to set weightweight
 new weight for edge

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.

fireEdgeAdded
Notify listeners that the specified edge was added. Parameters:
edge
 the edge that was added.source
 edge sourcetarget
 edge targetweight
 edge weight

fireEdgeRemoved
Notify listeners that the specified edge was removed. Parameters:
edge
 the edge that was removed.source
 edge sourcetarget
 edge targetweight
 edge weight

fireEdgeWeightUpdated
Notify listeners that the weight of an edge has changed. Parameters:
edge
 the edge whose weight has changed.source
 edge sourcetarget
 edge targetweight
 the edge weight

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.
