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

- Packages that use Traverser
  Package | Description
  --- | ---
  org.apache.tinkerpop.gremlin.groovy.jsr223.dsl.credential |
  org.apache.tinkerpop.gremlin.groovy.loaders |
  org.apache.tinkerpop.gremlin.process.remote.traversal |
  org.apache.tinkerpop.gremlin.process.traversal |
  org.apache.tinkerpop.gremlin.process.traversal.dsl.graph |
  org.apache.tinkerpop.gremlin.process.traversal.lambda |
  org.apache.tinkerpop.gremlin.process.traversal.step.filter |
  org.apache.tinkerpop.gremlin.process.traversal.step.map |
  org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect |
  org.apache.tinkerpop.gremlin.process.traversal.strategy.decoration |
  org.apache.tinkerpop.gremlin.process.traversal.traverser |
  org.apache.tinkerpop.gremlin.process.traversal.traverser.util |
  org.apache.tinkerpop.gremlin.structure.io.binary.types |

- - ### Uses of Traverser in org.apache.tinkerpop.gremlin.groovy.jsr223.dsl.credential

    Method parameters in org.apache.tinkerpop.gremlin.groovy.jsr223.dsl.credential with type arguments of type Traverser
    Modifier and Type | Method and Description
    --- | ---
    `static <A,M,B> CredentialTraversal<A,B>` | __.`branch(Function<Traverser<A>,M> function)`
    `default <M,E2> CredentialTraversal<S,E2>` | CredentialTraversal.`branch(Function<Traverser<E>,M> function)`
    `static <A> CredentialTraversal<A,A>` | __.`emit(Predicate<Traverser<A>> emitPredicate)`
    `default CredentialTraversal<S,E>` | CredentialTraversal.`emit(Predicate<Traverser<E>> emitPredicate)`
    `static <A> CredentialTraversal<A,A>` | __.`filter(Predicate<Traverser<A>> predicate)`
    `default CredentialTraversal<S,E>` | CredentialTraversal.`filter(Predicate<Traverser<E>> predicate)`
    `static <A,B> CredentialTraversal<A,B>` | __.`flatMap(Function<Traverser<A>,Iterator<B>> function)`
    `default <E2> CredentialTraversal<S,E2>` | CredentialTraversal.`flatMap(Function<Traverser<E>,Iterator<E2>> function)`
    `static <A,B> CredentialTraversal<A,B>` | __.`map(Function<Traverser<A>,B> function)`
    `default <E2> CredentialTraversal<S,E2>` | CredentialTraversal.`map(Function<Traverser<E>,E2> function)`
    `static <A> CredentialTraversal<A,A>` | __.`sideEffect(Consumer<Traverser<A>> consumer)`
    `default CredentialTraversal<S,E>` | CredentialTraversal.`sideEffect(Consumer<Traverser<E>> consumer)`
    `static <A> CredentialTraversal<A,A>` | __.`until(Predicate<Traverser<A>> untilPredicate)`
    `default CredentialTraversal<S,E>` | CredentialTraversal.`until(Predicate<Traverser<E>> untilPredicate)`

  - ### Uses of Traverser in org.apache.tinkerpop.gremlin.groovy.loaders

    Methods in org.apache.tinkerpop.gremlin.groovy.loaders with parameters of type Traverser
    Modifier and Type | Method and Description
    --- | ---
    `static Object` | SugarLoader.TraverserCategory.`get(Traverser traverser, String key)`

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

    Subinterfaces of Traverser in org.apache.tinkerpop.gremlin.process.remote.traversal
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `RemoteTraverser<T>`

    Classes in org.apache.tinkerpop.gremlin.process.remote.traversal that implement Traverser
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractRemoteTraverser<T>`
    `class` | `DefaultRemoteTraverser<T>`

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

    Subinterfaces of Traverser in org.apache.tinkerpop.gremlin.process.traversal
    Modifier and Type | Interface and Description
    --- | ---
    `static interface` | `Traverser.Admin<T>` The methods in System.Traverser are useful to underlying Step and Traversal implementations.

    Methods in org.apache.tinkerpop.gremlin.process.traversal that return Traverser
    Modifier and Type | Method and Description
    --- | ---
    `Traverser<T>` | Traverser.`clone()` Traverser cloning is important when splitting a traverser at a bifurcation point in a traversal.

    Methods in org.apache.tinkerpop.gremlin.process.traversal with parameters of type Traverser
    Modifier and Type | Method and Description
    --- | ---
    `default int` | Traverser.`compareTo(Traverser<T> other)` If the underlying object of the traverser is comparable, compare it with the other traverser.

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

    Method parameters in org.apache.tinkerpop.gremlin.process.traversal.dsl.graph with type arguments of type Traverser
    Modifier and Type | Method and Description
    --- | ---
    `static <A,M,B> GraphTraversal<A,B>` | __.`branch(Function<Traverser<A>,M> function)`
    `default <M,E2> GraphTraversal<S,E2>` | GraphTraversal.`branch(Function<Traverser<E>,M> function)` Split the `Traverser` to all the specified functions.
    `static <A> GraphTraversal<A,A>` | __.`emit(Predicate<Traverser<A>> emitPredicate)`
    `default GraphTraversal<S,E>` | GraphTraversal.`emit(Predicate<Traverser<E>> emitPredicate)` Emit is used in conjunction with `GraphTraversal.repeat(Traversal)` to determine what objects get emit from the loop.
    `static <A> GraphTraversal<A,A>` | __.`filter(Predicate<Traverser<A>> predicate)`
    `default GraphTraversal<S,E>` | GraphTraversal.`filter(Predicate<Traverser<E>> predicate)` Map the `Traverser` to either `true` or `false`, where `false` will not pass the traverser to the next step.
    `static <A,B> GraphTraversal<A,B>` | __.`flatMap(Function<Traverser<A>,Iterator<B>> function)`
    `default <E2> GraphTraversal<S,E2>` | GraphTraversal.`flatMap(Function<Traverser<E>,Iterator<E2>> function)` Map a `Traverser` referencing an object of type `E` to an iterator of objects of type `E2`.
    `static <A,B> GraphTraversal<A,B>` | __.`map(Function<Traverser<A>,B> function)`
    `default <E2> GraphTraversal<S,E2>` | GraphTraversal.`map(Function<Traverser<E>,E2> function)` Map a `Traverser` referencing an object of type `E` to an object of type `E2`.
    `static <A> GraphTraversal<A,A>` | __.`sideEffect(Consumer<Traverser<A>> consumer)`
    `default GraphTraversal<S,E>` | GraphTraversal.`sideEffect(Consumer<Traverser<E>> consumer)` Perform some operation on the `Traverser` and pass it to the next step unmodified.
    `static <A> GraphTraversal<A,A>` | __.`until(Predicate<Traverser<A>> untilPredicate)`
    `default GraphTraversal<S,E>` | GraphTraversal.`until(Predicate<Traverser<E>> untilPredicate)` Modifies a `GraphTraversal.repeat(Traversal)` to determine when the loop should exit.

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

    Methods in org.apache.tinkerpop.gremlin.process.traversal.lambda with parameters of type Traverser
    Modifier and Type | Method and Description
    --- | ---
    `B` | FunctionTraverser.`apply(Traverser<A> traverser)`
    `boolean` | PredicateTraverser.`test(Traverser<A> traverser)`

  - ### Uses of Traverser in org.apache.tinkerpop.gremlin.process.traversal.step.filter

    Methods in org.apache.tinkerpop.gremlin.process.traversal.step.filter that return types with arguments of type Traverser
    Modifier and Type | Method and Description
    --- | ---
    `Predicate<Traverser<S>>` | LambdaFilterStep.`getPredicate()`

    Constructor parameters in org.apache.tinkerpop.gremlin.process.traversal.step.filter with type arguments of type Traverser
    Constructor and Description
    `LambdaFilterStep(Traversal.Admin traversal, Predicate<Traverser<S>> predicate)`

  - ### Uses of Traverser in org.apache.tinkerpop.gremlin.process.traversal.step.map

    Methods in org.apache.tinkerpop.gremlin.process.traversal.step.map that return types with arguments of type Traverser
    Modifier and Type | Method and Description
    --- | ---
    `Function<Traverser<S>,Iterator<E>>` | LambdaFlatMapStep.`getFunction()`
    `Function<Traverser<S>,E>` | LambdaMapStep.`getMapFunction()`

    Constructor parameters in org.apache.tinkerpop.gremlin.process.traversal.step.map with type arguments of type Traverser
    Constructor and Description
    `LambdaFlatMapStep(Traversal.Admin traversal, Function<Traverser<S>,Iterator<E>> function)`
    `LambdaMapStep(Traversal.Admin traversal, Function<Traverser<S>,E> function)`

  - ### Uses of Traverser in org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect

    Methods in org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect that return types with arguments of type Traverser
    Modifier and Type | Method and Description
    --- | ---
    `Consumer<Traverser<S>>` | LambdaSideEffectStep.`getConsumer()`

    Constructor parameters in org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect with type arguments of type Traverser
    Constructor and Description
    `LambdaSideEffectStep(Traversal.Admin traversal, Consumer<Traverser<S>> consumer)`

  - ### Uses of Traverser in org.apache.tinkerpop.gremlin.process.traversal.strategy.decoration

    Methods in org.apache.tinkerpop.gremlin.process.traversal.strategy.decoration with parameters of type Traverser
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,List<Property>>` | PartitionStrategy.MapPropertiesFilter.`apply(Traverser<Map<String,List<Property>>> mapTraverser)`
    `Map<String,List<Property>>` | PartitionStrategy.MapPropertiesConverter.`apply(Traverser<Map<String,List<Property>>> mapTraverser)`
    `boolean` | PartitionStrategy.TypeChecker.`test(Traverser traverser)`
    `boolean` | PartitionStrategy.PartitionKeyHider.`test(Traverser<A> traverser)`

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

    Classes in org.apache.tinkerpop.gremlin.process.traversal.traverser that implement Traverser
    Modifier and Type | Class and Description
    --- | ---
    `class` | `B_LP_NL_O_P_S_SE_SL_Traverser<T>`
    `class` | `B_LP_NL_O_S_SE_SL_Traverser<T>`
    `class` | `B_LP_O_P_S_SE_SL_Traverser<T>`
    `class` | `B_LP_O_S_SE_SL_Traverser<T>`
    `class` | `B_NL_O_S_SE_SL_Traverser<T>`
    `class` | `B_O_S_SE_SL_Traverser<T>`
    `class` | `B_O_Traverser<T>`
    `class` | `LP_NL_O_OB_P_S_SE_SL_Traverser<T>`
    `class` | `LP_NL_O_OB_S_SE_SL_Traverser<T>`
    `class` | `LP_O_OB_P_S_SE_SL_Traverser<T>`
    `class` | `LP_O_OB_S_SE_SL_Traverser<T>`
    `class` | `NL_O_OB_S_SE_SL_Traverser<T>`
    `class` | `O_OB_S_SE_SL_Traverser<T>`
    `class` | `O_Traverser<T>`
    `class` | `ProjectedTraverser<T,P>`

  - ### Uses of Traverser in org.apache.tinkerpop.gremlin.process.traversal.traverser.util

    Classes in org.apache.tinkerpop.gremlin.process.traversal.traverser.util that implement Traverser
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractTraverser<T>`
    `class` | `EmptyTraverser<T>` A `Traverser` with no bulk which effectively means that it will no longer be propagated through a `Traversal`.

    Method parameters in org.apache.tinkerpop.gremlin.process.traversal.traverser.util with type arguments of type Traverser
    Modifier and Type | Method and Description
    --- | ---
    `void` | TraverserSet.`sort(Comparator<Traverser<S>> comparator)`

  - ### Uses of Traverser in org.apache.tinkerpop.gremlin.structure.io.binary.types

    Methods in org.apache.tinkerpop.gremlin.structure.io.binary.types that return Traverser
    Modifier and Type | Method and Description
    --- | ---
    `protected Traverser` | TraverserSerializer.`readValue(Buffer buffer, GraphBinaryReader context)`

    Methods in org.apache.tinkerpop.gremlin.structure.io.binary.types with parameters of type Traverser
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | TraverserSerializer.`writeValue(Traverser value, Buffer buffer, GraphBinaryWriter context)`

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