## Uses of Class
org.apache.tinkerpop.gremlin.structure.Direction

- Packages that use Direction
  Package | Description
  --- | ---
  org.apache.tinkerpop.gremlin.process.computer |
  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 Direction in org.apache.tinkerpop.gremlin.process.computer

    Methods in org.apache.tinkerpop.gremlin.process.computer with parameters of type Direction
    Modifier and Type | Method and Description
    --- | ---
    `GraphFilter.Legal` | GraphFilter.`checkEdgeLegality(Direction direction)` Get the legality of a particular edge direction.
    `GraphFilter.Legal` | GraphFilter.`checkEdgeLegality(Direction direction, String label)` Get the legality of a particular edge direction and label.
    `Set<String>` | GraphFilter.`getLegallyPositiveEdgeLabels(Direction direction)` For a particular edge directionality, get all the `GraphFilter.Legal.YES` or `GraphFilter.Legal.MAYBE` edge labels.

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

    Methods in org.apache.tinkerpop.gremlin.process.computer.search.path with parameters of type Direction
    Modifier and Type | Method and Description
    --- | ---
    `ShortestPathVertexProgram.Builder` | ShortestPathVertexProgram.Builder.`edgeDirection(Direction direction)`

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

    Methods in org.apache.tinkerpop.gremlin.process.traversal.dsl.graph with parameters of type Direction
    Modifier and Type | Method and Description
    --- | ---
    `default GraphTraversal<S,Vertex>` | GraphTraversal.`to(Direction direction, String... edgeLabels)` Map the `Vertex` to its adjacent vertices given a direction and edge labels.
    `default GraphTraversal<S,Edge>` | GraphTraversal.`toE(Direction direction, String... edgeLabels)` Map the `Vertex` to its incident edges given the direction and edge labels.
    `default GraphTraversal<S,Vertex>` | GraphTraversal.`toV(Direction direction)` Map the `Edge` to its incident vertices given the direction.

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

    Fields in org.apache.tinkerpop.gremlin.structure declared as Direction
    Modifier and Type | Field and Description
    --- | ---
    `static Direction[]` | Direction.`proper` The actual direction of an `Edge` may only be `IN` or `OUT`, as defined in this array.

    Methods in org.apache.tinkerpop.gremlin.structure that return Direction
    Modifier and Type | Method and Description
    --- | ---
    `Direction` | Direction.`opposite()` Produce the opposite representation of the current `Direction` enum.
    `static Direction` | Direction.`valueOf(String name)` Returns the enum constant of this type with the specified name.
    `static Direction[]` | Direction.`values()` Returns an array containing the constants of this enum type, in the order they are declared.

    Methods in org.apache.tinkerpop.gremlin.structure with parameters of type Direction
    Modifier and Type | Method and Description
    --- | ---
    `Iterator<Edge>` | Vertex.`edges(Direction direction, String... edgeLabels)` Gets an `Iterator` of incident edges.
    `Iterator<Vertex>` | Edge.`vertices(Direction direction)` Retrieve the vertex (or vertices) associated with this edge as defined by the direction.
    `Iterator<Vertex>` | Vertex.`vertices(Direction direction, String... edgeLabels)` Gets an `Iterator` of adjacent vertices.

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

    Methods in org.apache.tinkerpop.gremlin.structure.io with parameters of type Direction
    Modifier and Type | Method and Description
    --- | ---
    `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)`.
    `void` | GraphWriter.`writeVertex(OutputStream outputStream, Vertex v, Direction direction)` Write a vertex to a stream with its associated edges.
    `default void` | GraphWriter.`writeVertices(OutputStream outputStream, Iterator<Vertex> vertexIterator, Direction direction)` Write a list of vertices from a `Traversal` to a stream with its associated edges.

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

    Methods in org.apache.tinkerpop.gremlin.structure.io.graphml with parameters of type Direction
    Modifier and Type | Method and Description
    --- | ---
    `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.
    `void` | GraphMLWriter.`writeVertex(OutputStream outputStream, Vertex v, Direction direction)` This method is not supported for this writer.
    `void` | GraphMLWriter.`writeVertices(OutputStream outputStream, Iterator<Vertex> vertexIterator, Direction direction)` This method is not supported for this writer.

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

    Methods in org.apache.tinkerpop.gremlin.structure.io.graphson with parameters of type Direction
    Modifier and Type | Method and Description
    --- | ---
    `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)`.
    `void` | GraphSONWriter.`writeVertex(OutputStream outputStream, Vertex v, Direction direction)` Writes a single `Vertex` to stream where edges only from the specified direction are written.
    `void` | GraphSONWriter.`writeVertices(OutputStream outputStream, Iterator<Vertex> vertexIterator, Direction direction)` Writes a list of vertices in adjacency list format where vertices are written with edges from both directions.

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

    Methods in org.apache.tinkerpop.gremlin.structure.io.gryo with parameters of type Direction
    Modifier and Type | Method and Description
    --- | ---
    `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)`.
    `void` | GryoWriter.`writeVertex(OutputStream outputStream, Vertex v, Direction direction)` Write a vertex to a stream with its associated edges.
    `void` | GryoWriter.`writeVertices(OutputStream outputStream, Iterator<Vertex> vertexIterator, Direction direction)` Write a list of vertices from a `Traversal` to a stream with its associated edges.

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