JTS Topology Suite version 1.13

## com.vividsolutions.jts.planargraph
Class Edge

    java.lang.Object
      com.vividsolutions.jts.planargraph.GraphComponent
          com.vividsolutions.jts.planargraph.Edge

Direct Known Subclasses:
  LineMergeEdge

    public class Edge

extends GraphComponent

Represents an undirected edge of a `PlanarGraph`. An undirected edge in fact simply acts as a central point of reference for two opposite `DirectedEdge`s.

Usually a client using a `PlanarGraph` will subclass `Edge` to add its own application-specific data and methods.

Version:
  1.7

Field Summary
`protected DirectedEdge[]` `dirEdge` The two DirectedEdges associated with this Edge.

Fields inherited from class com.vividsolutions.jts.planargraph.GraphComponent
`isMarked, isVisited`

Constructor Summary
`Edge()` Constructs an Edge whose DirectedEdges are not yet set.
`Edge(DirectedEdge de0, DirectedEdge de1)` Constructs an Edge initialized with the given DirectedEdges, and for each DirectedEdge: sets the Edge, sets the symmetric DirectedEdge, and adds this Edge to its from-Node.

Method Summary
`DirectedEdge` `getDirEdge(int i)` Returns one of the DirectedEdges associated with this Edge.
`DirectedEdge` `getDirEdge(Node fromNode)` Returns the `DirectedEdge` that starts from the given node, or null if the node is not one of the two nodes associated with this Edge.
`Node` `getOppositeNode(Node node)` If `node` is one of the two nodes associated with this Edge, returns the other node; otherwise returns null.
`boolean` `isRemoved()` Tests whether this edge has been removed from its containing graph
`void` `setDirectedEdges(DirectedEdge de0, DirectedEdge de1)` Initializes this Edge's two DirectedEdges, and for each DirectedEdge: sets the Edge, sets the symmetric DirectedEdge, and adds this Edge to its from-Node.

Methods inherited from class com.vividsolutions.jts.planargraph.GraphComponent
`getComponentWithVisitedState, getContext, getData, isMarked, isVisited, setContext, setData, setMarked, setMarked, setVisited, setVisited`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### dirEdge

    protected DirectedEdge[] dirEdge

  The two DirectedEdges associated with this Edge. Index 0 is forward, 1 is reverse.

Constructor Detail

### Edge

    public Edge()

  Constructs an Edge whose DirectedEdges are not yet set. Be sure to call `setDirectedEdges(DirectedEdge, DirectedEdge)`

### Edge

    public Edge(DirectedEdge de0,
                DirectedEdge de1)

  Constructs an Edge initialized with the given DirectedEdges, and for each DirectedEdge: sets the Edge, sets the symmetric DirectedEdge, and adds this Edge to its from-Node.

Method Detail

### setDirectedEdges

    public void setDirectedEdges(DirectedEdge de0,
                                 DirectedEdge de1)

  Initializes this Edge's two DirectedEdges, and for each DirectedEdge: sets the Edge, sets the symmetric DirectedEdge, and adds this Edge to its from-Node.

### getDirEdge

    public DirectedEdge getDirEdge(int i)

  Returns one of the DirectedEdges associated with this Edge.

  Parameters:
    `i` - 0 or 1. 0 returns the forward directed edge, 1 returns the reverse

### getDirEdge

    public DirectedEdge getDirEdge(Node fromNode)

  Returns the `DirectedEdge` that starts from the given node, or null if the node is not one of the two nodes associated with this Edge.

### getOppositeNode

    public Node getOppositeNode(Node node)

  If `node` is one of the two nodes associated with this Edge, returns the other node; otherwise returns null.

### isRemoved

    public boolean isRemoved()

  Tests whether this edge has been removed from its containing graph

  Specified by:
    `isRemoved` in class `GraphComponent`
  Returns:
    `true` if this edge is removed

JTS Topology Suite version 1.13