org.ldaptive

Enum SearchScope

java.lang.Object

java.lang.Enum<SearchScope>

org.ldaptive.SearchScope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SearchScope>

public enum SearchScope
extends java.lang.Enum<SearchScope>

Enum to define the type of search scope.

Enum Constant Summary

Enum Constants

Enum Constant and Description
OBJECT object level search.
ONELEVEL one level search.
SUBTREE subtree search.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OBJECT

public static final SearchScope OBJECT

object level search.

ONELEVEL

public static final SearchScope ONELEVEL

one level search.

SUBTREE

public static final SearchScope SUBTREE

subtree search.

Method Detail

values

public static SearchScope[] 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 c : SearchScope.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 valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null