|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<PersistentSearchChangeType>
com.unboundid.ldap.sdk.controls.PersistentSearchChangeType
@ThreadSafety(level=COMPLETELY_THREADSAFE) public 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
EntryChangeNotificationControl
s returned in search result entries
as part of a persistent search.
Enum Constant Summary | |
---|---|
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 | |
---|---|
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. |
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 |
---|
public static final PersistentSearchChangeType ADD
public static final PersistentSearchChangeType DELETE
public static final PersistentSearchChangeType MODIFY
public static final PersistentSearchChangeType MODIFY_DN
Method Detail |
---|
public static PersistentSearchChangeType[] values()
for (PersistentSearchChangeType c : PersistentSearchChangeType.values()) System.out.println(c);
public static PersistentSearchChangeType valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.
java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified name
java.lang.NullPointerException
- if the argument is nullpublic java.lang.String getName()
public int intValue()
public static PersistentSearchChangeType valueOf(int intValue)
intValue
- the numeric value associated with the change type.
null
if there is no
persistent search change type with the specified set of values.public static java.util.Set<PersistentSearchChangeType> allChangeTypes()
public static int encodeChangeTypes(PersistentSearchChangeType... changeTypes)
changeTypes
- The set of change types to be encoded.
public static int encodeChangeTypes(java.util.Collection<PersistentSearchChangeType> changeTypes)
changeTypes
- The set of change types to be encoded.
public static java.util.Set<PersistentSearchChangeType> decodeChangeTypes(int changeTypes)
changeTypes
- The int value representing the encoded set of change
types.
public java.lang.String toString()
toString
in class java.lang.Enum<PersistentSearchChangeType>
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |