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 java.util.*;
030
031import org.opends.server.types.DN;
032import org.opends.server.types.RawModification;
033
034import static org.forgerock.util.Reject.*;
035
036/**
037 * This class defines a data structure for a change record entry for
038 * an modify operation.  It includes a DN and a set of attributes, as well as
039 * methods to decode the entry.
040 */
041@org.opends.server.types.PublicAPI(
042     stability=org.opends.server.types.StabilityLevel.VOLATILE,
043     mayInstantiate=true,
044     mayExtend=false,
045     mayInvoke=true)
046public final class ModifyChangeRecordEntry extends ChangeRecordEntry
047{
048  /**
049   * The modifications for this change record.
050   */
051  private final List<RawModification> modifications;
052
053
054
055  /**
056   * Creates a new entry with the provided information.
057   *
058   * @param  dn             The distinguished name for this entry.  It must not
059   *                        be  <CODE>null</CODE>.
060   * @param  modifications  The modifications for this change record.  It must
061   *                        not be <CODE>null</CODE>.
062   */
063  public ModifyChangeRecordEntry(DN dn,
064      Collection<RawModification> modifications)
065  {
066    super(dn);
067
068
069    ifNull(modifications);
070
071    this.modifications = new ArrayList<>(modifications);
072  }
073
074
075  /**
076   * Get the list of modifications.
077   * <p>
078   * The returned list is read-only.
079   *
080   * @return Returns the unmodifiable list of modifications.
081   */
082  public List<RawModification> getModifications()
083  {
084    return Collections.unmodifiableList(modifications);
085  }
086
087
088
089  /**
090   * Retrieves the name of the change operation type.
091   *
092   * @return  The name of the change operation type.
093   */
094  @Override
095  public ChangeOperationType getChangeOperationType()
096  {
097    return ChangeOperationType.MODIFY;
098  }
099
100
101
102  /** {@inheritDoc} */
103  @Override
104  public String toString()
105  {
106    StringBuilder buffer = new StringBuilder();
107    buffer.append("ModifyChangeRecordEntry(dn=\"");
108    buffer.append(getDN());
109    buffer.append("\", mods={");
110
111    Iterator<RawModification> iterator = modifications.iterator();
112    while (iterator.hasNext())
113    {
114      RawModification mod = iterator.next();
115      buffer.append(mod.getModificationType());
116      buffer.append(" ");
117      buffer.append(mod.getAttribute().getAttributeType());
118
119      if (iterator.hasNext())
120      {
121        buffer.append(", ");
122      }
123    }
124    buffer.append("})");
125
126    return buffer.toString();
127  }
128}
129