Enum Class BackendVlvIndexCfgDefn.Scope

java.lang.Object
java.lang.Enum<BackendVlvIndexCfgDefn.Scope>
org.forgerock.opendj.server.config.meta.BackendVlvIndexCfgDefn.Scope
All Implemented Interfaces:
Serializable, Comparable<BackendVlvIndexCfgDefn.Scope>, java.lang.constant.Constable
Enclosing class:
BackendVlvIndexCfgDefn

public static enum BackendVlvIndexCfgDefn.Scope extends Enum<BackendVlvIndexCfgDefn.Scope>
Defines the set of permissible values for the "scope" property.

Specifies the LDAP scope of the query that is being indexed.

  • Enum Constant Details

    • SINGLE_LEVEL

      public static final BackendVlvIndexCfgDefn.Scope SINGLE_LEVEL
      Search the immediate children of the base object but do not include any of their descendants or the base object itself.
    • SUBORDINATE_SUBTREE

      public static final BackendVlvIndexCfgDefn.Scope SUBORDINATE_SUBTREE
      Search the entire subtree below the base object but do not include the base object itself.
    • WHOLE_SUBTREE

      public static final BackendVlvIndexCfgDefn.Scope WHOLE_SUBTREE
      Search the base object and the entire subtree below the base object.
  • Method Details

    • values

      public static BackendVlvIndexCfgDefn.Scope[] 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 BackendVlvIndexCfgDefn.Scope 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
    • toString

      public String toString()
      Overrides:
      toString in class Enum<BackendVlvIndexCfgDefn.Scope>