Package org.forgerock.opendj.ldap

Enum Class SearchScope.Enum

java.lang.Object

java.lang.Enum<SearchScope.Enum>

org.forgerock.opendj.ldap.SearchScope.Enum

All Implemented Interfaces:

Serializable, Comparable<SearchScope.Enum>, java.lang.constant.Constable

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.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BASE_OBJECT
SINGLE_LEVEL
SUBORDINATES
UNKNOWN	Used for unknown search scopes.
WHOLE_SUBTREE

Method Summary

Modifier and Type	Method	Description
static SearchScope.Enum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SearchScope.Enum[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BASE_OBJECT

public static final SearchScope.Enum BASE_OBJECT

See Also:

• SearchScope.BASE_OBJECT

SINGLE_LEVEL

public static final SearchScope.Enum SINGLE_LEVEL

See Also:

• SearchScope.SINGLE_LEVEL

WHOLE_SUBTREE

public static final SearchScope.Enum WHOLE_SUBTREE

See Also:

• SearchScope.WHOLE_SUBTREE

SUBORDINATES

public static final SearchScope.Enum SUBORDINATES

See Also:

• SearchScope.SUBORDINATES

UNKNOWN

public static final SearchScope.Enum UNKNOWN

Used for unknown search scopes.

Method Details

values

public static SearchScope.Enum[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SearchScope.Enum valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null