Enum LDAPScope

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

    public enum LDAPScope
    extends java.lang.Enum<LDAPScope>
    The scope of the LDAP search.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BASE
      Search base
      ONE_LEVEL
      Search one level
      SUBTREE
      Search the subtree
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static LDAPScope valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static LDAPScope[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • BASE

        public static final LDAPScope BASE
        Search base
      • ONE_LEVEL

        public static final LDAPScope ONE_LEVEL
        Search one level
      • SUBTREE

        public static final LDAPScope SUBTREE
        Search the subtree
    • Method Detail

      • values

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

        public static LDAPScope 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