org.ldaptive.ad.control

Enum SearchOptionsControl.Flag

java.lang.Object

java.lang.Enum<SearchOptionsControl.Flag>

org.ldaptive.ad.control.SearchOptionsControl.Flag

All Implemented Interfaces:

Serializable, Comparable<SearchOptionsControl.Flag>

Enclosing class:

SearchOptionsControl

public static enum SearchOptionsControl.Flag
extends Enum<SearchOptionsControl.Flag>

Types of flags.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOMAIN_SCOPE SERVER_SEARCH_FLAG_DOMAIN_SCOPE .
PHANTOM_ROOT SERVER_SEARCH_FLAG_PHANTOM_ROOT .

Method Summary

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

DOMAIN_SCOPE

public static final SearchOptionsControl.Flag DOMAIN_SCOPE

SERVER_SEARCH_FLAG_DOMAIN_SCOPE .

PHANTOM_ROOT

public static final SearchOptionsControl.Flag PHANTOM_ROOT

SERVER_SEARCH_FLAG_PHANTOM_ROOT .

Method Detail

values

public static SearchOptionsControl.Flag[] 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 (SearchOptionsControl.Flag c : SearchOptionsControl.Flag.values())
    System.out.println(c);

Returns:

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

valueOf

public static SearchOptionsControl.Flag valueOf(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:

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

NullPointerException - if the argument is null