try to fix some minor dropdown bugs
[potlatch2.git] / org / idmedia / as3commons / util / Map.as
1 /*
2  * Copyright the original author or authors.
3  * 
4  * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  * 
8  *      http://www.mozilla.org/MPL/MPL-1.1.html
9  * 
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.idmedia.as3commons.util {
17   
18   /**
19    * An object that maps keys to values.  A map cannot contain duplicate keys;
20    * each key can map to at most one value.
21    *
22    * <p>The <tt>Map</tt> interface provides three <i>collection views</i>, which
23    * allow a map's contents to be viewed as a set of keys, collection of values,
24    * or set of key-value mappings.  The <i>order</i> of a map is defined as
25    * the order in which the iterators on the map's collection views return their
26    * elements.  Some map implementations, like the <tt>TreeMap</tt> class, make
27    * specific guarantees as to their order; others, like the <tt>HashMap</tt>
28    * class, do not.
29    *
30    * <p>Note: great care must be exercised if mutable objects are used as map
31    * keys.  The behavior of a map is not specified if the value of an object is
32    * changed in a manner that affects equals comparisons while the object is a
33    * key in the map.  A special case of this prohibition is that it is not
34    * permissible for a map to contain itself as a key.  While it is permissible
35    * for a map to contain itself as a value, extreme caution is advised: the
36    * equals and hashCode methods are no longer well defined on a such a map.
37    *
38    * <p>The "destructive" methods contained in this interface, that is, the
39    * methods that modify the map on which they operate, are specified to throw
40    * <tt>UnsupportedOperationException</tt> if this map does not support the
41    * operation.  If this is the case, these methods may, but are not required
42    * to, throw an <tt>UnsupportedOperationException</tt> if the invocation would
43    * have no effect on the map.  For example, invoking the #putAll(Map)
44    * method on an unmodifiable map may, but is not required to, throw the
45    * exception if the map whose mappings are to be "superimposed" is empty.
46    *
47    * <p>Some map implementations have restrictions on the keys and values they
48    * may contain.  For example, some implementations prohibit null keys and
49    * values, and some have restrictions on the types of their keys.  Attempting
50    * to insert an ineligible key or value throws an unchecked exception,
51    * typically <tt>NullPointerException</tt> or <tt>ClassCastException</tt>.
52    * Attempting to query the presence of an ineligible key or value may throw an
53    * exception, or it may simply return false; some implementations will exhibit
54    * the former behavior and some will exhibit the latter.  More generally,
55    * attempting an operation on an ineligible key or value whose completion
56    * would not result in the insertion of an ineligible element into the map may
57    * throw an exception or it may succeed, at the option of the implementation.
58    * Such exceptions are marked as "optional" in the specification for this
59    * interface.
60    *
61    * @author sleistner
62    * @see HashMap
63    * @see Collection
64    * @see Set
65    */
66   public interface Map {
67     
68     /**
69      * Associates the specified value with the specified key in this map
70      * (optional operation).  If the map previously contained a mapping for
71      * this key, the old value is replaced by the specified value.  (A map
72      * <tt>m</tt> is said to contain a mapping for a key <tt>k</tt> if and only
73      * if #containsKey(Object) m.containsKey(k) would return
74      * <tt>true</tt>.)) 
75      *
76      * @param key key with which the specified value is to be associated.
77      * @param value value to be associated with the specified key.
78      * @return previous value associated with specified key, or <tt>null</tt>
79      *         if there was no mapping for key.  A <tt>null</tt> return can
80      *         also indicate that the map previously associated <tt>null</tt>
81      *         with the specified key, if the implementation supports
82      *         <tt>null</tt> values.
83      * 
84      * @throws UnsupportedOperationException if the <tt>put</tt> operation is
85      *            not supported by this map.
86      *            
87      * @throws IllegalArgumentException if some aspect of this key or value
88      *            prevents it from being stored in this map.
89      * @throws NullPointerException if this map does not permit <tt>null</tt>
90      *            keys or values, and the specified key or value is
91      *            <tt>null</tt>.
92      */
93     function put(key:*, value:*):*;
94     
95     /**
96      * Returns the value to which this map maps the specified key.  Returns
97      * <tt>null</tt> if the map contains no mapping for this key.  A return
98      * value of <tt>null</tt> does not <i>necessarily</i> indicate that the
99      * map contains no mapping for the key; it's also possible that the map
100      * explicitly maps the key to <tt>null</tt>.  The <tt>containsKey</tt>
101      * operation may be used to distinguish these two cases.
102      *
103      * @param key key whose associated value is to be returned.
104      * @return the value to which this map maps the specified key, or
105      *         <tt>null</tt> if the map contains no mapping for this key.
106      * 
107      * @throws NullPointerException if the key is <tt>null</tt> and this map
108      *            does not permit <tt>null</tt> keys (optional).
109      * 
110      * @see #containsKey()
111      */
112     function get(key:*):*;
113     
114     /**
115      * Returns <tt>true</tt> if this map contains a mapping for the specified
116      * key.  More formally, returns <tt>true</tt> if and only if
117      * this map contains a mapping for a key <tt>k</tt> such that
118      * <tt>(key==null ? k==null : key.equals(k))</tt>.  (There can be
119      * at most one such mapping.)
120      *
121      * @param key key whose presence in this map is to be tested.
122      * @return <tt>true</tt> if this map contains a mapping for the specified
123      *         key.
124      * 
125      * @throws NullPointerException if the key is <tt>null</tt> and this map
126      *            does not permit <tt>null</tt> keys (optional).
127      */
128     function containsKey(key:*):Boolean;
129     
130     /**
131      * Returns <tt>true</tt> if this map maps one or more keys to the
132      * specified value.  More formally, returns <tt>true</tt> if and only if
133      * this map contains at least one mapping to a value <tt>v</tt> such that
134      * <tt>(value==null ? v==null : value.equals(v))</tt>.  This operation
135      * will probably require time linear in the map size for most
136      * implementations of the <tt>Map</tt> interface.
137      *
138      * @param value value whose presence in this map is to be tested.
139      * @return <tt>true</tt> if this map maps one or more keys to the
140      *         specified value.
141      *         
142      * @throws NullPointerException if the value is <tt>null</tt> and this map
143      *            does not permit <tt>null</tt> values (optional).
144      */
145     function containsValue(value:*):Boolean;
146     
147     /**
148      * Removes the mapping for this key from this map if it is present
149      * (optional operation).   More formally, if this map contains a mapping
150      * from key <tt>k</tt> to value <tt>v</tt> such that
151      * <code>(key==null ?  k==null : key.equals(k))</code>, that mapping
152      * is removed.  (The map can contain at most one such mapping.)
153      *
154      * <p>Returns the value to which the map previously associated the key, or
155      * <tt>null</tt> if the map contained no mapping for this key.  (A
156      * <tt>null</tt> return can also indicate that the map previously
157      * associated <tt>null</tt> with the specified key if the implementation
158      * supports <tt>null</tt> values.)  The map will not contain a mapping for
159      * the specified  key once the call returns.
160      *
161      * @param key key whose mapping is to be removed from the map.
162      * @return previous value associated with specified key, or <tt>null</tt>
163      *         if there was no mapping for key.
164      *
165      * @throws NullPointerException if the key is <tt>null</tt> and this map
166      *            does not permit <tt>null</tt> keys (optional).
167      * @throws UnsupportedOperationException if the <tt>remove</tt> method is
168      *         not supported by this map.
169      */
170     function remove(key:*):*;
171     
172     /**
173      * Removes all mappings from this map (optional operation).
174      *
175      * @throws UnsupportedOperationException clear is not supported by this
176      *            map.
177      */ 
178     function clear():void;
179     
180     /**
181      * Returns the number of key-value mappings in this map.  If the
182      * map contains more than <tt>Number.MAX_VALUE</tt> elements, returns
183      * <tt>Number.MAX_VALUE</tt>.
184      *
185      * @return the number of key-value mappings in this map.
186      */
187     function size():int;
188     
189     /**
190      * Returns a collection view of the values contained in this map.  The
191      * collection is backed by the map, so changes to the map are reflected in
192      * the collection, and vice-versa.  If the map is modified while an
193      * iteration over the collection is in progress (except through the
194      * iterator's own <tt>remove</tt> operation), the results of the
195      * iteration are undefined.  The collection supports element removal,
196      * which removes the corresponding mapping from the map, via the
197      * <tt>Iterator.remove</tt>, <tt>Collection.remove</tt>,
198      * <tt>removeAll</tt>, <tt>retainAll</tt> and <tt>clear</tt> operations.
199      * It does not support the add or <tt>addAll</tt> operations.
200      *
201      * @return a collection view of the values contained in this map.
202      */
203     function values():Collection;
204     
205     /**
206      * Returns a set view of the keys contained in this map.  The set is
207      * backed by the map, so changes to the map are reflected in the set, and
208      * vice-versa.  If the map is modified while an iteration over the set is
209      * in progress (except through the iterator's own <tt>remove</tt>
210      * operation), the results of the iteration are undefined.  The set
211      * supports element removal, which removes the corresponding mapping from
212      * the map, via the <tt>Iterator.remove</tt>, <tt>Set.remove</tt>,
213      * <tt>removeAll</tt> <tt>retainAll</tt>, and <tt>clear</tt> operations.
214      * It does not support the add or <tt>addAll</tt> operations.
215      *
216      * @return a set view of the keys contained in this map.
217      */
218     function keySet():Set;
219     
220     /**
221      * Returns a set view of the mappings contained in this map.  Each element
222      * in the returned set is a {@link Map.Entry}.  The set is backed by the
223      * map, so changes to the map are reflected in the set, and vice-versa.
224      * If the map is modified while an iteration over the set is in progress
225      * (except through the iterator's own <tt>remove</tt> operation, or through
226      * the <tt>setValue</tt> operation on a map entry returned by the iterator)
227      * the results of the iteration are undefined.  The set supports element
228      * removal, which removes the corresponding mapping from the map, via the
229      * <tt>Iterator.remove</tt>, <tt>Set.remove</tt>, <tt>removeAll</tt>,
230      * <tt>retainAll</tt> and <tt>clear</tt> operations.  It does not support
231      * the <tt>add</tt> or <tt>addAll</tt> operations.
232      *
233      * @return a set view of the mappings contained in this map.
234      */
235     function entrySet():Set;
236     
237     /**
238      * Returns <tt>true</tt> if this map contains no key-value mappings.
239      *
240      * @return <tt>true</tt> if this map contains no key-value mappings.
241      */
242     function isEmpty():Boolean;
243     
244     // bulk operations
245
246     /**
247      * Copies all of the mappings from the specified map to this map
248      * (optional operation).  The effect of this call is equivalent to that
249      * of calling {@link #put(Object,Object) put(k, v)} on this map once
250      * for each mapping from key <tt>k</tt> to value <tt>v</tt> in the 
251      * specified map.  The behavior of this operation is unspecified if the
252      * specified map is modified while the operation is in progress.
253      *
254      * @param map Mappings to be stored in this map.
255      * 
256      * @throws UnsupportedOperationException if the <tt>putAll</tt> method is
257      *            not supported by this map.
258      * 
259      * @throws IllegalArgumentException some aspect of a key or value in the
260      *            specified map prevents it from being stored in this map.
261      * @throws NullPointerException if the specified map is <tt>null</tt>, or if
262      *         this map does not permit <tt>null</tt> keys or values, and the
263      *         specified map contains <tt>null</tt> keys or values.
264      */
265     function putAll(map:Map):void;
266   }
267 }