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