org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationMap.java

/*******************************************************************************
 * Copyright (c) 2000, 2003 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jface.text.source;

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

import org.eclipse.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. 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>
 * 
 * @since 3.0
 */
public interface IAnnotationMap extends 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();
}