/*
 * 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 2009-2010 Sun Microsystems, Inc.
 *      Portions copyright 2012 ForgeRock AS.
 */

package org.forgerock.opendj.ldap;

import java.util.Collection;
import java.util.Map;

import com.forgerock.opendj.util.Validator;

/**
 * Abstract implementation for {@code Map} based entries.
 */
abstract class AbstractMapEntry extends AbstractEntry {
    private final Map<AttributeDescription, Attribute> attributes;
    private DN name;

    /**
     * Creates an empty entry using the provided distinguished name and
     * {@code Map}.
     *
     * @param name
     *            The distinguished name of this entry.
     * @param attributes
     *            The attribute map.
     */
    AbstractMapEntry(final DN name, final Map<AttributeDescription, Attribute> attributes) {
        this.name = name;
        this.attributes = attributes;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final boolean addAttribute(final Attribute attribute,
            final Collection<ByteString> duplicateValues) {
        final AttributeDescription attributeDescription = attribute.getAttributeDescription();
        final Attribute oldAttribute = getAttribute(attributeDescription);
        if (oldAttribute != null) {
            return oldAttribute.addAll(attribute, duplicateValues);
        } else {
            attributes.put(attributeDescription, attribute);
            return true;
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final Entry clearAttributes() {
        attributes.clear();
        return this;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final Iterable<Attribute> getAllAttributes() {
        return attributes.values();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final Attribute getAttribute(final AttributeDescription attributeDescription) {
        final Attribute attribute = attributes.get(attributeDescription);
        if (attribute == null && attributeDescription.isPlaceHolder()) {
            // Fall-back to inefficient search using place-holder.
            return super.getAttribute(attributeDescription);
        } else {
            return attribute;
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final int getAttributeCount() {
        return attributes.size();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final DN getName() {
        return name;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final boolean removeAttribute(final Attribute attribute,
            final Collection<ByteString> missingValues) {
        final AttributeDescription attributeDescription = attribute.getAttributeDescription();
        if (attribute.isEmpty()) {
            if (attributes.remove(attributeDescription) != null) {
                return true;
            } else if (attributeDescription.isPlaceHolder()) {
                // Fall-back to inefficient remove using place-holder.
                return super.removeAttribute(attribute, missingValues);
            } else {
                return false;
            }
        } else {
            final Attribute oldAttribute = getAttribute(attributeDescription);
            if (oldAttribute != null) {
                final boolean modified = oldAttribute.removeAll(attribute, missingValues);
                if (oldAttribute.isEmpty()) {
                    // Use old attribute's description in case it is different
                    // (e.g. this may be the case when using place-holders).
                    attributes.remove(oldAttribute.getAttributeDescription());
                    return true;
                }
                return modified;
            } else {
                if (missingValues != null) {
                    missingValues.addAll(attribute);
                }
                return false;
            }
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final Entry setName(final DN dn) {
        Validator.ensureNotNull(dn);
        this.name = dn;
        return this;
    }

}