Package org.ldaptive

Enum SearchScope

  • All Implemented Interfaces:
    Serializable, Comparable<SearchScope>
    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 Detail

      • 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 Detail

      • SearchScope

        private SearchScope()

    • Method Detail

      • values

        public static SearchScope[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (SearchScope c : SearchScope.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static SearchScope valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
        NullPointerException - if the argument is null