Package org.neo4j.graphdb.traversal

Enum Class Evaluation

java.lang.Object
java.lang.Enum<Evaluation>
org.neo4j.graphdb.traversal.Evaluation
All Implemented Interfaces:
Serializable, Comparable<Evaluation>, Constable
public enum Evaluation extends Enum<Evaluation>
Outcome of Evaluator.evaluate(org.neo4j.graphdb.Path). An evaluation can tell the traversal whether or not to continue down that TraversalBranch and whether or not to include a TraversalBranch in the result of a traversal.
See Also:

  • Enum Constant Details

    • INCLUDE_AND_CONTINUE

      public static final Evaluation INCLUDE_AND_CONTINUE

    • INCLUDE_AND_PRUNE

      public static final Evaluation INCLUDE_AND_PRUNE

    • EXCLUDE_AND_CONTINUE

      public static final Evaluation EXCLUDE_AND_CONTINUE

    • EXCLUDE_AND_PRUNE

      public static final Evaluation EXCLUDE_AND_PRUNE

  • Method Details

    • values

      public static Evaluation[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Evaluation valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • includes

      public boolean includes()
      Returns:
      whether or not the TraversalBranch this outcome was generated for should be included in the traversal result.

    • continues

      public boolean continues()
      Returns:
      whether or not the traversal should continue down the TraversalBranch this outcome was generator for.

    • of

      public static Evaluation of(boolean includes, boolean continues)
      Returns an Evaluation for the given includes and continues.
      Parameters:
      includes - whether or not to include the TraversalBranch in the traversal result.
      continues - whether or not to continue down the TraversalBranch.
      Returns:
      an Evaluation representing includes and continues.

    • ofIncludes

      public static Evaluation ofIncludes(boolean includes)
      Returns an Evaluation for the given includes, meaning whether or not to include a TraversalBranch in the traversal result or not. The returned evaluation will always return true for continues().
      Parameters:
      includes - whether or not to include a TraversalBranch in the traversal result.
      Returns:
      an Evaluation representing whether or not to include a TraversalBranch in the traversal result.

    • ofContinues

      public static Evaluation ofContinues(boolean continues)
      Returns an Evaluation for the given continues, meaning whether or not to continue further down a TraversalBranch in the traversal. The returned evaluation will always return true for includes().
      Parameters:
      continues - whether or not to continue further down a TraversalBranch in the traversal.
      Returns:
      an Evaluation representing whether or not to continue further down a TraversalBranch in the traversal.