Enum LdapSearchScope

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<LdapSearchScope>

    public enum LdapSearchScope
    extends java.lang.Enum<LdapSearchScope>
    Search scope types for LDAP queries.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      OBJECT
      Only given search context object.
      ONE_LEVEL
      One level under the search context.
      SUBTREE
      Subtree of the search context.
    • Enum Constant Detail

      • OBJECT

        public static final LdapSearchScope OBJECT
        Only given search context object.
      • ONE_LEVEL

        public static final LdapSearchScope ONE_LEVEL
        One level under the search context.
      • SUBTREE

        public static final LdapSearchScope SUBTREE
        Subtree of the search context.
    • Method Detail

      • values

        public static LdapSearchScope[] 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 (LdapSearchScope c : LdapSearchScope.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static LdapSearchScope valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<LdapSearchScope>
      • toSearchControlValue

        public int toSearchControlValue()
      • getSearchScope

        public static LdapSearchScope getSearchScope​(java.lang.String label)