org.neo4j.api.core
Interface Traverser

All Superinterfaces:
java.lang.Iterable<Node>

public interface Traverser
extends java.lang.Iterable<Node>

See Node.traverse(...).


Nested Class Summary
static class Traverser.Order
          Enum defining the two types of traversals.
 
Method Summary
 TraversalPosition currentPosition()
          Returns the current traversal postion.
 java.util.Collection<Node> getAllNodes()
          Returns a collection of all nodes returned by this traverser.
 java.util.Iterator<Node> iterator()
          Returns an iterator for this traverser.
 

Method Detail

currentPosition

TraversalPosition currentPosition()
Returns the current traversal postion.

Returns:
The current traversal position

getAllNodes

java.util.Collection<Node> getAllNodes()
Returns a collection of all nodes returned by this traverser.

Returns:
A collection of all node returned by this traverser

iterator

java.util.Iterator<Node> iterator()
Returns an iterator for this traverser.

Specified by:
iterator in interface java.lang.Iterable<Node>
Returns:
An iterator for this traverser