com.unboundid.ldap.sdk
Enum ChangeType

java.lang.Object
  extended by java.lang.Enum<ChangeType>
      extended by com.unboundid.ldap.sdk.ChangeType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ChangeType>

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

This enum defines a set of change types that are associated with operations that may be processed in an LDAP directory server. The defined change types are "add", "delete", "modify", and "modify DN".


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 ChangeType forName(java.lang.String name)
          Retrieves the change type with the specified name.
 java.lang.String getName()
          Retrieves the human-readable name for this change type.
 java.lang.String toString()
          Retrieves a string representation for this change type.
static ChangeType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ChangeType[] 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 ChangeType ADD
Indicates that the change type is for an add operation.


DELETE

public static final ChangeType DELETE
Indicates that the change type is for a delete operation.


MODIFY

public static final ChangeType MODIFY
Indicates that the change type is for a modify operation.


MODIFY_DN

public static final ChangeType MODIFY_DN
Indicates that the change type is for a modify DN operation.

Method Detail

values

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

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

valueOf

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

public java.lang.String getName()
Retrieves the human-readable name for this change type.

Returns:
The human-readable name for this change type.

forName

public static ChangeType forName(java.lang.String name)
Retrieves the change type with the specified name.

Parameters:
name - The name of the change type to retrieve.
Returns:
The requested change type, or null if no such change type is defined.

toString

public java.lang.String toString()
Retrieves a string representation for this change type.

Overrides:
toString in class java.lang.Enum<ChangeType>
Returns:
A string representation for this change type.