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 2014-2015 ForgeRock AS
026 */
027package org.opends.server.util;
028
029import static org.forgerock.util.Reject.*;
030
031import org.opends.server.types.DN;
032
033
034
035/**
036 * This abstract class defines methods for a change record entry.  It
037 * includes operations to get the DN, as well as methods to
038 * decode the entry.
039 */
040@org.opends.server.types.PublicAPI(
041     stability=org.opends.server.types.StabilityLevel.VOLATILE,
042     mayInstantiate=false,
043     mayExtend=false,
044     mayInvoke=true)
045public abstract class ChangeRecordEntry
046{
047  /** The DN for this entry. */
048  private DN dn;
049
050
051  /**
052   * Creates a new change record entry with the provided information.
053   *
054   * @param  dn  The distinguished name for this change record entry.  It must
055   *             not be <CODE>null</CODE>.
056   */
057  protected ChangeRecordEntry(DN dn)
058  {
059    ifNull(dn);
060    this.dn = dn;
061  }
062
063
064  /**
065   * Retrieves the distinguished name for this entry.
066   *
067   * @return  The distinguished name for this entry.
068   */
069  public final DN getDN()
070  {
071    return dn;
072  }
073
074
075
076  /**
077   * Retrieves the name of the change operation type.
078   *
079   * @return  The name of the change operation type.
080   */
081  public abstract ChangeOperationType getChangeOperationType();
082
083
084
085  /**
086   * Retrieves a string representation of this change record entry.
087   *
088   * @return  A string representation of this change record entry.
089   */
090  public abstract String toString();
091}
092