/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
* or http://forgerock.org/license/CDDLv1.0.html.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at legal-notices/CDDLv1_0.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2006-2010 Sun Microsystems, Inc.
* Portions Copyright 2015 ForgeRock AS.
*/
package org.opends.server.replication.plugin;
/**
* 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
*/
public enum HistAttrModificationKey
{
/** The key for attribute value deletion. */
DEL("del"),
/** The key for attribute deletion. */
ATTRDEL("attrDel"),
/** The key for attribute replace. */
REPL("repl"),
/** The key for attribute value addition. */
ADD("add");
/** The string representation of this key. */
private String key;
/**
* Creates a new HistKey type with the provided key string.
*
* @param histkey The key string
*/
private HistAttrModificationKey(String histkey)
{
this.key = histkey;
}
/**
* Get a key from the String representation.
*
* @param histkey the String to decode
* @return the key from the enum type
*/
public static HistAttrModificationKey decodeKey(String histkey)
{
for (HistAttrModificationKey histKey : values())
{
if (histKey.toString().equals(histkey))
{
return histKey;
}
}
return null;
}
/**
* Retrieves the human-readable name for this HistKey.
*
* @return The human-readable name for this HistKey.
*/
public String getKey()
{
return key;
}
/**
* Retrieves a string representation of this HistKey.
*
* @return A string representation of this HistKey.
*/
@Override
public String toString()
{
return key;
}
}