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

Enum SynchronizationModeEnum

java.lang.Object

java.lang.Enum<SynchronizationModeEnum>

org.apache.directory.api.ldap.extras.controls.SynchronizationModeEnum

All Implemented Interfaces:

Serializable, Comparable<SynchronizationModeEnum>

public enum SynchronizationModeEnum
extends Enum<SynchronizationModeEnum>

This class describes the four possible synchronization mode, out of which only two are presently valid :

 syncRequestValue ::= SEQUENCE {
     mode ENUMERATED {
         -- 0 unused
         refreshOnly       (1),
         -- 2 reserved
         refreshAndPersist (3)
 ...
 

Author:

Apache Directory Project

See Also:

RFC 4533

Enum Constant Summary

Enum Constants

Enum Constant and Description
REFRESH_AND_PERSIST Refresh and Persist mode
REFRESH_ONLY Refresh only mode
RESERVED Unused
UNUSED Unused

Field Summary

Fields

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

Method Summary

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

UNUSED

public static final SynchronizationModeEnum UNUSED

Unused

REFRESH_ONLY

public static final SynchronizationModeEnum REFRESH_ONLY

Refresh only mode

RESERVED

public static final SynchronizationModeEnum RESERVED

Unused

REFRESH_AND_PERSIST

public static final SynchronizationModeEnum REFRESH_AND_PERSIST

Refresh and Persist mode

Field Detail

value

private int value

The internal value

Method Detail

values

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

Returns:

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

valueOf

public static SynchronizationModeEnum 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.

getSyncMode

public static SynchronizationModeEnum getSyncMode(int value)

Get the SynchronizationModeEnum instance from an integer value.

Parameters:

value - The value we want the enum element from

Returns:

The enum element associated with this integer