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

Enum AdDirSyncFlag

java.lang.Object

java.lang.Enum<AdDirSyncFlag>

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

All Implemented Interfaces:

Serializable, Comparable<AdDirSyncFlag>

public enum AdDirSyncFlag
extends Enum<AdDirSyncFlag>

The flags used in the AdDirSync response.

Author:

Apache Directory Project

Enum Constant Summary

Enum Constants

Enum Constant and Description
LDAP_DIRSYNC_ANCESTORS_FIRST_ORDER The Ancestors First Order flag
LDAP_DIRSYNC_INCREMENTAL_VALUES The Incremental Values flag
LDAP_DIRSYNC_OBJECT_SECURITY The Object Security flag
LDAP_DIRSYNC_PUBLIC_DATA_ONLY The Public Data Only flag

Field Summary

Fields

Modifier and Type	Field and Description
private String	description The string description
private int	value The int value

Method Summary

Modifier and Type	Method and Description
static int	getBitmask(Set<AdDirSyncFlag> flags) Get back the bitmask (as an integer) associated with the given flags
static Set<AdDirSyncFlag>	getFlags(int value) Get back the combination of flags associated with a given value
int	getValue()
String	toString()
static AdDirSyncFlag	valueOf(String name) Returns the enum constant of this type with the specified name.
static AdDirSyncFlag[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LDAP_DIRSYNC_OBJECT_SECURITY

public static final AdDirSyncFlag LDAP_DIRSYNC_OBJECT_SECURITY

The Object Security flag

LDAP_DIRSYNC_ANCESTORS_FIRST_ORDER

public static final AdDirSyncFlag LDAP_DIRSYNC_ANCESTORS_FIRST_ORDER

The Ancestors First Order flag

LDAP_DIRSYNC_PUBLIC_DATA_ONLY

public static final AdDirSyncFlag LDAP_DIRSYNC_PUBLIC_DATA_ONLY

The Public Data Only flag

LDAP_DIRSYNC_INCREMENTAL_VALUES

public static final AdDirSyncFlag LDAP_DIRSYNC_INCREMENTAL_VALUES

The Incremental Values flag

Field Detail

value

private int value

The int value

description

private String description

The string description

Method Detail

values

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

Returns:

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

valueOf

public static AdDirSyncFlag 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 associated value of a given flag

toString

public String toString()

Overrides:

toString in class Enum<AdDirSyncFlag>

See Also:

Object.toString()

getFlags

public static Set<AdDirSyncFlag> getFlags(int value)

Get back the combination of flags associated with a given value

Parameters:

value - The integer value

Returns:

a set of all flags associated with the integer value

getBitmask

public static int getBitmask(Set<AdDirSyncFlag> flags)

Get back the bitmask (as an integer) associated with the given flags

Parameters:

flags - The AdDirSync flags

Returns:

a bitmask in integer form associated with the set of flags