Enum LdapConfig.SearchScope

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<LdapConfig.SearchScope>
    Enclosing class:
    LdapConfig

    public static enum LdapConfig.SearchScope
    extends java.lang.Enum<LdapConfig.SearchScope>
    Enum to define the type of search scope. See SearchControls.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      OBJECT
      object level search.
      ONELEVEL
      one level search.
      SUBTREE
      subtree search.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static LdapConfig.SearchScope parseSearchScope​(int i)
      Method to convert a JNDI constant value to an enum.
      int scope()
      Returns the search scope integer.
      static LdapConfig.SearchScope valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static LdapConfig.SearchScope[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

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

        getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • values

        public static LdapConfig.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 (LdapConfig.SearchScope c : LdapConfig.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 LdapConfig.SearchScope 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
      • scope

        public int scope()
        Returns the search scope integer.
        Returns:
        int
      • parseSearchScope

        public static LdapConfig.SearchScope parseSearchScope​(int i)
        Method to convert a JNDI constant value to an enum. Returns null if the supplied constant does not match a known value.
        Parameters:
        i - search scope
        Returns:
        search scope