Package com.opencloud.slee.resources.ldap.objects

Enum LDAPModificationType

java.lang.Object

java.lang.Enum<LDAPModificationType>

com.opencloud.slee.resources.ldap.objects.LDAPModificationType

All Implemented Interfaces:

Serializable, Comparable<LDAPModificationType>

public enum LDAPModificationType
extends Enum<LDAPModificationType>

Represents a data type for modification type values.

The following modification type values are defined:

• ADD -- add values listed to the modification attribute, creating the attribute if necessary.
• DELETE -- delete values listed from the modification attribute. If no values are listed, or if all current values of the attribute are listed, the entire attribute will be removed.
• REPLACE -- replace all existing values of the modification attribute with the new values listed, creating the attribute if it did not already exist. A replace with no value will delete the entire attribute if it exists, and will be ignored if the attribute does not exist.
• INCREMENT -- increment the value of the specified attribute. The target entry must have exactly one value for the specified attribute and it must be an integer. The modification must include exactly one value, and it must be an integer which specifies the amount by which the existing value is to be incremented (or decremented, if the provided value is negative).

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADD	Add values listed to the modification attribute, creating the attribute if necessary.
DELETE	Delete values listed from the modification attribute.
INCREMENT	Increment the value of the specified attribute.
REPLACE	Replace all existing values of the modification attribute with the new values listed, creating the attribute if it did not already exist.

Method Summary

Modifier and Type	Method	Description
int	intValue()	Returns the integer value for this modification type.
static LDAPModificationType	valueOf(int intValue)	Returns the modification type with the specified integer value.
static LDAPModificationType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static LDAPModificationType[]	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

ADD

public static final LDAPModificationType ADD

Add values listed to the modification attribute, creating the attribute if necessary.

DELETE

public static final LDAPModificationType DELETE

Delete values listed from the modification attribute. If no values are listed, or if all current values of the attribute are listed, the entire attribute will be removed.

REPLACE

public static final LDAPModificationType REPLACE

Replace all existing values of the modification attribute with the new values listed, creating the attribute if it did not already exist. A replace with no value will delete the entire attribute if it exists, and will be ignored if the attribute does not exist.

INCREMENT

public static final LDAPModificationType INCREMENT

Increment the value of the specified attribute. The target entry must have exactly one value for the specified attribute and it must be an integer. The modification must include exactly one value, and it must be an integer which specifies the amount by which the existing value is to be incremented (or decremented, if the provided value is negative).

Method Detail

values

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

Returns:

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

valueOf

public static LDAPModificationType valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

valueOf

public static LDAPModificationType valueOf(int intValue)

Returns the modification type with the specified integer value.

Parameters:

intValue - the integer value for which to get the matching modification type.

Returns:

the modification type with the specified integer value.

Throws:

IllegalArgumentException - if the specified value does not match any of the predefined modification types.

intValue

public int intValue()

Returns the integer value for this modification type.

Returns:

the integer value for this modification type.