/*******************************************************************************
 * Copyright (c) 2000, 2005 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 * Port to the D programming language:
 *     Frank Benoit <benoit@tionex.de>
 *******************************************************************************/
module dwtx.jface.text.source.IAnnotationMap;

import dwt.dwthelper.utils;


import java.util.Collection;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;

import dwtx.jface.text.ISynchronizable;


/**
 * An annotation map is a map specialized for the requirements of an annotation
 * model. The annotation map supports a customizable lock object which is used
 * to synchronize concurrent operations on the map (see
 * {@link dwtx.jface.text.ISynchronizable}. The map supports two
 * iterator methods, one for the values and one for the keys of the map. The
 * returned iterators are robust, i.e. they work on a copy of the values and
 * keys set that is made at the point in time the iterator methods are called.
 * <p>
 * The returned collections of the methods <code>values</code>,
 * <code>entrySet</code>, and <code>keySet</code> are not synchronized on
 * the annotation map's lock object.
 * <p>
 *
 * @see dwtx.jface.text.source.IAnnotationModel
 * @since 3.0
 */
public interface IAnnotationMap : Map, ISynchronizable {

    /**
     * Returns an iterator for a copy of this annotation map's values.
     *
     * @return an iterator for a copy of this map's values
     */
    Iterator valuesIterator();

    /**
     * Returns an iterator for a copy of this map's key set.
     *
     * @return an iterator for a copy of this map's key set
     */
    Iterator keySetIterator();

    /**
     * {@inheritDoc}
     *
     * The returned set is not synchronized on this annotation map's lock object.
     */
    Set entrySet();

    /**
     * {@inheritDoc}
     *
     * The returned set is not synchronized on this annotation map's lock object.
     */
    Set keySet();

    /**
     * {@inheritDoc}
     *
     * The returned collection is not synchronized on this annotation map's lock object.
     */
    Collection values();
}