public interface Traversal<S,E> extends Iterator<E>, Serializable, Cloneable
Traversal represents a directed walk over a Graph.
 This is the base interface for all traversal's, where each extending interface is seen as a domain specific language.
 For example, GraphTraversal is a domain specific language for traversing a graph using "graph concepts" (e.g. vertices, edges).
 Another example may represent the graph using "social concepts" (e.g. people, cities, artifacts).
 A Traversal is evaluated in one of two ways: StandardTraversalEngine (OLTP) and ComputerTraversalEngine (OLAP).
 OLTP traversals leverage an iterator and are executed within a single JVM (with data access allowed to be remote).
 OLAP traversals leverage GraphComputer and are executed between multiple JVMs (and/or cores).| Modifier and Type | Interface and Description | 
|---|---|
| static interface  | Traversal.Admin<S,E> | 
| static class  | Traversal.ExceptionsA collection of  Exceptiontypes associated with Traversal execution. | 
| Modifier and Type | Method and Description | 
|---|---|
| default Traversal.Admin<S,E> | asAdmin()Get access to administrative methods of the traversal via its accompanying  Traversal.Admin. | 
| default <C extends Collection<E>> | fill(C collection)Add all the results of the traversal to the provided collection. | 
| default <E2> void | forEachRemaining(Class<E2> endType,
                Consumer<E2> consumer)A traversal can be rewritten such that its defined end type E may yield objects of a different type. | 
| default void | forEachRemaining(Consumer<? super E> action) | 
| default <A,B> Traversal<A,B> | iterate()Iterate all the  Traverserinstances in the traversal. | 
| default List<E> | next(int amount)Get the next n-number of results from the traversal. | 
| default BulkSet<E> | toBulkSet()Put all the results into a  BulkSet. | 
| default List<E> | toList()Put all the results into an  ArrayList. | 
| default Set<E> | toSet()Put all the results into a  HashSet. | 
| default Stream<E> | toStream()Return the traversal as a  Stream. | 
| default Optional<E> | tryNext()Return an  Optionalof the next E object in the traversal. | 
default Traversal.Admin<S,E> asAdmin()
Traversal.Admin.default Optional<E> tryNext()
Optional of the next E object in the traversal.
 If the traversal is empty, then an Optional.empty() is returned.default List<E> next(int amount)
amount - the number of results to getListdefault List<E> toList()
ArrayList.default BulkSet<E> toBulkSet()
BulkSet.
 This can reduce both time and space when aggregating results by ensuring a weighted set.default Stream<E> toStream()
Stream.default <C extends Collection<E>> C fill(C collection)
collection - the collection to filldefault <A,B> Traversal<A,B> iterate()
Traverser instances in the traversal.
 What is returned is the empty traversal.
 It is assumed that what is desired from the computation is are the sideEffects yielded by the traversal.default <E2> void forEachRemaining(Class<E2> endType, Consumer<E2> consumer)
E2 - the known output type of the traversalendType - the true output type of the traversalconsumer - a Consumer to process each outputdefault void forEachRemaining(Consumer<? super E> action)
forEachRemaining in interface Iterator<E>Copyright © 2013–2015 Apache Software Foundation. All rights reserved.