org.opends.server.replication.plugin
Enum HistKey

java.lang.Object
  extended by java.lang.Enum<HistKey>
      extended by org.opends.server.replication.plugin.HistKey
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<HistKey>

public enum HistKey
extends java.lang.Enum<HistKey>

Enumeration used for storing type of historical information.


Enum Constant Summary
ADD
          The key for attribute value addition.
DEL
          The key for attribute value deletion.
DELATTR
          The key for attribute deletion.
REPL
          The key for attribute replace.
 
Method Summary
static HistKey decodeKey(java.lang.String histkey)
          Get a key from the String representation.
 java.lang.String getKey()
          Retrieves the human-readable name for this HistKey.
 java.lang.String toString()
          Retrieves a string representation of this HistKey.
static HistKey valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static HistKey[] 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 HistKey DEL
The key for attribute value deletion.


DELATTR

public static final HistKey DELATTR
The key for attribute deletion.


REPL

public static final HistKey REPL
The key for attribute replace.


ADD

public static final HistKey ADD
The key for attribute value addition.

Method Detail

values

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

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

valueOf

public static HistKey valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

decodeKey

public static HistKey decodeKey(java.lang.String histkey)
Get a key from the String representation.

Parameters:
histkey - the String to decode
Returns:
the key from the enum type

getKey

public java.lang.String getKey()
Retrieves the human-readable name for this HistKey.

Returns:
The human-readable name for this HistKey.

toString

public java.lang.String toString()
Retrieves a string representation of this HistKey.

Overrides:
toString in class java.lang.Enum<HistKey>
Returns:
A string representation of this HistKey.