DeleteChangeRecordEntry.java revision ea1068c292e9b341af6d6b563cd8988a96be20a9
/*
* 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-2008 Sun Microsystems, Inc.
* Portions Copyright 2015 ForgeRock AS
*/
package org.opends.server.util;
import org.opends.server.types.DN;
/**
* This class defines a data structure for a change record entry for
* an delete operation. It includes a DN and a set of attributes, as well as
* methods to decode the entry.
*/
@org.opends.server.types.PublicAPI(
stability=org.opends.server.types.StabilityLevel.VOLATILE,
mayInstantiate=true,
mayExtend=false,
mayInvoke=true)
public final class DeleteChangeRecordEntry extends ChangeRecordEntry
{
/**
* Creates a new entry with the provided information.
*
* @param dn The distinguished name for this entry. It must not be
* <CODE>null</CODE>.
*/
public DeleteChangeRecordEntry(DN dn)
{
super(dn);
}
/**
* Retrieves the name of the change operation type.
*
* @return The name of the change operation type.
*/
public ChangeOperationType getChangeOperationType()
{
return ChangeOperationType.DELETE;
}
/**
* {@inheritDoc}
*/
@Override
public String toString()
{
StringBuilder buffer = new StringBuilder();
buffer.append("DeleteChangeRecordEntry(dn=\"");
buffer.append(String.valueOf(getDN()));
buffer.append("\")");
return buffer.toString();
}
}