org.apache.directory.api.ldap.model.ldif
Enum ChangeType

java.lang.Object
  java.lang.Enum<ChangeType>
      org.apache.directory.api.ldap.model.ldif.ChangeType

All Implemented Interfaces:

Serializable, Comparable<ChangeType>

public enum ChangeType
extends Enum<ChangeType>

A type safe enumeration for an LDIF record's change type.

Author:

Apache Directory Project

Enum Constant Summary

Add
The Add changeType

Delete
The Delete changeType

ModDn
The ModDn changeType

Modify
The Modify changeType

ModRdn
The ModRdn changeType

None
A place-holder when we have no changeType

Field Summary

static int	ADD_ORDINAL Add ordinal value
static int	DELETE_ORDINAL Delete ordinal value
static int	MODDN_ORDINAL ModDN ordinal value
static int	MODIFY_ORDINAL Modify ordinal value
static int	MODRDN_ORDINAL ModRDN ordinal value
static int	NONE_ORDINAL None ordinal value

Method Summary

int	getChangeType() Get's the ordinal value for a ChangeType.
static ChangeType	getChangeType(int val) Get the ChangeType instance from an integer value
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

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 ChangeType Add

The Add changeType

Modify

public static final ChangeType Modify

The Modify changeType

ModDn

public static final ChangeType ModDn

The ModDn changeType

ModRdn

public static final ChangeType ModRdn

The ModRdn changeType

Delete

public static final ChangeType Delete

The Delete changeType

None

public static final ChangeType None

A place-holder when we have no changeType

Field Detail

ADD_ORDINAL

public static final int ADD_ORDINAL

Add ordinal value

See Also:

Constant Field Values

MODIFY_ORDINAL

public static final int MODIFY_ORDINAL

Modify ordinal value

See Also:

Constant Field Values

MODDN_ORDINAL

public static final int MODDN_ORDINAL

ModDN ordinal value

See Also:

Constant Field Values

MODRDN_ORDINAL

public static final int MODRDN_ORDINAL

ModRDN ordinal value

See Also:

Constant Field Values

DELETE_ORDINAL

public static final int DELETE_ORDINAL

Delete ordinal value

See Also:

Constant Field Values

NONE_ORDINAL

public static final int NONE_ORDINAL

None ordinal value

See Also:

Constant Field Values

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

getChangeType

public int getChangeType()

Get's the ordinal value for a ChangeType.

Returns:

the changeType

getChangeType

public static ChangeType getChangeType(int val)

Get the ChangeType instance from an integer value

Parameters:

val - The value for the ChangeType we are looking for

Returns:

The associated ChangeType instance