Uses of Interface org.neo4j.graphdb.traversal.BranchState (Neo4j Community 2.1.0-M01 API)
Date: 2014-02-20

## Uses of Interface
org.neo4j.graphdb.traversal.BranchState

- Packages that use BranchState
  Package | Description
  --- | ---
  org.neo4j.graphdb | The core graph database API.
  org.neo4j.graphdb.traversal | Traversal framework.

- - ### Uses of BranchState in org.neo4j.graphdb

    Methods in org.neo4j.graphdb with parameters of type BranchState
    Modifier and Type | Method and Description
    --- | ---
    `Iterable<Relationship>` | PathExpander.`expand(Path path, BranchState<STATE> state)` Returns relationships for a `Path`, most commonly from the `Path.endNode()`.

  - ### Uses of BranchState in org.neo4j.graphdb.traversal

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

    Methods in org.neo4j.graphdb.traversal with parameters of type BranchState
    Modifier and Type | Method and Description
    --- | ---
    `Evaluation` | Evaluator.AsPathEvaluator.`evaluate(Path path, BranchState<STATE> state)`
    `Evaluation` | PathEvaluator.`evaluate(Path path, BranchState<STATE> state)` Evaluates a `Path` and returns an `Evaluation` containing information about whether or not to include it in the traversal result, i.e return it from the `Traverser`.
    `Evaluation` | TraversalContext.`evaluate(TraversalBranch branch, BranchState state)` Evaluates a `TraversalBranch` whether or not to include it in the result and whether or not to continue further down this branch or not.

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