org.apache.directory.api.ldap.extras.controls.syncrepl.syncState

Enum SyncStateTypeEnum

java.lang.Object

java.lang.Enum<SyncStateTypeEnum>

org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateTypeEnum

All Implemented Interfaces:

Serializable, Comparable<SyncStateTypeEnum>

public enum SyncStateTypeEnum
extends Enum<SyncStateTypeEnum>

This class describes the four types of states part of the syncStateValue as described in rfc4533. state ENUMERATED { present (0), add (1), modify (2), delete (3), #includes the below ApacheDS specific values moddn(4), }

Author:

Apache Directory Project

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADD The entry has been added
DELETE The entry has been deleted
MODDN The entry has been renamed
MODIFY The entry has been modified
PRESENT The entry is present

Field Summary

Fields

Modifier and Type	Field and Description
private int	value the internal value

Method Summary

Modifier and Type	Method and Description
static SyncStateTypeEnum	getSyncStateType(int value) Get the SyncStateTypeEnum instance from an integer value.
int	getValue()
static SyncStateTypeEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static SyncStateTypeEnum[]	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

PRESENT

public static final SyncStateTypeEnum PRESENT

The entry is present

ADD

public static final SyncStateTypeEnum ADD

The entry has been added

MODIFY

public static final SyncStateTypeEnum MODIFY

The entry has been modified

DELETE

public static final SyncStateTypeEnum DELETE

The entry has been deleted

MODDN

public static final SyncStateTypeEnum MODDN

The entry has been renamed

Field Detail

value

private int value

the internal value

Method Detail

values

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

Returns:

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

valueOf

public static SyncStateTypeEnum 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 value associated with the current element.

getSyncStateType

public static SyncStateTypeEnum getSyncStateType(int value)

Get the SyncStateTypeEnum instance from an integer value.

Parameters:

value - The value we want the enum element from

Returns:

The enum element associated with this integer