Package org.bremersee.spring.boot.autoconfigure.ldaptive

Enum Class LdaptiveConnectionProperties.SearchScope

java.lang.Object

java.lang.Enum<LdaptiveConnectionProperties.SearchScope>

org.bremersee.spring.boot.autoconfigure.ldaptive.LdaptiveConnectionProperties.SearchScope

All Implemented Interfaces:

Serializable, Comparable<LdaptiveConnectionProperties.SearchScope>, Constable

Enclosing class:

LdaptiveConnectionProperties

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

The enum Search scope.

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	Base object search.
ONELEVEL	Single level search.
SUBORDINATE	Subordinate subtree search.
SUBTREE	Whole subtree search.

Method Summary

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

Base object search.

ONELEVEL

public static final LdaptiveConnectionProperties.SearchScope ONELEVEL

Single level search.

SUBTREE

public static final LdaptiveConnectionProperties.SearchScope SUBTREE

Whole subtree search.

SUBORDINATE

public static final LdaptiveConnectionProperties.SearchScope SUBORDINATE

Subordinate subtree search. See draft-sermersheim-ldap-subordinate-scope.

Method Details

values

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