Module io.inverno.mod.ldap

Package io.inverno.mod.ldap

Enum Class LDAPOperations.SearchScope

java.lang.Object

java.lang.Enum<LDAPOperations.SearchScope>

io.inverno.mod.ldap.LDAPOperations.SearchScope

All Implemented Interfaces:

Serializable, Comparable<LDAPOperations.SearchScope>, Constable

Enclosing interface:

LDAPOperations

public static enum LDAPOperations.SearchScope
extends Enum<LDAPOperations.SearchScope>

Represents the serach scope as defined by RFC4511 Section 4.5.1.2.

Since:

1.5

Author:

Jeremy Kuhn

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	The scope is constrained to the entry named by baseObject.
SINGLE_LEVEL	The scope is constrained to the immediate subordinates of the entry named by baseObject.
WHOLE_SUBTREE	The scope is constrained to the entry named by baseObject and to all its subordinates.

Method Summary

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

BASE_OBJECT

public static final LDAPOperations.SearchScope BASE_OBJECT

The scope is constrained to the entry named by baseObject.

SINGLE_LEVEL

public static final LDAPOperations.SearchScope SINGLE_LEVEL

The scope is constrained to the immediate subordinates of the entry named by baseObject.

WHOLE_SUBTREE

public static final LDAPOperations.SearchScope WHOLE_SUBTREE

The scope is constrained to the entry named by baseObject and to all its subordinates.

Method Details

values

public static LDAPOperations.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 LDAPOperations.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