com.unboundid.ldap.sdk.controls

Enum ContentSyncRequestMode

java.lang.Object

java.lang.Enum<ContentSyncRequestMode>

com.unboundid.ldap.sdk.controls.ContentSyncRequestMode

All Implemented Interfaces:

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

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

This enum defines the modes which may be used with the content synchronization request control. See the documentation for the ContentSyncRequestControl class for more information about using the content synchronization operation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
REFRESH_AND_PERSIST Indicates that the client wishes to retrieve information about entries which have changed up to this point, and also to be notified of any additional matching changes in the future.
REFRESH_ONLY Indicates that the client only wishes to retrieve information about entries which have changed up to this point.

Method Summary

Modifier and Type	Method and Description
static ContentSyncRequestMode	forName(java.lang.String name) Retrieves the content synchronization request mode with the specified name.
int	intValue() Retrieves the integer value for this request mode.
static ContentSyncRequestMode	valueOf(int intValue) Retrieves the content synchronization request mode with the specified integer value.
static ContentSyncRequestMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ContentSyncRequestMode[]	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 ContentSyncRequestMode REFRESH_ONLY

Indicates that the client only wishes to retrieve information about entries which have changed up to this point.

REFRESH_AND_PERSIST

public static final ContentSyncRequestMode REFRESH_AND_PERSIST

Indicates that the client wishes to retrieve information about entries which have changed up to this point, and also to be notified of any additional matching changes in the future.

Method Detail

values

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

Returns:

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

valueOf

public static ContentSyncRequestMode 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

intValue

public int intValue()

Retrieves the integer value for this request mode.

Returns:

The integer value for this request mode.

valueOf

@Nullable
public static ContentSyncRequestMode valueOf(int intValue)

Retrieves the content synchronization request mode with the specified integer value.

Parameters:

intValue - The integer value for which to retrieve the corresponding request mode.

Returns:

The content synchronization mode with the specified integer value, or null if the given value does not correspond with any defined mode.

forName

@Nullable
public static ContentSyncRequestMode forName(@NotNull
                                                       java.lang.String name)

Retrieves the content synchronization request mode with the specified name.

Parameters:

name - The name of the content synchronization request mode to retrieve. It must not be null.

Returns:

The requested content sync request mode, or null if no such mode is defined.