com.unboundid.ldap.sdk.controls

Enum PersistentSearchChangeType

java.lang.Object

java.lang.Enum<PersistentSearchChangeType>

com.unboundid.ldap.sdk.controls.PersistentSearchChangeType

All Implemented Interfaces:

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

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum PersistentSearchChangeType
extends java.lang.Enum<PersistentSearchChangeType>

This enum defines a set of change types that can be associated with persistent search operations. Change types may be used in the PersistentSearchRequestControl, as well as in EntryChangeNotificationControls returned in search result entries as part of a persistent search.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADD Indicates that the change type is for an add operation.
DELETE Indicates that the change type is for a delete operation.
MODIFY Indicates that the change type is for a modify operation.
MODIFY_DN Indicates that the change type is for a modify DN operation.

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Set<PersistentSearchChangeType>	allChangeTypes() Retrieves a set containing all defined change types.
static java.util.Set<PersistentSearchChangeType>	decodeChangeTypes(int changeTypes) Decodes the provided set of change types from the provided value.
static int	encodeChangeTypes(java.util.Collection<PersistentSearchChangeType> changeTypes) Encodes the provided set of change types into an integer value suitable for use as the change types for the persistent search request control.
static int	encodeChangeTypes(PersistentSearchChangeType... changeTypes) Encodes the provided set of change types into an integer value suitable for use as the change types for the persistent search request control.
static PersistentSearchChangeType	forName(java.lang.String name) Retrieves the persistent search change type with the specified name.
java.lang.String	getName() Retrieves the human-readable name for this change type.
int	intValue() Retrieves the integer value for this change type.
java.lang.String	toString() Retrieves a string representation for this persistent search change type.
static PersistentSearchChangeType	valueOf(int intValue) Retrieves the persistent search change type with the specified int value.
static PersistentSearchChangeType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PersistentSearchChangeType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADD

public static final PersistentSearchChangeType ADD

Indicates that the change type is for an add operation.

DELETE

public static final PersistentSearchChangeType DELETE

Indicates that the change type is for a delete operation.

MODIFY

public static final PersistentSearchChangeType MODIFY

Indicates that the change type is for a modify operation.

MODIFY_DN

public static final PersistentSearchChangeType MODIFY_DN

Indicates that the change type is for a modify DN operation.

Method Detail

values

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

Returns:

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

valueOf

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

getName

@NotNull
public java.lang.String getName()

Retrieves the human-readable name for this change type.

Returns:

The human-readable name for this change type.

intValue

public int intValue()

Retrieves the integer value for this change type.

Returns:

The integer value for this change type.

valueOf

@Nullable
public static PersistentSearchChangeType valueOf(int intValue)

Retrieves the persistent search change type with the specified int value.

Parameters:

intValue - the numeric value associated with the change type.

Returns:

The associated change type, or null if there is no persistent search change type with the specified set of values.

forName

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

Retrieves the persistent search change type with the specified name.

Parameters:

name - The name of the change type for which to retrieve the name. It must not be null.

Returns:

The requested persistent search change type, or null if there is no change type with the given name.

allChangeTypes

@NotNull
public static java.util.Set<PersistentSearchChangeType> allChangeTypes()

Retrieves a set containing all defined change types.

Returns:

A set containing all defined change types.

encodeChangeTypes

public static int encodeChangeTypes(@NotNull
                    PersistentSearchChangeType... changeTypes)

Encodes the provided set of change types into an integer value suitable for use as the change types for the persistent search request control.

Parameters:

changeTypes - The set of change types to be encoded.

Returns:

An integer value containing the encoded representation of the change types.

encodeChangeTypes

public static int encodeChangeTypes(@NotNull
                    java.util.Collection<PersistentSearchChangeType> changeTypes)

Encodes the provided set of change types into an integer value suitable for use as the change types for the persistent search request control.

Parameters:

changeTypes - The set of change types to be encoded.

Returns:

An integer value containing the encoded representation of the change types.

decodeChangeTypes

@NotNull
public static java.util.Set<PersistentSearchChangeType> decodeChangeTypes(int changeTypes)

Decodes the provided set of change types from the provided value.

Parameters:

changeTypes - The int value representing the encoded set of change types.

Returns:

A list of the change types encoded in the provided value.

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation for this persistent search change type.

Overrides:

toString in class java.lang.Enum<PersistentSearchChangeType>

Returns:

A string representation for this persistent search change type.