|
129
|
1 /*******************************************************************************
|
|
|
2 * Copyright (c) 2000, 2005 IBM Corporation and others.
|
|
|
3 * All rights reserved. This program and the accompanying materials
|
|
|
4 * are made available under the terms of the Eclipse Public License v1.0
|
|
|
5 * which accompanies this distribution, and is available at
|
|
|
6 * http://www.eclipse.org/legal/epl-v10.html
|
|
|
7 *
|
|
|
8 * Contributors:
|
|
|
9 * IBM Corporation - initial API and implementation
|
|
|
10 * Port to the D programming language:
|
|
|
11 * Frank Benoit <benoit@tionex.de>
|
|
|
12 *******************************************************************************/
|
|
|
13 module dwtx.jface.text.source.IAnnotationMap;
|
|
|
14
|
|
|
15 import dwt.dwthelper.utils;
|
|
|
16
|
|
|
17
|
|
|
18 import java.util.Collection;
|
|
|
19 import java.util.Iterator;
|
|
|
20 import java.util.Map;
|
|
|
21 import java.util.Set;
|
|
|
22
|
|
|
23 import dwtx.jface.text.ISynchronizable;
|
|
|
24
|
|
|
25
|
|
|
26 /**
|
|
|
27 * An annotation map is a map specialized for the requirements of an annotation
|
|
|
28 * model. The annotation map supports a customizable lock object which is used
|
|
|
29 * to synchronize concurrent operations on the map (see
|
|
|
30 * {@link dwtx.jface.text.ISynchronizable}. The map supports two
|
|
|
31 * iterator methods, one for the values and one for the keys of the map. The
|
|
|
32 * returned iterators are robust, i.e. they work on a copy of the values and
|
|
|
33 * keys set that is made at the point in time the iterator methods are called.
|
|
|
34 * <p>
|
|
|
35 * The returned collections of the methods <code>values</code>,
|
|
|
36 * <code>entrySet</code>, and <code>keySet</code> are not synchronized on
|
|
|
37 * the annotation map's lock object.
|
|
|
38 * <p>
|
|
|
39 *
|
|
|
40 * @see dwtx.jface.text.source.IAnnotationModel
|
|
|
41 * @since 3.0
|
|
|
42 */
|
|
|
43 public interface IAnnotationMap : Map, ISynchronizable {
|
|
|
44
|
|
|
45 /**
|
|
|
46 * Returns an iterator for a copy of this annotation map's values.
|
|
|
47 *
|
|
|
48 * @return an iterator for a copy of this map's values
|
|
|
49 */
|
|
|
50 Iterator valuesIterator();
|
|
|
51
|
|
|
52 /**
|
|
|
53 * Returns an iterator for a copy of this map's key set.
|
|
|
54 *
|
|
|
55 * @return an iterator for a copy of this map's key set
|
|
|
56 */
|
|
|
57 Iterator keySetIterator();
|
|
|
58
|
|
|
59 /**
|
|
|
60 * {@inheritDoc}
|
|
|
61 *
|
|
|
62 * The returned set is not synchronized on this annotation map's lock object.
|
|
|
63 */
|
|
|
64 Set entrySet();
|
|
|
65
|
|
|
66 /**
|
|
|
67 * {@inheritDoc}
|
|
|
68 *
|
|
|
69 * The returned set is not synchronized on this annotation map's lock object.
|
|
|
70 */
|
|
|
71 Set keySet();
|
|
|
72
|
|
|
73 /**
|
|
|
74 * {@inheritDoc}
|
|
|
75 *
|
|
|
76 * The returned collection is not synchronized on this annotation map's lock object.
|
|
|
77 */
|
|
|
78 Collection values();
|
|
|
79 }
|
