Package org.neo4j.graphdb.traversal
Interface InitialBranchState<STATE>
- Type Parameters:
STATE
- type of initial state to produce.
- All Known Implementing Classes:
InitialBranchState.State
public interface InitialBranchState<STATE>
Factory for initial state of
TraversalBranch
es in a traversal.-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic class
Branch state evaluator for an initial state. -
Field Summary
Modifier and TypeFieldDescriptionstatic final InitialBranchState<Double>
static final InitialBranchState<Object>
-
Method Summary
Modifier and TypeMethodDescriptioninitialState
(Path path) Returns an initial state for aPath
.default InitialBranchState<STATE>
reverse()
Creates a version of this state factory which produces reversed initial state, used in bidirectional traversals.
-
Field Details
-
NO_STATE
-
DOUBLE_ZERO
-
-
Method Details
-
initialState
Returns an initial state for aPath
. All paths entering this method are start paths(es) of a traversal. State is passed down along traversal branches as the traversal progresses and can be changed at any point by aPathExpander
to becomes the new state from that point in that branch and downwards.- Parameters:
path
- the start branch to return the initial state for.- Returns:
- an initial state for the traversal branch.
-
reverse
Creates a version of this state factory which produces reversed initial state, used in bidirectional traversals.- Returns:
- an instance which produces reversed initial state.
-