InitialBranchState (Neo4j Community 2.1.0-M01 API)
Date: 2014-02-20

org.neo4j.graphdb.traversal

## Interface InitialBranchState<STATE>

- Type Parameters:
    `STATE` - type of initial state to produce.
  All Superinterfaces:
    InitialStateFactory<STATE>
  All Known Implementing Classes:
    InitialBranchState.Adapter, InitialBranchState.State, InitialStateFactory.AsInitialBranchState

      public interface InitialBranchState<STATE>
      extends InitialStateFactory<STATE>

  Factory for initial state of `TraversalBranch`es in a traversal.

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Interface and Description
    --- | ---
    `static class` | `InitialBranchState.Adapter<STATE>`
    `static class` | `InitialBranchState.State<STATE>` Branch state evaluator for an initial state.

    - ### Nested classes/interfaces inherited from interface org.neo4j.graphdb.traversal.InitialStateFactory

      `InitialStateFactory.AsInitialBranchState<STATE>`

  - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static InitialBranchState` | `NO_STATE`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `InitialBranchState<STATE>` | `reverse()` Creates a version of this state factory which produces reversed initial state, used in bidirectional traversals.

    - ### Methods inherited from interface org.neo4j.graphdb.traversal.InitialStateFactory

      `initialState`

- - ### Field Detail

    - #### NO_STATE

          static final InitialBranchState NO_STATE

  - ### Method Detail

    - #### reverse

          InitialBranchState<STATE> 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.

Copyright © 2002–2014 The Neo4j Graph Database Project. All rights reserved.