Package org.forgerock.opendj.ldap

Enum SearchScope.Enum

  • All Implemented Interfaces:
    Serializable, Comparable<SearchScope.Enum>
    Enclosing class:
    SearchScope
    public static enum SearchScope.Enum
extends Enum<SearchScope.Enum>
    Contains equivalent values for the SearchScope values. This allows easily using SearchScope values with switch statements.

    SearchScope itself is not an enum because search scopes are extensible, hence the UNKNOWN enum value.

    • Method Detail

      • values

        public static SearchScope.Enum[] 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.Enum c : SearchScope.Enum.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.Enum 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