Package org.apache.directory.api.ldap.model.message.controls

Enum ChangeType

java.lang.Object

java.lang.Enum<ChangeType>

org.apache.directory.api.ldap.model.message.controls.ChangeType

All Implemented Interfaces:

Serializable, Comparable<ChangeType>

public enum ChangeType
extends Enum<ChangeType>

Enumeration type for entry changes associates with the persistent search control and the entry change control. Used for the following ASN1 enumeration:

   changeType ENUMERATED 
   {
       add             (1),
       delete          (2),
       modify          (4),
       modDN           (8)
   }
 

Author:

Apache Directory Project

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADD	An ADD
DELETE	A Delete
MODDN	A MODDN
MODIFY	A Modify

Method Summary

Modifier and Type	Method	Description
static ChangeType	getChangeType(int value)	Gets the changeType enumeration type for an integer value.
int	getValue()
boolean	presentIn(int changeTypes)	Checks via bitwise AND to see if this ChangeType value is within the supplied changeTypes.
static ChangeType	valueOf(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

compareTo, equals, 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 ChangeType ADD

An ADD

DELETE

public static final ChangeType DELETE

A Delete

MODIFY

public static final ChangeType MODIFY

A Modify

MODDN

public static final ChangeType MODDN

A MODDN

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(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

getValue

public int getValue()

Returns:

The int value of the ChangeType

presentIn

public boolean presentIn(int changeTypes)

Checks via bitwise AND to see if this ChangeType value is within the supplied changeTypes.

Parameters:

changeTypes - The supplied changeTypes.

Returns:

true, if this ChangeType is present in the supplied changeTypes.

getChangeType

public static ChangeType getChangeType(int value)

Gets the changeType enumeration type for an integer value.

Parameters:

value - the value to get the enumeration for

Returns:

the enueration type for the value if the value is valid

Throws:

IllegalArgumentException - if the value is undefined