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

org.neo4j.graphdb.traversal

## Interface BranchState<STATE>

- Type Parameters:
    `STATE` - the type of object the state is.

      public interface BranchState<STATE>

  Accessor for a state associated with a `TraversalBranch` during a traversal. A `TraversalBranch` can have an associated state which follows down the branch as the traversal goes. If the state is modified with `setState(Object)` it means that branches further down will have the newly set state, until it potentially gets overridden again. The state returned from `getState()` represents the state associated with the parent branch, which by this point has followed down to the branch calling `getState()`.
  Author:
    Mattias Persson

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static BranchState` | `NO_STATE` Instance representing no state, usage resulting in `IllegalStateException` being thrown.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `STATE` | `getState()`
    `void` | `setState(STATE state)` Sets the `TraversalBranch` state for upcoming children of that branch.

- - ### Field Detail

    - #### NO_STATE

          static final BranchState NO_STATE

      Instance representing no state, usage resulting in `IllegalStateException` being thrown.

  - ### Method Detail

    - #### getState

          STATE getState()

      Returns:
        the associated state for a `TraversalBranch`.

    - #### setState

          void setState(STATE state)

      Sets the `TraversalBranch` state for upcoming children of that branch.
      Parameters:
        `state` - the `TraversalBranch` state to set for upcoming children.

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