org.jscience.computing.graph.events
Class GraphEdgeChangeEvent

java.lang.Object
  extended by java.util.EventObject
      extended by org.jscience.computing.graph.events.GraphChangeEvent
          extended by org.jscience.computing.graph.events.GraphEdgeChangeEvent
All Implemented Interfaces:
java.io.Serializable

public class GraphEdgeChangeEvent
extends GraphChangeEvent

An event which indicates that a graph edge has changed, or is about to change. The event can be used either as an indication after the edge has been added or removed, or before it is added. The type of the event can be tested using the org.jscience.computing.graph.event.GraphChangeEvent#getType() method.

Since:
Aug 10, 2003
See Also:
Serialized Form

Field Summary
static int BEFORE_EDGE_ADDED
          Before edge added event.
static int BEFORE_EDGE_REMOVED
          Before edge removed event.
static int EDGE_ADDED
          Edge added event.
static int EDGE_REMOVED
          Edge removed event.
protected  Edge m_edge
          The edge that this event is related to.
 
Fields inherited from class org.jscience.computing.graph.events.GraphChangeEvent
m_type
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
GraphEdgeChangeEvent(java.lang.Object eventSource, int type, Edge e)
          Constructor for GraphEdgeChangeEvent.
 
Method Summary
 Edge getEdge()
          Returns the edge that this event is related to.
 
Methods inherited from class org.jscience.computing.graph.events.GraphChangeEvent
getType
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

BEFORE_EDGE_ADDED

public static final int BEFORE_EDGE_ADDED
Before edge added event. This event is fired before an edge is added to a graph.

See Also:
Constant Field Values

BEFORE_EDGE_REMOVED

public static final int BEFORE_EDGE_REMOVED
Before edge removed event. This event is fired before an edge is removed from a graph.

See Also:
Constant Field Values

EDGE_ADDED

public static final int EDGE_ADDED
Edge added event. This event is fired after an edge is added to a graph.

See Also:
Constant Field Values

EDGE_REMOVED

public static final int EDGE_REMOVED
Edge removed event. This event is fired after an edge is removed from a graph.

See Also:
Constant Field Values

m_edge

protected Edge m_edge
The edge that this event is related to.

Constructor Detail

GraphEdgeChangeEvent

public GraphEdgeChangeEvent(java.lang.Object eventSource,
                            int type,
                            Edge e)
Constructor for GraphEdgeChangeEvent.

Parameters:
eventSource - the source of this event.
type - the event type of this event.
e - the edge that this event is related to.
Method Detail

getEdge

public Edge getEdge()
Returns the edge that this event is related to.

Returns:
the edge that this event is related to.