org.forgerock.opendj.ldap

Enum Entries.ReplaceStrategy

java.lang.Object

java.lang.Enum<Entries.ReplaceStrategy>

org.forgerock.opendj.ldap.Entries.ReplaceStrategy

All Implemented Interfaces:

Serializable, Comparable<Entries.ReplaceStrategy>

Enclosing class:

Entries

public static enum Entries.ReplaceStrategy
extends Enum<Entries.ReplaceStrategy>

Defines the available strategy to generate changes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NO_REPLACE Requests that the generated changes should use the combination of DELETE then ADD.
REPLACE_ALL_ATTRIBUTES Requests that all generated changes should use the REPLACE modification type, rather than a combination of DELETE and ADD.
REPLACE_SINGLE_VALUED_ATTRIBUTES Requests that the generated changes should use the REPLACE modification type when the new attribute contains at most one attribute value.

Method Summary

Modifier and Type	Method and Description
static Entries.ReplaceStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static Entries.ReplaceStrategy[]	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

NO_REPLACE

public static final Entries.ReplaceStrategy NO_REPLACE

Requests that the generated changes should use the combination of DELETE then ADD.

The generated changes will be reversible.

REPLACE_SINGLE_VALUED_ATTRIBUTES

public static final Entries.ReplaceStrategy REPLACE_SINGLE_VALUED_ATTRIBUTES

Requests that the generated changes should use the REPLACE modification type when the new attribute contains at most one attribute value. All other changes will use a combination of DELETE then ADD.

Specifying this option will usually provide the best overall performance for single and multi-valued attribute updates, but the generated changes will probably not be reversible.

REPLACE_ALL_ATTRIBUTES

public static final Entries.ReplaceStrategy REPLACE_ALL_ATTRIBUTES

Requests that all generated changes should use the REPLACE modification type, rather than a combination of DELETE and ADD.

Note that the generated changes will not be reversible, nor will they be efficient for attributes containing many values (such as groups). Enabling this option may result in more efficient updates for single valued attributes and reduce the amount of replication meta-data that needs to be maintained.

Method Detail

values

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

Returns:

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

valueOf

public static Entries.ReplaceStrategy 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