Package org.neo4j.graphdb.traversal

Class InitialBranchState.State<STATE>

java.lang.Object

org.neo4j.graphdb.traversal.InitialBranchState.State<STATE>

All Implemented Interfaces:

InitialBranchState<STATE>

Enclosing interface:

InitialBranchState<STATE>

public static class InitialBranchState.State<STATE>
extends Object
implements InitialBranchState<STATE>

Branch state evaluator for an initial state.

Nested Class Summary

Nested classes/interfaces inherited from interface org.neo4j.graphdb.traversal.InitialBranchState

InitialBranchState.State<STATE>

Field Summary

Fields inherited from interface org.neo4j.graphdb.traversal.InitialBranchState

DOUBLE_ZERO, NO_STATE

Constructor Summary

Constructors

Constructor	Description
State(STATE initialState, STATE reversedInitialState)

Method Summary

Modifier and Type	Method	Description
STATE	initialState(Path path)	Returns an initial state for a Path.
InitialBranchState<STATE>	reverse()	Creates a version of this state factory which produces reversed initial state, used in bidirectional traversals.

Constructor Details

State

public State(STATE initialState,
 STATE reversedInitialState)

Method Details

reverse

public InitialBranchState<STATE> reverse()

Description copied from interface: InitialBranchState

Creates a version of this state factory which produces reversed initial state, used in bidirectional traversals.

Specified by:

reverse in interface InitialBranchState<STATE>

Returns:

an instance which produces reversed initial state.

initialState

public STATE initialState(Path path)

Description copied from interface: InitialBranchState

Returns an initial state for a Path. 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 a PathExpander to becomes the new state from that point in that branch and downwards.

Specified by:

initialState in interface InitialBranchState<STATE>

Parameters:

path - the start branch to return the initial state for.

Returns:

an initial state for the traversal branch.