/*
 * 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
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
 * 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
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  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
 *
 *
 *      Portions Copyright 2006 Sun Microsystems, Inc.
 */
package org.opends.server.util;



import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedList;

import org.opends.server.types.Attribute;
import org.opends.server.types.AttributeType;
import org.opends.server.types.DN;

import static org.opends.server.loggers.Debug.*;
import static org.opends.server.messages.CoreMessages.*;
import static org.opends.server.messages.MessageHandler.*;
import static org.opends.server.util.ServerConstants.*;
import static org.opends.server.util.StaticUtils.*;



/**
 * This class defines a data structure for a change record entry for
 * an add operation.  It includes a DN and a set of attributes, as well as
 * methods to decode the entry.
 */
public class AddChangeRecordEntry extends ChangeRecordEntry
{
  /**
   * The fully-qualified name of this class for debugging purposes.
   */
  private static final String CLASS_NAME =
      "org.opends.server.util.AddChangeRecordEntry";


  /**
   * The entry attributes for this operation.
   */
  private HashMap<AttributeType,ArrayList<Attribute>> entryAttributes;

  // The LDIF reader instance
  private LDIFReader reader;


  /**
   * Creates a new entry with the provided information.
   *
   * @param  dn      The distinguished name for this entry.
   * @param  reader  The LDIF reader instance used to read the entries.
   */
  public AddChangeRecordEntry(DN dn, LDIFReader reader)
  {
    super(dn, reader);
    assert debugConstructor(CLASS_NAME, String.valueOf(dn),
                            String.valueOf(reader));


    this.reader = reader;
    entryAttributes = new HashMap<AttributeType, ArrayList<Attribute>>();

  }



  /**
   * Retrieves the name of the change operation type.
   *
   * @return  The name of the change operation type.
   */
  public ChangeOperationType getChangeOperationType()
  {
    assert debugEnter(CLASS_NAME, "getChangeOperationType");

    return ChangeOperationType.ADD;
  }


  /**
   * Retrieves the entire set of attributes for this entry.
   * The caller must not modify the contents of this list.
   *
   * @return  The entire set of attributes for this entry.
   */
  public ArrayList<Attribute> getAttributes()
  {
    assert debugEnter(CLASS_NAME, "getAttributes");

    ArrayList<Attribute> attributes = new ArrayList<Attribute>();

    for (ArrayList<Attribute> list : entryAttributes.values())
    {
      for (Attribute a : list)
      {
        attributes.add(a);
      }
    }
    return attributes;
  }

  /**
   * Parse the lines and populate the internal structures.
   *
   * @param lines       The lines to parse.
   * @param lineNumber  The current line number
   *
   * @exception LDIFException if there is an error during parsing.
   */
  public void parse(LinkedList<StringBuilder> lines, long lineNumber)
    throws LDIFException
  {
    assert debugEnter(CLASS_NAME, "parse", String.valueOf(lines),
                      String.valueOf(lineNumber));
    for(StringBuilder line : lines)
    {
      reader.readAttribute(lines, line, getDN(), entryAttributes);
    }
  }

}