Package org.neo4j.graphdb.traversal

Enum Class SideSelectorPolicies

java.lang.Object
java.lang.Enum<SideSelectorPolicies>
org.neo4j.graphdb.traversal.SideSelectorPolicies
All Implemented Interfaces:
Serializable, Comparable<SideSelectorPolicies>, Constable, SideSelectorPolicy
public enum SideSelectorPolicies extends Enum<SideSelectorPolicies> implements SideSelectorPolicy
A catalogue of convenient side selector policies for use in bidirectional traversals.

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ALTERNATING
    This `SideSelectorPolicy` alternates which branch continues the traversal.
    LEVEL
    This `SideSelectorPolicy` stops traversal if the combined depth is larger than the given maximum depth.
    LEVEL_STOP_DESCENT_ON_RESULT
    This `SideSelectorPolicy` stops as soon as a result is found.

  • Method Summary

    Modifier and Type
    Method
    Description
    static SideSelectorPolicies
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static SideSelectorPolicies[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from interface org.neo4j.graphdb.traversal.SideSelectorPolicy

    create

  • Enum Constant Details

    • LEVEL

      public static final SideSelectorPolicies LEVEL
      This `SideSelectorPolicy` stops traversal if the combined depth is larger than the given maximum depth. It will select branches for expansion that are on the same depth as the current branch before moving on to the next depth.

    • LEVEL_STOP_DESCENT_ON_RESULT

      public static final SideSelectorPolicies LEVEL_STOP_DESCENT_ON_RESULT
      This `SideSelectorPolicy` stops as soon as a result is found. It will select branches for expansion that are on the same depth as the current branch before moving on to the next depth.

    • ALTERNATING

      public static final SideSelectorPolicies ALTERNATING
      This `SideSelectorPolicy` alternates which branch continues the traversal.

  • Method Details

    • values

      public static SideSelectorPolicies[] 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 SideSelectorPolicies 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