/*
|
* 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.
|
*/
|
package org.opends.server.util;
|
|
import static org.opends.server.util.Validator.*;
|
|
import org.opends.server.types.DN;
|
|
|
|
/**
|
* This abstract class defines methods for a change record entry. It
|
* includes operations to get the DN, as well as methods to
|
* decode the entry.
|
*/
|
@org.opends.server.types.PublicAPI(
|
stability=org.opends.server.types.StabilityLevel.VOLATILE,
|
mayInstantiate=false,
|
mayExtend=false,
|
mayInvoke=true)
|
public abstract class ChangeRecordEntry
|
{
|
// The DN for this entry.
|
private DN dn;
|
|
|
/**
|
* Creates a new change record entry with the provided information.
|
*
|
* @param dn The distinguished name for this change record entry. It must
|
* not be <CODE>null</CODE>.
|
*/
|
protected ChangeRecordEntry(DN dn)
|
{
|
ensureNotNull(dn);
|
this.dn = dn;
|
}
|
|
|
/**
|
* Retrieves the distinguished name for this entry.
|
*
|
* @return The distinguished name for this entry.
|
*/
|
public final DN getDN()
|
{
|
return dn;
|
}
|
|
|
|
/**
|
* Retrieves the name of the change operation type.
|
*
|
* @return The name of the change operation type.
|
*/
|
public abstract ChangeOperationType getChangeOperationType();
|
|
|
|
/**
|
* Retrieves a string representation of this change record entry.
|
*
|
* @return A string representation of this change record entry.
|
*/
|
public abstract String toString();
|
}
|
