001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2006-2008 Sun Microsystems, Inc.
015 * Portions Copyright 2015-2016 ForgeRock AS.
016 */
017package org.opends.server.util;
018
019import org.forgerock.opendj.ldap.DN;
020
021
022
023/**
024 * This class defines a data structure for a change record entry for
025 * an delete operation.  It includes a DN and a set of attributes, as well as
026 * methods to decode the entry.
027 */
028@org.opends.server.types.PublicAPI(
029     stability=org.opends.server.types.StabilityLevel.VOLATILE,
030     mayInstantiate=true,
031     mayExtend=false,
032     mayInvoke=true)
033public final class DeleteChangeRecordEntry extends ChangeRecordEntry
034{
035  /**
036   * Creates a new entry with the provided information.
037   *
038   * @param  dn  The distinguished name for this entry.  It must not be
039   *             <CODE>null</CODE>.
040   */
041  public DeleteChangeRecordEntry(DN dn)
042  {
043    super(dn);
044
045  }
046
047
048
049  /**
050   * Retrieves the name of the change operation type.
051   *
052   * @return  The name of the change operation type.
053   */
054  @Override
055  public ChangeOperationType getChangeOperationType()
056  {
057    return ChangeOperationType.DELETE;
058  }
059
060
061
062  @Override
063  public String toString()
064  {
065    StringBuilder buffer = new StringBuilder();
066    buffer.append("DeleteChangeRecordEntry(dn=\"");
067    buffer.append(getDN());
068    buffer.append("\")");
069
070    return buffer.toString();
071  }
072}
073