Package org.springframework.ldap.query

Enum Class SearchScope

java.lang.Object

java.lang.Enum<SearchScope>

org.springframework.ldap.query.SearchScope

All Implemented Interfaces:

Serializable, Comparable<SearchScope>, Constable

public enum SearchScope
extends Enum<SearchScope>

Type safe definitions of search scopes.

Since:

2.0

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
OBJECT	Corresponds to SearchControls.OBJECT_SCOPE
ONELEVEL	Corresponds to SearchControls.ONELEVEL_SCOPE
SUBTREE	Corresponds to SearchControls.SUBTREE_SCOPE

Method Summary

Modifier and Type	Method	Description
int	getId()
static SearchScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SearchScope[]	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

OBJECT

public static final SearchScope OBJECT

Corresponds to SearchControls.OBJECT_SCOPE

ONELEVEL

public static final SearchScope ONELEVEL

Corresponds to SearchControls.ONELEVEL_SCOPE

SUBTREE

public static final SearchScope SUBTREE

Corresponds to SearchControls.SUBTREE_SCOPE

Method Details

values

public static SearchScope[] 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 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

getId

public int getId()