org.ldaptive.control

Enum SyncRequestControl.Mode

java.lang.Object

java.lang.Enum<SyncRequestControl.Mode>

org.ldaptive.control.SyncRequestControl.Mode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SyncRequestControl.Mode>

Enclosing class:

SyncRequestControl

public static enum SyncRequestControl.Mode
extends java.lang.Enum<SyncRequestControl.Mode>

Types of request modes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
REFRESH_AND_PERSIST refresh and persist.
REFRESH_ONLY refresh only.

Field Summary

Fields

Modifier and Type	Field and Description
private int	value underlying value.

Method Summary

Modifier and Type	Method and Description
int	value() Returns the value.
static SyncRequestControl.Mode	valueOf(int i) Returns the mode for the supplied integer constant.
static SyncRequestControl.Mode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SyncRequestControl.Mode[]	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

REFRESH_ONLY

public static final SyncRequestControl.Mode REFRESH_ONLY

refresh only.

REFRESH_AND_PERSIST

public static final SyncRequestControl.Mode REFRESH_AND_PERSIST

refresh and persist.

Field Detail

value

private final int value

underlying value.

Method Detail

values

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

Returns:

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

valueOf

public static SyncRequestControl.Mode 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

value

public int value()

Returns the value.

Returns:

enum value

valueOf

public static SyncRequestControl.Mode valueOf(int i)

Returns the mode for the supplied integer constant.

Parameters:

i - to find mode for

Returns:

mode