## Uses of Interface
org.apache.tinkerpop.gremlin.process.traversal.Traversal

- Packages that use Traversal
  Package | Description
  --- | ---
  org.apache.tinkerpop.gremlin.driver |
  org.apache.tinkerpop.gremlin.process.computer |
  org.apache.tinkerpop.gremlin.process.computer.search.path |
  org.apache.tinkerpop.gremlin.process.traversal |
  org.apache.tinkerpop.gremlin.process.traversal.dsl.graph |

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

    Methods in org.apache.tinkerpop.gremlin.driver with parameters of type Traversal
    Modifier and Type | Method and Description
    --- | ---
    `ResultSet` | Client.`submit(Traversal traversal)` Submit a `Traversal` to the server for remote execution.Results are returned as `Traverser` instances and are therefore bulked, meaning that to properly iterate the contents of the result each `Traverser.bulk()` must be examined to determine the number of times that object should be presented in iteration.
    `CompletableFuture<ResultSet>` | Client.`submitAsync(Traversal traversal)` An asynchronous version of `Client.submit(Traversal)`.
    `CompletableFuture<ResultSet>` | Client.AliasClusteredClient.`submitAsync(Traversal traversal)`

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

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

    Methods in org.apache.tinkerpop.gremlin.process.computer that return Traversal
    Modifier and Type | Method and Description
    --- | ---
    `Traversal<Vertex,Edge>` | MessageScope.Local.ReverseTraversalSupplier.`get()`
    `Traversal<Vertex,Edge>` | Computer.`getEdges()`
    `Traversal<Vertex,Vertex>` | Computer.`getVertices()`

    Methods in org.apache.tinkerpop.gremlin.process.computer that return types with arguments of type Traversal
    Modifier and Type | Method and Description
    --- | ---
    `Supplier<? extends Traversal<Vertex,Edge>>` | MessageScope.Local.`getIncidentTraversal()`

    Methods in org.apache.tinkerpop.gremlin.process.computer with parameters of type Traversal
    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)`
    `void` | GraphFilter.`setEdgeFilter(Traversal<Vertex,Edge> edgeFilter)` Set the filter for selecting edges from the source graph.
    `void` | GraphFilter.`setVertexFilter(Traversal<Vertex,Vertex> vertexFilter)` Set the filter for selecting vertices from the source graph.
    `static IllegalArgumentException` | GraphComputer.Exceptions.`vertexFilterAccessesIncidentEdges(Traversal<Vertex,Vertex> vertexFilter)`
    `GraphComputer` | GraphComputer.`vertices(Traversal<Vertex,Vertex> vertexFilter)` Add a filter that will limit which vertices are loaded from the graph source.
    `Computer` | Computer.`vertices(Traversal<Vertex,Vertex> vertexFilter)`

    Method parameters in org.apache.tinkerpop.gremlin.process.computer with type arguments of type Traversal
    Modifier and Type | Method and Description
    --- | ---
    `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)`

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

    Methods in org.apache.tinkerpop.gremlin.process.computer.search.path with parameters of type Traversal
    Modifier and Type | Method and Description
    --- | ---
    `ShortestPathVertexProgram.Builder` | ShortestPathVertexProgram.Builder.`distanceTraversal(Traversal<Edge,Number> distanceTraversal)`
    `ShortestPathVertexProgram.Builder` | ShortestPathVertexProgram.Builder.`edgeTraversal(Traversal<Vertex,Edge> edgeTraversal)`
    `ShortestPathVertexProgram.Builder` | ShortestPathVertexProgram.Builder.`source(Traversal<Vertex,?> sourceVertexFilter)`
    `ShortestPathVertexProgram.Builder` | ShortestPathVertexProgram.Builder.`target(Traversal<Vertex,?> targetVertexFilter)`

  - ### Uses of Traversal in org.apache.tinkerpop.gremlin.process.traversal

    Subinterfaces of Traversal in org.apache.tinkerpop.gremlin.process.traversal
    Modifier and Type | Interface and Description
    --- | ---
    `static interface` | `Traversal.Admin<S,E>`

    Methods in org.apache.tinkerpop.gremlin.process.traversal that return Traversal
    Modifier and Type | Method and Description
    --- | ---
    `default <A,B> Traversal<A,B>` | Traversal.`iterate()` Iterate all the `Traverser` instances in the traversal.
    `default Traversal<S,E>` | Traversal.`none()` Filter all traversers in the traversal.
    `default Traversal<S,org.apache.tinkerpop.gremlin.process.traversal.util.TraversalMetrics>` | Traversal.`profile()` Profile the traversal.

    Methods in org.apache.tinkerpop.gremlin.process.traversal with parameters of type Traversal
    Modifier and Type | Method and Description
    --- | ---
    `default T` | Translator.`translate(Traversal<?,?> t)` Translates a `Traversal` into the specified form

    Method parameters in org.apache.tinkerpop.gremlin.process.traversal with type arguments of type Traversal
    Modifier and Type | Method and Description
    --- | ---
    `default <T> CompletableFuture<T>` | Traversal.`promise(Function<Traversal<S,E>,T> traversalFunction)` Starts a promise to execute a function on the current `Traversal` that will be completed in the future.

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

    Subinterfaces of Traversal in org.apache.tinkerpop.gremlin.process.traversal.dsl.graph
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `GraphTraversal<S,E>`
    `static interface` | `GraphTraversal.Admin<S,E>`

    Methods in org.apache.tinkerpop.gremlin.process.traversal.dsl.graph with parameters of type Traversal
    Modifier and Type | Method and Description
    --- | ---
    `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`.
    `default GraphTraversal<S,Vertex>` | GraphTraversal.`addV(Traversal<?,String> vertexLabelTraversal)` Adds a `Vertex` with a vertex label determined by a `Traversal`.
    `GraphTraversal<Vertex,Vertex>` | GraphTraversalSource.`addV(Traversal<?,String> vertexLabelTraversal)` Spawns a `GraphTraversal` by adding a vertex with the label as determined by a `Traversal`.
    `default GraphTraversal<S,E>` | GraphTraversal.`and(Traversal<?,?>... andTraversals)` Ensures that all of the provided traversals yield a result.
    `default <M,E2> GraphTraversal<S,E2>` | GraphTraversal.`branch(Traversal<?,M> branchTraversal)` Split the `Traverser` to all the specified traversals.
    `default GraphTraversal<S,E>` | GraphTraversal.`by(Traversal<?,?> traversal)` The `by()` can be applied to a number of different step to alter their behaviors.
    `default <V> GraphTraversal<S,E>` | GraphTraversal.`by(Traversal<?,?> traversal, Comparator<V> comparator)` The `by()` can be applied to a number of different step to alter their behaviors.
    `default <E2> GraphTraversal<S,E2>` | GraphTraversal.`choose(Predicate<E> choosePredicate, Traversal<?,E2> trueChoice)` Routes the current traverser to a particular traversal branch option which allows the creation of if-then like semantics within a traversal.
    `default <E2> GraphTraversal<S,E2>` | GraphTraversal.`choose(Predicate<E> choosePredicate, Traversal<?,E2> trueChoice, Traversal<?,E2> falseChoice)` Routes the current traverser to a particular traversal branch option which allows the creation of if-then-else like semantics within a traversal.
    `default <E2> GraphTraversal<S,E2>` | GraphTraversal.`choose(Predicate<E> choosePredicate, Traversal<?,E2> trueChoice, Traversal<?,E2> falseChoice)` Routes the current traverser to a particular traversal branch option which allows the creation of if-then-else like semantics within a traversal.
    `default <E2> GraphTraversal<S,E2>` | GraphTraversal.`choose(Traversal<?,?> traversalPredicate, Traversal<?,E2> trueChoice)` Routes the current traverser to a particular traversal branch option which allows the creation of if-then like semantics within a traversal.
    `default <E2> GraphTraversal<S,E2>` | GraphTraversal.`choose(Traversal<?,?> traversalPredicate, Traversal<?,E2> trueChoice)` Routes the current traverser to a particular traversal branch option which allows the creation of if-then like semantics within a traversal.
    `default <E2> GraphTraversal<S,E2>` | GraphTraversal.`choose(Traversal<?,?> traversalPredicate, Traversal<?,E2> trueChoice, Traversal<?,E2> falseChoice)` Routes the current traverser to a particular traversal branch option which allows the creation of if-then-else like semantics within a traversal.
    `default <E2> GraphTraversal<S,E2>` | GraphTraversal.`choose(Traversal<?,?> traversalPredicate, Traversal<?,E2> trueChoice, Traversal<?,E2> falseChoice)` Routes the current traverser to a particular traversal branch option which allows the creation of if-then-else like semantics within a traversal.
    `default <E2> GraphTraversal<S,E2>` | GraphTraversal.`choose(Traversal<?,?> traversalPredicate, Traversal<?,E2> trueChoice, Traversal<?,E2> falseChoice)` Routes the current traverser to a particular traversal branch option which allows the creation of if-then-else like semantics within a traversal.
    `default <M,E2> GraphTraversal<S,E2>` | GraphTraversal.`choose(Traversal<?,M> choiceTraversal)` Routes the current traverser to a particular traversal branch option which allows the creation of if-then-else like semantics within a traversal.
    `default <E2> GraphTraversal<S,E2>` | GraphTraversal.`coalesce(Traversal<?,E2>... coalesceTraversals)` Evaluates the provided traversals and returns the result of the first traversal to emit at least one object.
    `default GraphTraversal<S,E>` | GraphTraversal.`emit(Traversal<?,?> emitTraversal)` Emit is used in conjunction with `GraphTraversal.repeat(Traversal)` to determine what objects get emit from the loop.
    `default GraphTraversal<S,E>` | GraphTraversal.`filter(Traversal<?,?> filterTraversal)` Map the `Traverser` to either `true` or `false`, where `false` will not pass the traverser to the next step.
    `default <E2> GraphTraversal<S,E2>` | GraphTraversal.`flatMap(Traversal<?,E2> flatMapTraversal)` Map a `Traverser` referencing an object of type `E` to an iterator of objects of type `E2`.
    `default GraphTraversal<S,E>` | GraphTraversal.`from(Traversal<?,Vertex> fromVertex)` When used as a modifier to `GraphTraversal.addE(String)` this method specifies the traversal to use for selecting the outgoing vertex of the newly added `Edge`.
    `default GraphTraversal<S,E>` | GraphTraversal.`has(String propertyKey, Traversal<?,?> propertyTraversal)` Filters vertices, edges and vertex properties based on the value of the specified property key.
    `default GraphTraversal<S,E>` | GraphTraversal.`has(T accessor, Traversal<?,?> propertyTraversal)` Filters vertices, edges and vertex properties based on their value of `T` where only `T.id` and `T.label` are supported.
    `default <E2> GraphTraversal<S,E2>` | GraphTraversal.`local(Traversal<?,E2> localTraversal)` Provides a execute a specified traversal on a single element within a stream.
    `default <E2> GraphTraversal<S,E2>` | GraphTraversal.`map(Traversal<?,E2> mapTraversal)` Map a `Traverser` referencing an object of type `E` to an object of type `E2`.
    `default <E2> GraphTraversal<S,Map<String,E2>>` | GraphTraversal.`match(Traversal<?,?>... matchTraversals)` Map the `Traverser` to a `Map` of bindings as specified by the provided match traversals.
    `default GraphTraversal<S,E>` | GraphTraversal.`not(Traversal<?,?> notTraversal)` Removes objects from the traversal stream when the traversal provided as an argument does not return any objects.
    `default <M,E2> GraphTraversal<S,E>` | GraphTraversal.`option(M pick, Traversal<?,E2> traversalOption)` This step modifies `GraphTraversal.choose(Function)` to specifies the available choices that might be executed.
    `default <E2> GraphTraversal<S,E>` | GraphTraversal.`option(Traversal<?,E2> traversalOption)` This step modifies `GraphTraversal.choose(Function)` to specifies the available choices that might be executed.
    `default <E2> GraphTraversal<S,E2>` | GraphTraversal.`optional(Traversal<?,E2> optionalTraversal)` Returns the result of the specified traversal if it yields a result, otherwise it returns the calling element.
    `default GraphTraversal<S,E>` | GraphTraversal.`or(Traversal<?,?>... orTraversals)` Ensures that at least one of the provided traversals yield a result.
    `default GraphTraversal<S,E>` | GraphTraversal.`repeat(String loopName, Traversal<?,E> repeatTraversal)` This step is used for looping over a traversal given some break predicate and with a specified loop name.
    `default GraphTraversal<S,E>` | GraphTraversal.`repeat(Traversal<?,E> repeatTraversal)` This step is used for looping over a traversal given some break predicate.
    `default <E2> GraphTraversal<S,E2>` | GraphTraversal.`select(Pop pop, Traversal<S,E2> keyTraversal)` Map the `Traverser` to the object specified by the key returned by the `keyTraversal` and apply the `Pop` operation to it.
    `default <E2> GraphTraversal<S,E2>` | GraphTraversal.`select(Traversal<S,E2> keyTraversal)` Map the `Traverser` to the object specified by the key returned by the `keyTraversal`.
    `default GraphTraversal<S,E>` | GraphTraversal.`sideEffect(Traversal<?,?> sideEffectTraversal)` Perform some operation on the `Traverser` and pass it to the next step unmodified.
    `default GraphTraversal<S,E>` | GraphTraversal.`to(Traversal<?,Vertex> toVertex)` When used as a modifier to `GraphTraversal.addE(String)` this method specifies the traversal to use for selecting the incoming vertex of the newly added `Edge`.
    `default <E2> GraphTraversal<S,E2>` | GraphTraversal.`union(Traversal<?,E2>... unionTraversals)` Merges the results of an arbitrary number of traversals.
    `default GraphTraversal<S,E>` | GraphTraversal.`until(Traversal<?,?> untilTraversal)` Modifies a `GraphTraversal.repeat(Traversal)` to determine when the loop should exit.
    `default GraphTraversal<S,E>` | GraphTraversal.`where(Traversal<?,?> whereTraversal)` Filters the current object based on the object itself or the path history.

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