org.eclipse.gef4.graph

Class Edge

java.lang.Object

org.eclipse.gef4.graph.Edge

All Implemented Interfaces:

org.eclipse.gef4.common.properties.IPropertyChangeNotifier

public final class Edge
extends java.lang.Object
implements org.eclipse.gef4.common.properties.IPropertyChangeNotifier

An Edge represents a (directed) connection between two Nodes in a Graph.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Edge.Builder The Edge.Builder can be used to construct an Edge little by little.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTES_PROPERTY The property name that is used to notify change listeners about changes made to the attributes of this Edge.

Constructor Summary

Constructors

Constructor and Description
Edge(java.util.Map<java.lang.String,java.lang.Object> attrs, Node source, Node target) Constructs a new Edge which connects the given source Node with the given target Node.
Edge(Node source, Node target) Constructs a new Edge which connects the given source Node with the given target Node.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
boolean	equals(java.lang.Object that)
java.util.Map<java.lang.String,java.lang.Object>	getAttrs() Returns the attributes map of this Edge by reference.
Graph	getGraph() Returns the Graph to which this Edge belongs.
Node	getSource() Returns the source Node of this Edge.
Node	getTarget() Returns the target Node of this Edge.
int	hashCode()
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	setGraph(Graph graph) Sets the Graph to which this Edge belongs to the given value.
void	setSource(Node source) Sets the source Node of this Edge to the given value.
void	setTarget(Node target) Sets the target Node of this Edge to the given value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ATTRIBUTES_PROPERTY

public static final java.lang.String ATTRIBUTES_PROPERTY

The property name that is used to notify change listeners about changes made to the attributes of this Edge. A property change event for this property will have its old value set to a Map<String, Object> holding the old attributes and its new value set to a Map<String, Object> holding the new attributes.

See Also:

Constant Field Values

Constructor Detail

Edge

public Edge(java.util.Map<java.lang.String,java.lang.Object> attrs,
            Node source,
            Node target)

Constructs a new Edge which connects the given source Node with the given target Node. The given attributes are copied into the attributes map of this Edge.

Parameters:

attrs - A Map containing the attributes which are copied into the attributes map of this Edge.

source - The source Node for this Edge.

target - The target Node for this Edge.

Edge

public Edge(Node source,
            Node target)

Constructs a new Edge which connects the given source Node with the given target Node.

Parameters:

source - The source Node for this Edge.

target - The target Node for this Edge.

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface org.eclipse.gef4.common.properties.IPropertyChangeNotifier

equals

public boolean equals(java.lang.Object that)

Overrides:

equals in class java.lang.Object

getAttrs

public java.util.Map<java.lang.String,java.lang.Object> getAttrs()

Returns the attributes map of this Edge by reference. When this map is changed, a PropertyChangeEvent is fired for the ATTRIBUTES_PROPERTY.

Returns:

The attributes map of this Edge by reference.

getGraph

public Graph getGraph()

Returns the Graph to which this Edge belongs.

Returns:

The Graph to which this Edge belongs.

getSource

public Node getSource()

Returns the source Node of this Edge.

Returns:

The source Node of this Edge.

getTarget

public Node getTarget()

Returns the target Node of this Edge.

Returns:

The target Node of this Edge.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface org.eclipse.gef4.common.properties.IPropertyChangeNotifier

setGraph

public void setGraph(Graph graph)

Sets the Graph to which this Edge belongs to the given value.

Parameters:

graph - The new Graph for this Edge.

setSource

public void setSource(Node source)

Sets the source Node of this Edge to the given value.

Parameters:

source - The new source Node for this Edge.

setTarget

public void setTarget(Node target)

Sets the target Node of this Edge to the given value.

Parameters:

target - The new target Node for this Edge.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object