Package org.ldaptive

Enum Class SearchScope

java.lang.Object
java.lang.Enum<SearchScope>
org.ldaptive.SearchScope
All Implemented Interfaces:
Serializable, Comparable<SearchScope>, Constable

public enum SearchScope extends Enum<SearchScope>
Enum to define the type of search scope.
   scope           ENUMERATED {
     baseObject              (0),
     singleLevel             (1),
     wholeSubtree            (2),
     subordinateSubtree      (3),
     ...  }
 
  • Enum Constant Details

    • OBJECT

      public static final SearchScope OBJECT
      base object search.
    • ONELEVEL

      public static final SearchScope ONELEVEL
      single level search.
    • SUBTREE

      public static final SearchScope SUBTREE
      whole subtree search.
    • SUBORDINATE

      public static final SearchScope SUBORDINATE
      subordinate subtree search. See draft-sermersheim-ldap-subordinate-scope.
  • Constructor Details

    • SearchScope

      private SearchScope()
  • Method Details

    • values

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