Package org.opends.server.replication.plugin

Enum HistAttrModificationKey

java.lang.Object

java.lang.Enum<HistAttrModificationKey>

org.opends.server.replication.plugin.HistAttrModificationKey

All Implemented Interfaces:

Serializable, Comparable<HistAttrModificationKey>

public enum HistAttrModificationKey
extends Enum<HistAttrModificationKey>

Enumeration used for storing type of attribute modification in the value of the replication historical information. Example of ds-sync-hist values: ds-sync-hist: attrName1:changeNumber1:repl:newReplacingValue ds-sync-hist: attrName1:changeNumber2:del:deletedValue ds-sync-hist: attrName3:changeNumber3:add:newAddedvalue ds-sync-hist: attrName3:changeNumber4:attrDel

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADD	The key for attribute value addition.
ATTRDEL	The key for attribute deletion.
DEL	The key for attribute value deletion.
REPL	The key for attribute replace.

Method Summary

Modifier and Type	Method	Description
static HistAttrModificationKey	decodeKey(String histkey)	Get a key from the String representation.
String	getKey()	Retrieves the human-readable name for this HistKey.
String	toString()	Retrieves a string representation of this HistKey.
static HistAttrModificationKey	valueOf(String name)	Returns the enum constant of this type with the specified name.
static HistAttrModificationKey[]	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

DEL

public static final HistAttrModificationKey DEL

The key for attribute value deletion.

ATTRDEL

public static final HistAttrModificationKey ATTRDEL

The key for attribute deletion.

REPL

public static final HistAttrModificationKey REPL

The key for attribute replace.

ADD

public static final HistAttrModificationKey ADD

The key for attribute value addition.

Method Detail

values

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

Returns:

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

valueOf

public static HistAttrModificationKey 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

decodeKey

public static HistAttrModificationKey decodeKey(String histkey)

Get a key from the String representation.

Parameters:

histkey - the String to decode

Returns:

the key from the enum type

getKey

public String getKey()

Retrieves the human-readable name for this HistKey.

Returns:

The human-readable name for this HistKey.

toString

public String toString()

Retrieves a string representation of this HistKey.

Overrides:

toString in class Enum<HistAttrModificationKey>

Returns:

A string representation of this HistKey.