## Uses of Interface
org.apache.tinkerpop.gremlin.structure.Edge

- Packages that use Edge
  Package | Description
  --- | ---
  org.apache.tinkerpop.gremlin.driver |
  org.apache.tinkerpop.gremlin.process.computer |
  org.apache.tinkerpop.gremlin.process.computer.clustering.connected |
  org.apache.tinkerpop.gremlin.process.computer.clustering.peerpressure |
  org.apache.tinkerpop.gremlin.process.computer.ranking.pagerank |
  org.apache.tinkerpop.gremlin.process.computer.search.path |
  org.apache.tinkerpop.gremlin.process.traversal.dsl.graph |
  org.apache.tinkerpop.gremlin.structure |
  org.apache.tinkerpop.gremlin.structure.io |
  org.apache.tinkerpop.gremlin.structure.io.graphml |
  org.apache.tinkerpop.gremlin.structure.io.graphson |
  org.apache.tinkerpop.gremlin.structure.io.gryo |

- - ### Uses of Edge in org.apache.tinkerpop.gremlin.driver

    Methods in org.apache.tinkerpop.gremlin.driver that return Edge
    Modifier and Type | Method and Description
    --- | ---
    `Edge` | Result.`getEdge()` Gets the result item by casting it to an `Edge`.

  - ### Uses of Edge in org.apache.tinkerpop.gremlin.process.computer

    Fields in org.apache.tinkerpop.gremlin.process.computer with type parameters of type Edge
    Modifier and Type | Field and Description
    --- | ---
    `BiFunction<M,Edge,M>` | MessageScope.Local.`edgeFunction`
    `Supplier<? extends Traversal<Vertex,Edge>>` | MessageScope.Local.`incidentTraversal`

    Methods in org.apache.tinkerpop.gremlin.process.computer that return types with arguments of type Edge
    Modifier and Type | Method and Description
    --- | ---
    `Traversal<Vertex,Edge>` | MessageScope.Local.ReverseTraversalSupplier.`get()`
    `Traversal.Admin<Vertex,Edge>` | GraphFilter.`getEdgeFilter()` Get the edge filter associated with this graph filter.
    `BiFunction<M,Edge,M>` | MessageScope.Local.`getEdgeFunction()`
    `Traversal<Vertex,Edge>` | Computer.`getEdges()`
    `Supplier<? extends Traversal<Vertex,Edge>>` | MessageScope.Local.`getIncidentTraversal()`
    `Iterator<Edge>` | GraphFilter.`legalEdges(Vertex vertex)` Returns an iterator of legal edges incident to the provided vertex.

    Method parameters in org.apache.tinkerpop.gremlin.process.computer with type arguments of type Edge
    Modifier and Type | Method and Description
    --- | ---
    `static IllegalArgumentException` | GraphComputer.Exceptions.`edgeFilterAccessesAdjacentVertices(Traversal<Vertex,Edge> edgeFilter)`
    `GraphComputer` | GraphComputer.`edges(Traversal<Vertex,Edge> edgeFilter)` Add a filter that will limit which edges of the vertices are loaded from the graph source.
    `Computer` | Computer.`edges(Traversal<Vertex,Edge> edgeFilter)`
    `static <M> MessageScope.Local<M>` | MessageScope.Local.`of(Supplier<? extends Traversal<Vertex,Edge>> incidentTraversal)`
    `static <M> MessageScope.Local<M>` | MessageScope.Local.`of(Supplier<? extends Traversal<Vertex,Edge>> incidentTraversal, BiFunction<M,Edge,M> edgeFunction)`
    `static <M> MessageScope.Local<M>` | MessageScope.Local.`of(Supplier<? extends Traversal<Vertex,Edge>> incidentTraversal, BiFunction<M,Edge,M> edgeFunction)`
    `void` | GraphFilter.`setEdgeFilter(Traversal<Vertex,Edge> edgeFilter)` Set the filter for selecting edges from the source graph.

  - ### Uses of Edge in org.apache.tinkerpop.gremlin.process.computer.clustering.connected

    Method parameters in org.apache.tinkerpop.gremlin.process.computer.clustering.connected with type arguments of type Edge
    Modifier and Type | Method and Description
    --- | ---
    `ConnectedComponentVertexProgram.Builder` | ConnectedComponentVertexProgram.Builder.`edges(Traversal.Admin<Vertex,Edge> edgeTraversal)`

  - ### Uses of Edge in org.apache.tinkerpop.gremlin.process.computer.clustering.peerpressure

    Method parameters in org.apache.tinkerpop.gremlin.process.computer.clustering.peerpressure with type arguments of type Edge
    Modifier and Type | Method and Description
    --- | ---
    `PeerPressureVertexProgram.Builder` | PeerPressureVertexProgram.Builder.`edges(Traversal.Admin<Vertex,Edge> edgeTraversal)`
    `PeerPressureVertexProgram.Builder` | PeerPressureVertexProgram.Builder.`traversal(Traversal.Admin<Vertex,Edge> edgeTraversal)` Deprecated. As of release 3.2.0, replaced by `PeerPressureVertexProgram.Builder.edges(Traversal.Admin)`

  - ### Uses of Edge in org.apache.tinkerpop.gremlin.process.computer.ranking.pagerank

    Method parameters in org.apache.tinkerpop.gremlin.process.computer.ranking.pagerank with type arguments of type Edge
    Modifier and Type | Method and Description
    --- | ---
    `PageRankVertexProgram.Builder` | PageRankVertexProgram.Builder.`edges(Traversal.Admin<Vertex,Edge> edgeTraversal)`
    `PageRankVertexProgram.Builder` | PageRankVertexProgram.Builder.`traversal(Traversal.Admin<Vertex,Edge> traversal)` Deprecated. As of release 3.2.0, replaced by `PageRankVertexProgram.Builder.edges(Traversal.Admin)`

  - ### Uses of Edge in org.apache.tinkerpop.gremlin.process.computer.search.path

    Fields in org.apache.tinkerpop.gremlin.process.computer.search.path with type parameters of type Edge
    Modifier and Type | Field and Description
    --- | ---
    `static org.apache.tinkerpop.gremlin.process.traversal.util.PureTraversal<Edge,Number>` | ShortestPathVertexProgram.`DEFAULT_DISTANCE_TRAVERSAL`
    `static org.apache.tinkerpop.gremlin.process.traversal.util.PureTraversal<Vertex,Edge>` | ShortestPathVertexProgram.`DEFAULT_EDGE_TRAVERSAL`

    Methods in org.apache.tinkerpop.gremlin.process.computer.search.path that return types with arguments of type Edge
    Modifier and Type | Method and Description
    --- | ---
    `VertexProgram<org.javatuples.Triplet<Path,Edge,Number>>` | ShortestPathVertexProgram.`clone()`

    Method parameters in org.apache.tinkerpop.gremlin.process.computer.search.path with type arguments of type Edge
    Modifier and Type | Method and Description
    --- | ---
    `ShortestPathVertexProgram.Builder` | ShortestPathVertexProgram.Builder.`distanceTraversal(Traversal<Edge,Number> distanceTraversal)`
    `ShortestPathVertexProgram.Builder` | ShortestPathVertexProgram.Builder.`edgeTraversal(Traversal<Vertex,Edge> edgeTraversal)`
    `void` | ShortestPathVertexProgram.`execute(Vertex vertex, Messenger<org.javatuples.Triplet<Path,Edge,Number>> messenger, Memory memory)`

  - ### Uses of Edge in org.apache.tinkerpop.gremlin.process.traversal.dsl.graph

    Methods in org.apache.tinkerpop.gremlin.process.traversal.dsl.graph that return types with arguments of type Edge
    Modifier and Type | Method and Description
    --- | ---
    `default GraphTraversal<S,Edge>` | GraphTraversal.`addE(String edgeLabel)` Adds an `Edge` with the specified edge label.
    `GraphTraversal<Edge,Edge>` | GraphTraversalSource.`addE(String label)` Spawns a `GraphTraversal` by adding a edge with the specified label.
    `GraphTraversal<Edge,Edge>` | GraphTraversalSource.`addE(String label)` Spawns a `GraphTraversal` by adding a edge with the specified label.
    `default GraphTraversal<S,Edge>` | GraphTraversal.`addE(Traversal<?,String> edgeLabelTraversal)` Adds a `Edge` with an edge label determined by a `Traversal`.
    `GraphTraversal<Edge,Edge>` | GraphTraversalSource.`addE(Traversal<?,String> edgeLabelTraversal)` Spawns a `GraphTraversal` by adding a edge with a label as specified by the provided `Traversal`.
    `GraphTraversal<Edge,Edge>` | GraphTraversalSource.`addE(Traversal<?,String> edgeLabelTraversal)` Spawns a `GraphTraversal` by adding a edge with a label as specified by the provided `Traversal`.
    `default GraphTraversal<S,Edge>` | GraphTraversal.`bothE(String... edgeLabels)` Map the `Vertex` to its incident edges given the edge labels.
    `GraphTraversal<Edge,Edge>` | GraphTraversalSource.`E(Object... edgesIds)` Spawns a `GraphTraversal` starting with all edges or some subset of edges as specified by their unique identifier.
    `GraphTraversal<Edge,Edge>` | GraphTraversalSource.`E(Object... edgesIds)` Spawns a `GraphTraversal` starting with all edges or some subset of edges as specified by their unique identifier.
    `default GraphTraversal<S,Edge>` | GraphTraversal.`inE(String... edgeLabels)` Map the `Vertex` to its incoming incident edges given the edge labels.
    `default GraphTraversal<S,Edge>` | GraphTraversal.`outE(String... edgeLabels)` Map the `Vertex` to its outgoing incident edges given the edge labels.
    `default GraphTraversal<S,Edge>` | GraphTraversal.`subgraph(String sideEffectKey)` Extracts a portion of the graph being traversed into a `Graph` object held in the specified side-effect key.
    `default GraphTraversal<S,Edge>` | GraphTraversal.`toE(Direction direction, String... edgeLabels)` Map the `Vertex` to its incident edges given the direction and edge labels.

  - ### Uses of Edge in org.apache.tinkerpop.gremlin.structure

    Methods in org.apache.tinkerpop.gremlin.structure that return Edge
    Modifier and Type | Method and Description
    --- | ---
    `Edge` | Vertex.`addEdge(String label, Vertex inVertex, Object... keyValues)` Add an outgoing edge to the vertex with provided label and edge properties as key/value pairs.

    Methods in org.apache.tinkerpop.gremlin.structure that return types with arguments of type Edge
    Modifier and Type | Method and Description
    --- | ---
    `Iterator<Edge>` | Vertex.`edges(Direction direction, String... edgeLabels)` Gets an `Iterator` of incident edges.
    `Iterator<Edge>` | Graph.`edges(Object... edgeIds)` Get the `Edge` objects in this graph with the provided edge ids or `Edge` objects.

  - ### Uses of Edge in org.apache.tinkerpop.gremlin.structure.io

    Methods in org.apache.tinkerpop.gremlin.structure.io that return Edge
    Modifier and Type | Method and Description
    --- | ---
    `Edge` | GraphReader.`readEdge(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod)` Reads a single edge from an `InputStream`.

    Methods in org.apache.tinkerpop.gremlin.structure.io with parameters of type Edge
    Modifier and Type | Method and Description
    --- | ---
    `void` | GraphWriter.`writeEdge(OutputStream outputStream, Edge e)` Write an edge to a stream.

    Method parameters in org.apache.tinkerpop.gremlin.structure.io with type arguments of type Edge
    Modifier and Type | Method and Description
    --- | ---
    `Edge` | GraphReader.`readEdge(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod)` Reads a single edge from an `InputStream`.
    `Edge` | GraphReader.`readEdge(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod)` Reads a single edge from an `InputStream`.
    `Vertex` | GraphReader.`readVertex(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Vertex>,Vertex> vertexAttachMethod, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Reads a single vertex from an `InputStream`.
    `Vertex` | GraphReader.`readVertex(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Vertex>,Vertex> vertexAttachMethod, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Reads a single vertex from an `InputStream`.
    `Iterator<Vertex>` | GraphReader.`readVertices(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Vertex>,Vertex> vertexAttachMethod, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Reads a set of one or more vertices from an `InputStream` which were written by `GraphWriter.writeVertices(OutputStream, Iterator)`.
    `Iterator<Vertex>` | GraphReader.`readVertices(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Vertex>,Vertex> vertexAttachMethod, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Reads a set of one or more vertices from an `InputStream` which were written by `GraphWriter.writeVertices(OutputStream, Iterator)`.

  - ### Uses of Edge in org.apache.tinkerpop.gremlin.structure.io.graphml

    Methods in org.apache.tinkerpop.gremlin.structure.io.graphml that return Edge
    Modifier and Type | Method and Description
    --- | ---
    `Edge` | GraphMLReader.`readEdge(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod)` This method is not supported for this reader.

    Methods in org.apache.tinkerpop.gremlin.structure.io.graphml with parameters of type Edge
    Modifier and Type | Method and Description
    --- | ---
    `void` | GraphMLWriter.`writeEdge(OutputStream outputStream, Edge e)` This method is not supported for this writer.

    Method parameters in org.apache.tinkerpop.gremlin.structure.io.graphml with type arguments of type Edge
    Modifier and Type | Method and Description
    --- | ---
    `Edge` | GraphMLReader.`readEdge(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod)` This method is not supported for this reader.
    `Edge` | GraphMLReader.`readEdge(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod)` This method is not supported for this reader.
    `Vertex` | GraphMLReader.`readVertex(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Vertex>,Vertex> vertexAttachMethod, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` This method is not supported for this reader.
    `Vertex` | GraphMLReader.`readVertex(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Vertex>,Vertex> vertexAttachMethod, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` This method is not supported for this reader.
    `Iterator<Vertex>` | GraphMLReader.`readVertices(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Vertex>,Vertex> vertexAttachMethod, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` This method is not supported for this reader.
    `Iterator<Vertex>` | GraphMLReader.`readVertices(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Vertex>,Vertex> vertexAttachMethod, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` This method is not supported for this reader.

  - ### Uses of Edge in org.apache.tinkerpop.gremlin.structure.io.graphson

    Methods in org.apache.tinkerpop.gremlin.structure.io.graphson that return Edge
    Modifier and Type | Method and Description
    --- | ---
    `Edge` | GraphSONReader.`readEdge(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod)` Read an `Edge` from output generated by `GraphSONWriter.writeEdge(OutputStream, Edge)` or via an `Edge` passed to `GraphSONWriter.writeObject(OutputStream, Object)`.

    Methods in org.apache.tinkerpop.gremlin.structure.io.graphson with parameters of type Edge
    Modifier and Type | Method and Description
    --- | ---
    `void` | GraphSONWriter.`writeEdge(OutputStream outputStream, Edge e)` Writes an `Edge` object to the stream.

    Method parameters in org.apache.tinkerpop.gremlin.structure.io.graphson with type arguments of type Edge
    Modifier and Type | Method and Description
    --- | ---
    `Edge` | GraphSONReader.`readEdge(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod)` Read an `Edge` from output generated by `GraphSONWriter.writeEdge(OutputStream, Edge)` or via an `Edge` passed to `GraphSONWriter.writeObject(OutputStream, Object)`.
    `Edge` | GraphSONReader.`readEdge(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod)` Read an `Edge` from output generated by `GraphSONWriter.writeEdge(OutputStream, Edge)` or via an `Edge` passed to `GraphSONWriter.writeObject(OutputStream, Object)`.
    `Vertex` | GraphSONReader.`readVertex(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Vertex>,Vertex> vertexAttachMethod, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Read a `Vertex` from output generated by any of the `GraphSONWriter` `writeVertex` or `writeVertices` methods or by `GraphSONWriter.writeGraph(OutputStream, Graph)`.
    `Vertex` | GraphSONReader.`readVertex(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Vertex>,Vertex> vertexAttachMethod, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Read a `Vertex` from output generated by any of the `GraphSONWriter` `writeVertex` or `writeVertices` methods or by `GraphSONWriter.writeGraph(OutputStream, Graph)`.
    `Iterator<Vertex>` | GraphSONReader.`readVertices(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Vertex>,Vertex> vertexAttachMethod, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Read `Vertex` objects from output generated by any of the `GraphSONWriter` `writeVertex` or `writeVertices` methods or by `GraphSONWriter.writeGraph(OutputStream, Graph)`.
    `Iterator<Vertex>` | GraphSONReader.`readVertices(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Vertex>,Vertex> vertexAttachMethod, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Read `Vertex` objects from output generated by any of the `GraphSONWriter` `writeVertex` or `writeVertices` methods or by `GraphSONWriter.writeGraph(OutputStream, Graph)`.

  - ### Uses of Edge in org.apache.tinkerpop.gremlin.structure.io.gryo

    Methods in org.apache.tinkerpop.gremlin.structure.io.gryo that return Edge
    Modifier and Type | Method and Description
    --- | ---
    `Edge` | GryoReader.`readEdge(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod)` Read an `Edge` from output generated by `GryoWriter.writeEdge(OutputStream, Edge)` or via an `Edge` passed to `GryoWriter.writeObject(OutputStream, Object)`.

    Methods in org.apache.tinkerpop.gremlin.structure.io.gryo with parameters of type Edge
    Modifier and Type | Method and Description
    --- | ---
    `void` | GryoWriter.`writeEdge(OutputStream outputStream, Edge e)` Write an edge to a stream.

    Method parameters in org.apache.tinkerpop.gremlin.structure.io.gryo with type arguments of type Edge
    Modifier and Type | Method and Description
    --- | ---
    `Edge` | GryoReader.`readEdge(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod)` Read an `Edge` from output generated by `GryoWriter.writeEdge(OutputStream, Edge)` or via an `Edge` passed to `GryoWriter.writeObject(OutputStream, Object)`.
    `Edge` | GryoReader.`readEdge(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod)` Read an `Edge` from output generated by `GryoWriter.writeEdge(OutputStream, Edge)` or via an `Edge` passed to `GryoWriter.writeObject(OutputStream, Object)`.
    `Vertex` | GryoReader.`readVertex(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Vertex>,Vertex> vertexAttachMethod, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Read a `Vertex` from output generated by any of the `GryoWriter` `writeVertex` or `writeVertices` methods or by `GryoWriter.writeGraph(OutputStream, Graph)`.
    `Vertex` | GryoReader.`readVertex(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Vertex>,Vertex> vertexAttachMethod, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Read a `Vertex` from output generated by any of the `GryoWriter` `writeVertex` or `writeVertices` methods or by `GryoWriter.writeGraph(OutputStream, Graph)`.
    `Iterator<Vertex>` | GryoReader.`readVertices(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Vertex>,Vertex> vertexAttachMethod, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Read `Vertex` objects from output generated by any of the `GryoWriter` `writeVertex` or `writeVertices` methods or by `GryoWriter.writeGraph(OutputStream, Graph)`.
    `Iterator<Vertex>` | GryoReader.`readVertices(InputStream inputStream, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Vertex>,Vertex> vertexAttachMethod, Function<org.apache.tinkerpop.gremlin.structure.util.Attachable<Edge>,Edge> edgeAttachMethod, Direction attachEdgesOfThisDirection)` Read `Vertex` objects from output generated by any of the `GryoWriter` `writeVertex` or `writeVertices` methods or by `GryoWriter.writeGraph(OutputStream, Graph)`.

Copyright © 2013–2021 Apache Software Foundation. All rights reserved.