1 |
|
/* |
2 |
|
* %W% %E% |
3 |
|
* |
4 |
< |
* Copyright 2004 Sun Microsystems, Inc. All rights reserved. |
4 |
> |
* Copyright 2005 Sun Microsystems, Inc. All rights reserved. |
5 |
|
* SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. |
6 |
|
*/ |
7 |
|
|
8 |
|
package java.util; |
9 |
+ |
import java.util.*; // for javadoc (till 6280605 is fixed) |
10 |
|
import java.util.Map.Entry; |
11 |
|
|
12 |
|
/** |
13 |
|
* This class provides a skeletal implementation of the <tt>Map</tt> |
14 |
< |
* interface, to minimize the effort required to implement this interface. <p> |
14 |
> |
* interface, to minimize the effort required to implement this interface. |
15 |
|
* |
16 |
< |
* To implement an unmodifiable map, the programmer needs only to extend this |
16 |
> |
* <p>To implement an unmodifiable map, the programmer needs only to extend this |
17 |
|
* class and provide an implementation for the <tt>entrySet</tt> method, which |
18 |
|
* returns a set-view of the map's mappings. Typically, the returned set |
19 |
|
* will, in turn, be implemented atop <tt>AbstractSet</tt>. This set should |
20 |
|
* not support the <tt>add</tt> or <tt>remove</tt> methods, and its iterator |
21 |
< |
* should not support the <tt>remove</tt> method.<p> |
21 |
> |
* should not support the <tt>remove</tt> method. |
22 |
|
* |
23 |
< |
* To implement a modifiable map, the programmer must additionally override |
23 |
> |
* <p>To implement a modifiable map, the programmer must additionally override |
24 |
|
* this class's <tt>put</tt> method (which otherwise throws an |
25 |
|
* <tt>UnsupportedOperationException</tt>), and the iterator returned by |
26 |
|
* <tt>entrySet().iterator()</tt> must additionally implement its |
27 |
< |
* <tt>remove</tt> method.<p> |
27 |
> |
* <tt>remove</tt> method. |
28 |
|
* |
29 |
< |
* The programmer should generally provide a void (no argument) and map |
29 |
> |
* <p>The programmer should generally provide a void (no argument) and map |
30 |
|
* constructor, as per the recommendation in the <tt>Map</tt> interface |
31 |
< |
* specification.<p> |
31 |
> |
* specification. |
32 |
|
* |
33 |
< |
* The documentation for each non-abstract methods in this class describes its |
33 |
> |
* <p>The documentation for each non-abstract methods in this class describes its |
34 |
|
* implementation in detail. Each of these methods may be overridden if the |
35 |
< |
* map being implemented admits a more efficient implementation.<p> |
35 |
> |
* map being implemented admits a more efficient implementation. |
36 |
|
* |
37 |
< |
* This class is a member of the |
37 |
> |
* <p>This class is a member of the |
38 |
|
* <a href="{@docRoot}/../guide/collections/index.html"> |
39 |
|
* Java Collections Framework</a>. |
40 |
|
* |
41 |
+ |
* @param <K> the type of keys maintained by this map |
42 |
+ |
* @param <V> the type of mapped values |
43 |
+ |
* |
44 |
|
* @author Josh Bloch |
45 |
|
* @author Neal Gafter |
46 |
|
* @version %I%, %G% |
60 |
|
// Query Operations |
61 |
|
|
62 |
|
/** |
63 |
< |
* Returns the number of key-value mappings in this map. If the map |
60 |
< |
* contains more than <tt>Integer.MAX_VALUE</tt> elements, returns |
61 |
< |
* <tt>Integer.MAX_VALUE</tt>.<p> |
62 |
< |
* |
63 |
< |
* This implementation returns <tt>entrySet().size()</tt>. |
63 |
> |
* {@inheritDoc} |
64 |
|
* |
65 |
< |
* @return the number of key-value mappings in this map. |
65 |
> |
* <p>This implementation returns <tt>entrySet().size()</tt>. |
66 |
|
*/ |
67 |
|
public int size() { |
68 |
|
return entrySet().size(); |
69 |
|
} |
70 |
|
|
71 |
|
/** |
72 |
< |
* Returns <tt>true</tt> if this map contains no key-value mappings. <p> |
73 |
< |
* |
74 |
< |
* This implementation returns <tt>size() == 0</tt>. |
72 |
> |
* {@inheritDoc} |
73 |
|
* |
74 |
< |
* @return <tt>true</tt> if this map contains no key-value mappings. |
74 |
> |
* <p>This implementation returns <tt>size() == 0</tt>. |
75 |
|
*/ |
76 |
|
public boolean isEmpty() { |
77 |
|
return size() == 0; |
78 |
|
} |
79 |
|
|
80 |
|
/** |
81 |
< |
* Returns <tt>true</tt> if this map maps one or more keys to this value. |
82 |
< |
* More formally, returns <tt>true</tt> if and only if this map contains |
83 |
< |
* at least one mapping to a value <tt>v</tt> such that <tt>(value==null ? |
84 |
< |
* v==null : value.equals(v))</tt>. This operation will probably require |
85 |
< |
* time linear in the map size for most implementations of map.<p> |
86 |
< |
* |
87 |
< |
* This implementation iterates over entrySet() searching for an entry |
88 |
< |
* with the specified value. If such an entry is found, <tt>true</tt> is |
89 |
< |
* returned. If the iteration terminates without finding such an entry, |
90 |
< |
* <tt>false</tt> is returned. Note that this implementation requires |
93 |
< |
* linear time in the size of the map. |
94 |
< |
* |
95 |
< |
* @param value value whose presence in this map is to be tested. |
96 |
< |
* |
97 |
< |
* @return <tt>true</tt> if this map maps one or more keys to this value. |
81 |
> |
* {@inheritDoc} |
82 |
> |
* |
83 |
> |
* <p>This implementation iterates over <tt>entrySet()</tt> searching |
84 |
> |
* for an entry with the specified value. If such an entry is found, |
85 |
> |
* <tt>true</tt> is returned. If the iteration terminates without |
86 |
> |
* finding such an entry, <tt>false</tt> is returned. Note that this |
87 |
> |
* implementation requires linear time in the size of the map. |
88 |
> |
* |
89 |
> |
* @throws ClassCastException {@inheritDoc} |
90 |
> |
* @throws NullPointerException {@inheritDoc} |
91 |
|
*/ |
92 |
|
public boolean containsValue(Object value) { |
93 |
|
Iterator<Entry<K,V>> i = entrySet().iterator(); |
108 |
|
} |
109 |
|
|
110 |
|
/** |
111 |
< |
* Returns <tt>true</tt> if this map contains a mapping for the specified |
119 |
< |
* key. <p> |
111 |
> |
* {@inheritDoc} |
112 |
|
* |
113 |
< |
* This implementation iterates over <tt>entrySet()</tt> searching for an |
114 |
< |
* entry with the specified key. If such an entry is found, <tt>true</tt> |
115 |
< |
* is returned. If the iteration terminates without finding such an |
116 |
< |
* entry, <tt>false</tt> is returned. Note that this implementation |
117 |
< |
* requires linear time in the size of the map; many implementations will |
118 |
< |
* override this method. |
119 |
< |
* |
120 |
< |
* @param key key whose presence in this map is to be tested. |
121 |
< |
* @return <tt>true</tt> if this map contains a mapping for the specified |
130 |
< |
* key. |
131 |
< |
* |
132 |
< |
* @throws NullPointerException if the key is <tt>null</tt> and this map |
133 |
< |
* does not permit <tt>null</tt> keys. |
113 |
> |
* <p>This implementation iterates over <tt>entrySet()</tt> searching |
114 |
> |
* for an entry with the specified key. If such an entry is found, |
115 |
> |
* <tt>true</tt> is returned. If the iteration terminates without |
116 |
> |
* finding such an entry, <tt>false</tt> is returned. Note that this |
117 |
> |
* implementation requires linear time in the size of the map; many |
118 |
> |
* implementations will override this method. |
119 |
> |
* |
120 |
> |
* @throws ClassCastException {@inheritDoc} |
121 |
> |
* @throws NullPointerException {@inheritDoc} |
122 |
|
*/ |
123 |
|
public boolean containsKey(Object key) { |
124 |
|
Iterator<Map.Entry<K,V>> i = entrySet().iterator(); |
139 |
|
} |
140 |
|
|
141 |
|
/** |
142 |
< |
* Returns the value to which this map maps the specified key. Returns |
143 |
< |
* <tt>null</tt> if the map contains no mapping for this key. A return |
144 |
< |
* value of <tt>null</tt> does not <i>necessarily</i> indicate that the |
145 |
< |
* map contains no mapping for the key; it's also possible that the map |
146 |
< |
* explicitly maps the key to <tt>null</tt>. The containsKey operation |
147 |
< |
* may be used to distinguish these two cases. <p> |
148 |
< |
* |
149 |
< |
* This implementation iterates over <tt>entrySet()</tt> searching for an |
150 |
< |
* entry with the specified key. If such an entry is found, the entry's |
151 |
< |
* value is returned. If the iteration terminates without finding such an |
152 |
< |
* entry, <tt>null</tt> is returned. Note that this implementation |
165 |
< |
* requires linear time in the size of the map; many implementations will |
166 |
< |
* override this method. |
167 |
< |
* |
168 |
< |
* @param key key whose associated value is to be returned. |
169 |
< |
* @return the value to which this map maps the specified key. |
170 |
< |
* |
171 |
< |
* @throws NullPointerException if the key is <tt>null</tt> and this map |
172 |
< |
* does not permit <tt>null</tt> keys. |
173 |
< |
* |
174 |
< |
* @see #containsKey(Object) |
142 |
> |
* {@inheritDoc} |
143 |
> |
* |
144 |
> |
* <p>This implementation iterates over <tt>entrySet()</tt> searching |
145 |
> |
* for an entry with the specified key. If such an entry is found, |
146 |
> |
* the entry's value is returned. If the iteration terminates without |
147 |
> |
* finding such an entry, <tt>null</tt> is returned. Note that this |
148 |
> |
* implementation requires linear time in the size of the map; many |
149 |
> |
* implementations will override this method. |
150 |
> |
* |
151 |
> |
* @throws ClassCastException {@inheritDoc} |
152 |
> |
* @throws NullPointerException {@inheritDoc} |
153 |
|
*/ |
154 |
|
public V get(Object key) { |
155 |
|
Iterator<Entry<K,V>> i = entrySet().iterator(); |
173 |
|
// Modification Operations |
174 |
|
|
175 |
|
/** |
176 |
< |
* Associates the specified value with the specified key in this map |
199 |
< |
* (optional operation). If the map previously contained a mapping for |
200 |
< |
* this key, the old value is replaced.<p> |
176 |
> |
* {@inheritDoc} |
177 |
|
* |
178 |
< |
* This implementation always throws an |
178 |
> |
* <p>This implementation always throws an |
179 |
|
* <tt>UnsupportedOperationException</tt>. |
180 |
|
* |
181 |
< |
* @param key key with which the specified value is to be associated. |
182 |
< |
* @param value value to be associated with the specified key. |
183 |
< |
* |
184 |
< |
* @return previous value associated with specified key, or <tt>null</tt> |
209 |
< |
* if there was no mapping for key. (A <tt>null</tt> return can |
210 |
< |
* also indicate that the map previously associated <tt>null</tt> |
211 |
< |
* with the specified key, if the implementation supports |
212 |
< |
* <tt>null</tt> values.) |
213 |
< |
* |
214 |
< |
* @throws UnsupportedOperationException if the <tt>put</tt> operation is |
215 |
< |
* not supported by this map. |
216 |
< |
* |
217 |
< |
* @throws ClassCastException if the class of the specified key or value |
218 |
< |
* prevents it from being stored in this map. |
219 |
< |
* |
220 |
< |
* @throws IllegalArgumentException if some aspect of this key or value * |
221 |
< |
* prevents it from being stored in this map. |
222 |
< |
* |
223 |
< |
* @throws NullPointerException if this map does not permit <tt>null</tt> |
224 |
< |
* keys or values, and the specified key or value is |
225 |
< |
* <tt>null</tt>. |
181 |
> |
* @throws UnsupportedOperationException {@inheritDoc} |
182 |
> |
* @throws ClassCastException {@inheritDoc} |
183 |
> |
* @throws NullPointerException {@inheritDoc} |
184 |
> |
* @throws IllegalArgumentException {@inheritDoc} |
185 |
|
*/ |
186 |
|
public V put(K key, V value) { |
187 |
|
throw new UnsupportedOperationException(); |
188 |
|
} |
189 |
|
|
190 |
|
/** |
191 |
< |
* Removes the mapping for this key from this map if present (optional |
233 |
< |
* operation). <p> |
191 |
> |
* {@inheritDoc} |
192 |
|
* |
193 |
< |
* This implementation iterates over <tt>entrySet()</tt> searching for an |
193 |
> |
* <p>This implementation iterates over <tt>entrySet()</tt> searching for an |
194 |
|
* entry with the specified key. If such an entry is found, its value is |
195 |
|
* obtained with its <tt>getValue</tt> operation, the entry is removed |
196 |
< |
* from the Collection (and the backing map) with the iterator's |
196 |
> |
* from the collection (and the backing map) with the iterator's |
197 |
|
* <tt>remove</tt> operation, and the saved value is returned. If the |
198 |
|
* iteration terminates without finding such an entry, <tt>null</tt> is |
199 |
|
* returned. Note that this implementation requires linear time in the |
200 |
< |
* size of the map; many implementations will override this method.<p> |
200 |
> |
* size of the map; many implementations will override this method. |
201 |
> |
* |
202 |
> |
* <p>Note that this implementation throws an |
203 |
> |
* <tt>UnsupportedOperationException</tt> if the <tt>entrySet</tt> |
204 |
> |
* iterator does not support the <tt>remove</tt> method and this map |
205 |
> |
* contains a mapping for the specified key. |
206 |
|
* |
207 |
< |
* Note that this implementation throws an |
208 |
< |
* <tt>UnsupportedOperationException</tt> if the <tt>entrySet</tt> iterator |
209 |
< |
* does not support the <tt>remove</tt> method and this map contains a |
247 |
< |
* mapping for the specified key. |
248 |
< |
* |
249 |
< |
* @param key key whose mapping is to be removed from the map. |
250 |
< |
* @return previous value associated with specified key, or <tt>null</tt> |
251 |
< |
* if there was no entry for key. (A <tt>null</tt> return can |
252 |
< |
* also indicate that the map previously associated <tt>null</tt> |
253 |
< |
* with the specified key, if the implementation supports |
254 |
< |
* <tt>null</tt> values.) |
255 |
< |
* @throws UnsupportedOperationException if the <tt>remove</tt> operation |
256 |
< |
* is not supported by this map. |
207 |
> |
* @throws UnsupportedOperationException {@inheritDoc} |
208 |
> |
* @throws ClassCastException {@inheritDoc} |
209 |
> |
* @throws NullPointerException {@inheritDoc} |
210 |
|
*/ |
211 |
|
public V remove(Object key) { |
212 |
|
Iterator<Entry<K,V>> i = entrySet().iterator(); |
237 |
|
// Bulk Operations |
238 |
|
|
239 |
|
/** |
240 |
< |
* Copies all of the mappings from the specified map to this map |
288 |
< |
* (optional operation). These mappings will replace any mappings that |
289 |
< |
* this map had for any of the keys currently in the specified map.<p> |
240 |
> |
* {@inheritDoc} |
241 |
|
* |
242 |
< |
* This implementation iterates over the specified map's |
242 |
> |
* <p>This implementation iterates over the specified map's |
243 |
|
* <tt>entrySet()</tt> collection, and calls this map's <tt>put</tt> |
244 |
< |
* operation once for each entry returned by the iteration.<p> |
244 |
> |
* operation once for each entry returned by the iteration. |
245 |
|
* |
246 |
< |
* Note that this implementation throws an |
246 |
> |
* <p>Note that this implementation throws an |
247 |
|
* <tt>UnsupportedOperationException</tt> if this map does not support |
248 |
|
* the <tt>put</tt> operation and the specified map is nonempty. |
249 |
|
* |
250 |
< |
* @param t mappings to be stored in this map. |
251 |
< |
* |
252 |
< |
* @throws UnsupportedOperationException if the <tt>putAll</tt> operation |
253 |
< |
* is not supported by this map. |
254 |
< |
* |
255 |
< |
* @throws ClassCastException if the class of a key or value in the |
256 |
< |
* specified map prevents it from being stored in this map. |
257 |
< |
* |
307 |
< |
* @throws IllegalArgumentException if some aspect of a key or value in |
308 |
< |
* the specified map prevents it from being stored in this map. |
309 |
< |
* @throws NullPointerException if the specified map is <tt>null</tt>, or if |
310 |
< |
* this map does not permit <tt>null</tt> keys or values, and the |
311 |
< |
* specified map contains <tt>null</tt> keys or values. |
312 |
< |
*/ |
313 |
< |
public void putAll(Map<? extends K, ? extends V> t) { |
314 |
< |
Iterator<? extends Entry<? extends K, ? extends V>> i = t.entrySet().iterator(); |
315 |
< |
while (i.hasNext()) { |
316 |
< |
Entry<? extends K, ? extends V> e = i.next(); |
317 |
< |
put(e.getKey(), e.getValue()); |
318 |
< |
} |
250 |
> |
* @throws UnsupportedOperationException {@inheritDoc} |
251 |
> |
* @throws ClassCastException {@inheritDoc} |
252 |
> |
* @throws NullPointerException {@inheritDoc} |
253 |
> |
* @throws IllegalArgumentException {@inheritDoc} |
254 |
> |
*/ |
255 |
> |
public void putAll(Map<? extends K, ? extends V> m) { |
256 |
> |
for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) |
257 |
> |
put(e.getKey(), e.getValue()); |
258 |
|
} |
259 |
|
|
260 |
|
/** |
261 |
< |
* Removes all mappings from this map (optional operation). <p> |
261 |
> |
* {@inheritDoc} |
262 |
|
* |
263 |
< |
* This implementation calls <tt>entrySet().clear()</tt>. |
263 |
> |
* <p>This implementation calls <tt>entrySet().clear()</tt>. |
264 |
|
* |
265 |
< |
* Note that this implementation throws an |
265 |
> |
* <p>Note that this implementation throws an |
266 |
|
* <tt>UnsupportedOperationException</tt> if the <tt>entrySet</tt> |
267 |
|
* does not support the <tt>clear</tt> operation. |
268 |
|
* |
269 |
< |
* @throws UnsupportedOperationException clear is not supported |
331 |
< |
* by this map. |
269 |
> |
* @throws UnsupportedOperationException {@inheritDoc} |
270 |
|
*/ |
271 |
|
public void clear() { |
272 |
|
entrySet().clear(); |
284 |
|
transient volatile Collection<V> values = null; |
285 |
|
|
286 |
|
/** |
287 |
< |
* Returns a Set view of the keys contained in this map. The Set is |
288 |
< |
* backed by the map, so changes to the map are reflected in the Set, |
289 |
< |
* and vice-versa. (If the map is modified while an iteration over |
290 |
< |
* the Set is in progress, the results of the iteration are undefined.) |
291 |
< |
* The Set supports element removal, which removes the corresponding entry |
292 |
< |
* from the map, via the Iterator.remove, Set.remove, removeAll |
293 |
< |
* retainAll, and clear operations. It does not support the add or |
294 |
< |
* addAll operations.<p> |
357 |
< |
* |
358 |
< |
* This implementation returns a Set that subclasses |
359 |
< |
* AbstractSet. The subclass's iterator method returns a "wrapper |
360 |
< |
* object" over this map's entrySet() iterator. The size method delegates |
361 |
< |
* to this map's size method and the contains method delegates to this |
362 |
< |
* map's containsKey method.<p> |
287 |
> |
* {@inheritDoc} |
288 |
> |
* |
289 |
> |
* <p>This implementation returns a set that subclasses {@link AbstractSet}. |
290 |
> |
* The subclass's iterator method returns a "wrapper object" over this |
291 |
> |
* map's <tt>entrySet()</tt> iterator. The <tt>size</tt> method |
292 |
> |
* delegates to this map's <tt>size</tt> method and the |
293 |
> |
* <tt>contains</tt> method delegates to this map's |
294 |
> |
* <tt>containsKey</tt> method. |
295 |
|
* |
296 |
< |
* The Set is created the first time this method is called, |
296 |
> |
* <p>The set is created the first time this method is called, |
297 |
|
* and returned in response to all subsequent calls. No synchronization |
298 |
|
* is performed, so there is a slight chance that multiple calls to this |
299 |
< |
* method will not all return the same Set. |
368 |
< |
* |
369 |
< |
* @return a Set view of the keys contained in this map. |
299 |
> |
* method will not all return the same set. |
300 |
|
*/ |
301 |
|
public Set<K> keySet() { |
302 |
|
if (keySet == null) { |
332 |
|
} |
333 |
|
|
334 |
|
/** |
335 |
< |
* Returns a collection view of the values contained in this map. The |
336 |
< |
* collection is backed by the map, so changes to the map are reflected in |
337 |
< |
* the collection, and vice-versa. (If the map is modified while an |
338 |
< |
* iteration over the collection is in progress, the results of the |
339 |
< |
* iteration are undefined.) The collection supports element removal, |
340 |
< |
* which removes the corresponding entry from the map, via the |
341 |
< |
* <tt>Iterator.remove</tt>, <tt>Collection.remove</tt>, |
342 |
< |
* <tt>removeAll</tt>, <tt>retainAll</tt> and <tt>clear</tt> operations. |
413 |
< |
* It does not support the <tt>add</tt> or <tt>addAll</tt> operations.<p> |
414 |
< |
* |
415 |
< |
* This implementation returns a collection that subclasses abstract |
416 |
< |
* collection. The subclass's iterator method returns a "wrapper object" |
417 |
< |
* over this map's <tt>entrySet()</tt> iterator. The size method |
418 |
< |
* delegates to this map's size method and the contains method delegates |
419 |
< |
* to this map's containsValue method.<p> |
335 |
> |
* {@inheritDoc} |
336 |
> |
* |
337 |
> |
* <p>This implementation returns a collection that subclasses {@link |
338 |
> |
* AbstractCollection}. The subclass's iterator method returns a |
339 |
> |
* "wrapper object" over this map's <tt>entrySet()</tt> iterator. |
340 |
> |
* The <tt>size</tt> method delegates to this map's <tt>size</tt> |
341 |
> |
* method and the <tt>contains</tt> method delegates to this map's |
342 |
> |
* <tt>containsValue</tt> method. |
343 |
|
* |
344 |
< |
* The collection is created the first time this method is called, and |
344 |
> |
* <p>The collection is created the first time this method is called, and |
345 |
|
* returned in response to all subsequent calls. No synchronization is |
346 |
|
* performed, so there is a slight chance that multiple calls to this |
347 |
< |
* method will not all return the same Collection. |
425 |
< |
* |
426 |
< |
* @return a collection view of the values contained in this map. |
347 |
> |
* method will not all return the same collection. |
348 |
|
*/ |
349 |
|
public Collection<V> values() { |
350 |
|
if (values == null) { |
379 |
|
return values; |
380 |
|
} |
381 |
|
|
461 |
– |
/** |
462 |
– |
* Returns a set view of the mappings contained in this map. Each element |
463 |
– |
* in this set is a Map.Entry. The set is backed by the map, so changes |
464 |
– |
* to the map are reflected in the set, and vice-versa. (If the map is |
465 |
– |
* modified while an iteration over the set is in progress, the results of |
466 |
– |
* the iteration are undefined.) The set supports element removal, which |
467 |
– |
* removes the corresponding entry from the map, via the |
468 |
– |
* <tt>Iterator.remove</tt>, <tt>Set.remove</tt>, <tt>removeAll</tt>, |
469 |
– |
* <tt>retainAll</tt> and <tt>clear</tt> operations. It does not support |
470 |
– |
* the <tt>add</tt> or <tt>addAll</tt> operations. |
471 |
– |
* |
472 |
– |
* @return a set view of the mappings contained in this map. |
473 |
– |
*/ |
382 |
|
public abstract Set<Entry<K,V>> entrySet(); |
383 |
|
|
384 |
|
|
387 |
|
/** |
388 |
|
* Compares the specified object with this map for equality. Returns |
389 |
|
* <tt>true</tt> if the given object is also a map and the two maps |
390 |
< |
* represent the same mappings. More formally, two maps <tt>t1</tt> and |
391 |
< |
* <tt>t2</tt> represent the same mappings if |
392 |
< |
* <tt>t1.keySet().equals(t2.keySet())</tt> and for every key <tt>k</tt> |
485 |
< |
* in <tt>t1.keySet()</tt>, <tt> (t1.get(k)==null ? t2.get(k)==null : |
486 |
< |
* t1.get(k).equals(t2.get(k))) </tt>. This ensures that the |
390 |
> |
* represent the same mappings. More formally, two maps <tt>m1</tt> and |
391 |
> |
* <tt>m2</tt> represent the same mappings if |
392 |
> |
* <tt>m1.entrySet().equals(m2.entrySet())</tt>. This ensures that the |
393 |
|
* <tt>equals</tt> method works properly across different implementations |
394 |
< |
* of the map interface.<p> |
394 |
> |
* of the <tt>Map</tt> interface. |
395 |
|
* |
396 |
< |
* This implementation first checks if the specified object is this map; |
396 |
> |
* <p>This implementation first checks if the specified object is this map; |
397 |
|
* if so it returns <tt>true</tt>. Then, it checks if the specified |
398 |
< |
* object is a map whose size is identical to the size of this set; if |
398 |
> |
* object is a map whose size is identical to the size of this map; if |
399 |
|
* not, it returns <tt>false</tt>. If so, it iterates over this map's |
400 |
|
* <tt>entrySet</tt> collection, and checks that the specified map |
401 |
|
* contains each mapping that this map contains. If the specified map |
402 |
|
* fails to contain such a mapping, <tt>false</tt> is returned. If the |
403 |
|
* iteration completes, <tt>true</tt> is returned. |
404 |
|
* |
405 |
< |
* @param o object to be compared for equality with this map. |
406 |
< |
* @return <tt>true</tt> if the specified object is equal to this map. |
405 |
> |
* @param o object to be compared for equality with this map |
406 |
> |
* @return <tt>true</tt> if the specified object is equal to this map |
407 |
|
*/ |
408 |
|
public boolean equals(Object o) { |
409 |
|
if (o == this) |
411 |
|
|
412 |
|
if (!(o instanceof Map)) |
413 |
|
return false; |
414 |
< |
Map<K,V> t = (Map<K,V>) o; |
415 |
< |
if (t.size() != size()) |
414 |
> |
Map<K,V> m = (Map<K,V>) o; |
415 |
> |
if (m.size() != size()) |
416 |
|
return false; |
417 |
|
|
418 |
|
try { |
422 |
|
K key = e.getKey(); |
423 |
|
V value = e.getValue(); |
424 |
|
if (value == null) { |
425 |
< |
if (!(t.get(key)==null && t.containsKey(key))) |
425 |
> |
if (!(m.get(key)==null && m.containsKey(key))) |
426 |
|
return false; |
427 |
|
} else { |
428 |
< |
if (!value.equals(t.get(key))) |
428 |
> |
if (!value.equals(m.get(key))) |
429 |
|
return false; |
430 |
|
} |
431 |
|
} |
432 |
< |
} catch(ClassCastException unused) { |
432 |
> |
} catch (ClassCastException unused) { |
433 |
|
return false; |
434 |
< |
} catch(NullPointerException unused) { |
434 |
> |
} catch (NullPointerException unused) { |
435 |
|
return false; |
436 |
|
} |
437 |
|
|
441 |
|
/** |
442 |
|
* Returns the hash code value for this map. The hash code of a map is |
443 |
|
* defined to be the sum of the hash codes of each entry in the map's |
444 |
< |
* <tt>entrySet()</tt> view. This ensures that <tt>t1.equals(t2)</tt> |
445 |
< |
* implies that <tt>t1.hashCode()==t2.hashCode()</tt> for any two maps |
446 |
< |
* <tt>t1</tt> and <tt>t2</tt>, as required by the general contract of |
447 |
< |
* Object.hashCode.<p> |
448 |
< |
* |
449 |
< |
* This implementation iterates over <tt>entrySet()</tt>, calling |
450 |
< |
* <tt>hashCode</tt> on each element (entry) in the Collection, and adding |
451 |
< |
* up the results. |
444 |
> |
* <tt>entrySet()</tt> view. This ensures that <tt>m1.equals(m2)</tt> |
445 |
> |
* implies that <tt>m1.hashCode()==m2.hashCode()</tt> for any two maps |
446 |
> |
* <tt>m1</tt> and <tt>m2</tt>, as required by the general contract of |
447 |
> |
* {@link Object#hashCode}. |
448 |
> |
* |
449 |
> |
* <p>This implementation iterates over <tt>entrySet()</tt>, calling |
450 |
> |
* {@link Map.Entry#hashCode hashCode()} on each element (entry) in the |
451 |
> |
* set, and adding up the results. |
452 |
|
* |
453 |
< |
* @return the hash code value for this map. |
453 |
> |
* @return the hash code value for this map |
454 |
|
* @see Map.Entry#hashCode() |
549 |
– |
* @see Object#hashCode() |
455 |
|
* @see Object#equals(Object) |
456 |
|
* @see Set#equals(Object) |
457 |
|
*/ |
471 |
|
* <tt>", "</tt> (comma and space). Each key-value mapping is rendered as |
472 |
|
* the key followed by an equals sign (<tt>"="</tt>) followed by the |
473 |
|
* associated value. Keys and values are converted to strings as by |
474 |
< |
* <tt>String.valueOf(Object)</tt>.<p> |
474 |
> |
* {@link String#valueOf(Object)}. |
475 |
|
* |
476 |
< |
* This implementation creates an empty string buffer, appends a left |
572 |
< |
* brace, and iterates over the map's <tt>entrySet</tt> view, appending |
573 |
< |
* the string representation of each <tt>map.entry</tt> in turn. After |
574 |
< |
* appending each entry except the last, the string <tt>", "</tt> is |
575 |
< |
* appended. Finally a right brace is appended. A string is obtained |
576 |
< |
* from the stringbuffer, and returned. |
577 |
< |
* |
578 |
< |
* @return a String representation of this map. |
476 |
> |
* @return a string representation of this map |
477 |
|
*/ |
478 |
|
public String toString() { |
581 |
– |
StringBuffer buf = new StringBuffer(); |
582 |
– |
buf.append("{"); |
583 |
– |
|
479 |
|
Iterator<Entry<K,V>> i = entrySet().iterator(); |
480 |
< |
boolean hasNext = i.hasNext(); |
481 |
< |
while (hasNext) { |
480 |
> |
if (! i.hasNext()) |
481 |
> |
return "{}"; |
482 |
> |
|
483 |
> |
StringBuilder sb = new StringBuilder(); |
484 |
> |
sb.append('{'); |
485 |
> |
for (;;) { |
486 |
|
Entry<K,V> e = i.next(); |
487 |
|
K key = e.getKey(); |
488 |
< |
V value = e.getValue(); |
489 |
< |
if (key == this) |
490 |
< |
buf.append("(this Map)"); |
491 |
< |
else |
492 |
< |
buf.append(key); |
493 |
< |
buf.append("="); |
494 |
< |
if (value == this) |
495 |
< |
buf.append("(this Map)"); |
597 |
< |
else |
598 |
< |
buf.append(value); |
599 |
< |
hasNext = i.hasNext(); |
600 |
< |
if (hasNext) |
601 |
< |
buf.append(", "); |
602 |
< |
} |
603 |
< |
|
604 |
< |
buf.append("}"); |
605 |
< |
return buf.toString(); |
488 |
> |
V value = e.getValue(); |
489 |
> |
sb.append(key == this ? "(this Map)" : key); |
490 |
> |
sb.append('='); |
491 |
> |
sb.append(value == this ? "(this Map)" : value); |
492 |
> |
if (! i.hasNext()) |
493 |
> |
return sb.append('}').toString(); |
494 |
> |
sb.append(", "); |
495 |
> |
} |
496 |
|
} |
497 |
< |
|
497 |
> |
|
498 |
|
/** |
499 |
|
* Returns a shallow copy of this <tt>AbstractMap</tt> instance: the keys |
500 |
|
* and values themselves are not cloned. |
501 |
|
* |
502 |
< |
* @return a shallow copy of this map. |
502 |
> |
* @return a shallow copy of this map |
503 |
|
*/ |
504 |
|
protected Object clone() throws CloneNotSupportedException { |
505 |
|
AbstractMap<K,V> result = (AbstractMap<K,V>)super.clone(); |
513 |
|
* Test for equality, checking for nulls. |
514 |
|
*/ |
515 |
|
private static boolean eq(Object o1, Object o2) { |
516 |
< |
return (o1 == null ? o2 == null : o1.equals(o2)); |
516 |
> |
return o1 == null ? o2 == null : o1.equals(o2); |
517 |
|
} |
518 |
|
|
519 |
|
// Implementation Note: SimpleEntry and SimpleImmutableEntry |
530 |
|
* facilitates the process of building custom map |
531 |
|
* implementations. For example, it may be convenient to return |
532 |
|
* arrays of <tt>SimpleEntry</tt> instances in method |
533 |
< |
* <tt>Map.entrySet().toArray</tt> |
533 |
> |
* <tt>Map.entrySet().toArray</tt>. |
534 |
> |
* |
535 |
> |
* @since 1.6 |
536 |
|
*/ |
537 |
< |
public static class SimpleEntry<K,V> implements Entry<K,V> { |
537 |
> |
public static class SimpleEntry<K,V> |
538 |
> |
implements Entry<K,V>, java.io.Serializable |
539 |
> |
{ |
540 |
> |
private static final long serialVersionUID = -8499721149061103585L; |
541 |
> |
|
542 |
|
private final K key; |
543 |
|
private V value; |
544 |
|
|
558 |
|
* Creates an entry representing the same mapping as the |
559 |
|
* specified entry. |
560 |
|
* |
561 |
< |
* @param entry the entry to copy. |
561 |
> |
* @param entry the entry to copy |
562 |
|
*/ |
563 |
< |
public SimpleEntry(Entry<K,V> entry) { |
563 |
> |
public SimpleEntry(Entry<? extends K, ? extends V> entry) { |
564 |
|
this.key = entry.getKey(); |
565 |
|
this.value = entry.getValue(); |
566 |
|
} |
568 |
|
/** |
569 |
|
* Returns the key corresponding to this entry. |
570 |
|
* |
571 |
< |
* @return the key corresponding to this entry. |
571 |
> |
* @return the key corresponding to this entry |
572 |
|
*/ |
573 |
|
public K getKey() { |
574 |
|
return key; |
577 |
|
/** |
578 |
|
* Returns the value corresponding to this entry. |
579 |
|
* |
580 |
< |
* @return the value corresponding to this entry. |
580 |
> |
* @return the value corresponding to this entry |
581 |
|
*/ |
582 |
|
public V getValue() { |
583 |
|
return value; |
587 |
|
* Replaces the value corresponding to this entry with the specified |
588 |
|
* value. |
589 |
|
* |
590 |
< |
* @param value new value to be stored in this entry. |
591 |
< |
* @return old value corresponding to the entry. |
590 |
> |
* @param value new value to be stored in this entry |
591 |
> |
* @return the old value corresponding to the entry |
592 |
|
*/ |
593 |
|
public V setValue(V value) { |
594 |
|
V oldValue = this.value; |
596 |
|
return oldValue; |
597 |
|
} |
598 |
|
|
599 |
+ |
/** |
600 |
+ |
* Compares the specified object with this entry for equality. |
601 |
+ |
* Returns {@code true} if the given object is also a map entry and |
602 |
+ |
* the two entries represent the same mapping. More formally, two |
603 |
+ |
* entries {@code e1} and {@code e2} represent the same mapping |
604 |
+ |
* if<pre> |
605 |
+ |
* (e1.getKey()==null ? |
606 |
+ |
* e2.getKey()==null : |
607 |
+ |
* e1.getKey().equals(e2.getKey())) |
608 |
+ |
* && |
609 |
+ |
* (e1.getValue()==null ? |
610 |
+ |
* e2.getValue()==null : |
611 |
+ |
* e1.getValue().equals(e2.getValue()))</pre> |
612 |
+ |
* This ensures that the {@code equals} method works properly across |
613 |
+ |
* different implementations of the {@code Map.Entry} interface. |
614 |
+ |
* |
615 |
+ |
* @param o object to be compared for equality with this map entry |
616 |
+ |
* @return {@code true} if the specified object is equal to this map |
617 |
+ |
* entry |
618 |
+ |
* @see #hashCode |
619 |
+ |
*/ |
620 |
|
public boolean equals(Object o) { |
621 |
|
if (!(o instanceof Map.Entry)) |
622 |
|
return false; |
624 |
|
return eq(key, e.getKey()) && eq(value, e.getValue()); |
625 |
|
} |
626 |
|
|
627 |
+ |
/** |
628 |
+ |
* Returns the hash code value for this map entry. The hash code |
629 |
+ |
* of a map entry {@code e} is defined to be: <pre> |
630 |
+ |
* (e.getKey()==null ? 0 : e.getKey().hashCode()) ^ |
631 |
+ |
* (e.getValue()==null ? 0 : e.getValue().hashCode())</pre> |
632 |
+ |
* This ensures that {@code e1.equals(e2)} implies that |
633 |
+ |
* {@code e1.hashCode()==e2.hashCode()} for any two Entries |
634 |
+ |
* {@code e1} and {@code e2}, as required by the general |
635 |
+ |
* contract of {@link Object#hashCode}. |
636 |
+ |
* |
637 |
+ |
* @return the hash code value for this map entry |
638 |
+ |
* @see #equals |
639 |
+ |
*/ |
640 |
|
public int hashCode() { |
641 |
< |
return ((key == null) ? 0 : key.hashCode()) ^ |
642 |
< |
((value == null) ? 0 : value.hashCode()); |
641 |
> |
return (key == null ? 0 : key.hashCode()) ^ |
642 |
> |
(value == null ? 0 : value.hashCode()); |
643 |
|
} |
644 |
|
|
645 |
|
/** |
648 |
|
* entry's key followed by the equals character ("<tt>=</tt>") |
649 |
|
* followed by the string representation of this entry's value. |
650 |
|
* |
651 |
< |
* @return a String representation of this map entry. |
651 |
> |
* @return a String representation of this map entry |
652 |
|
*/ |
653 |
|
public String toString() { |
654 |
|
return key + "=" + value; |
657 |
|
} |
658 |
|
|
659 |
|
/** |
660 |
< |
* An Entry maintaining an immutable key and value, This class |
660 |
> |
* An Entry maintaining an immutable key and value. This class |
661 |
|
* does not support method <tt>setValue</tt>. This class may be |
662 |
|
* convenient in methods that return thread-safe snapshots of |
663 |
|
* key-value mappings. |
664 |
+ |
* |
665 |
+ |
* @since 1.6 |
666 |
|
*/ |
667 |
< |
public static class SimpleImmutableEntry<K,V> implements Entry<K,V> { |
667 |
> |
public static class SimpleImmutableEntry<K,V> |
668 |
> |
implements Entry<K,V>, java.io.Serializable |
669 |
> |
{ |
670 |
> |
private static final long serialVersionUID = 7138329143949025153L; |
671 |
> |
|
672 |
|
private final K key; |
673 |
|
private final V value; |
674 |
|
|
688 |
|
* Creates an entry representing the same mapping as the |
689 |
|
* specified entry. |
690 |
|
* |
691 |
< |
* @param entry the entry to copy. |
691 |
> |
* @param entry the entry to copy |
692 |
|
*/ |
693 |
< |
public SimpleImmutableEntry(Entry<K,V> entry) { |
693 |
> |
public SimpleImmutableEntry(Entry<? extends K, ? extends V> entry) { |
694 |
|
this.key = entry.getKey(); |
695 |
|
this.value = entry.getValue(); |
696 |
|
} |
698 |
|
/** |
699 |
|
* Returns the key corresponding to this entry. |
700 |
|
* |
701 |
< |
* @return the key corresponding to this entry. |
701 |
> |
* @return the key corresponding to this entry |
702 |
|
*/ |
703 |
|
public K getKey() { |
704 |
|
return key; |
707 |
|
/** |
708 |
|
* Returns the value corresponding to this entry. |
709 |
|
* |
710 |
< |
* @return the value corresponding to this entry. |
710 |
> |
* @return the value corresponding to this entry |
711 |
|
*/ |
712 |
|
public V getValue() { |
713 |
|
return value; |
719 |
|
* <tt>UnsupportedOperationException</tt>, as this class implements |
720 |
|
* an <i>immutable</i> map entry. |
721 |
|
* |
722 |
< |
* @param value new value to be stored in this entry. |
722 |
> |
* @param value new value to be stored in this entry |
723 |
|
* @return (Does not return) |
724 |
|
* @throws UnsupportedOperationException always |
725 |
|
*/ |
727 |
|
throw new UnsupportedOperationException(); |
728 |
|
} |
729 |
|
|
730 |
+ |
/** |
731 |
+ |
* Compares the specified object with this entry for equality. |
732 |
+ |
* Returns {@code true} if the given object is also a map entry and |
733 |
+ |
* the two entries represent the same mapping. More formally, two |
734 |
+ |
* entries {@code e1} and {@code e2} represent the same mapping |
735 |
+ |
* if<pre> |
736 |
+ |
* (e1.getKey()==null ? |
737 |
+ |
* e2.getKey()==null : |
738 |
+ |
* e1.getKey().equals(e2.getKey())) |
739 |
+ |
* && |
740 |
+ |
* (e1.getValue()==null ? |
741 |
+ |
* e2.getValue()==null : |
742 |
+ |
* e1.getValue().equals(e2.getValue()))</pre> |
743 |
+ |
* This ensures that the {@code equals} method works properly across |
744 |
+ |
* different implementations of the {@code Map.Entry} interface. |
745 |
+ |
* |
746 |
+ |
* @param o object to be compared for equality with this map entry |
747 |
+ |
* @return {@code true} if the specified object is equal to this map |
748 |
+ |
* entry |
749 |
+ |
* @see #hashCode |
750 |
+ |
*/ |
751 |
|
public boolean equals(Object o) { |
752 |
|
if (!(o instanceof Map.Entry)) |
753 |
|
return false; |
755 |
|
return eq(key, e.getKey()) && eq(value, e.getValue()); |
756 |
|
} |
757 |
|
|
758 |
+ |
/** |
759 |
+ |
* Returns the hash code value for this map entry. The hash code |
760 |
+ |
* of a map entry {@code e} is defined to be: <pre> |
761 |
+ |
* (e.getKey()==null ? 0 : e.getKey().hashCode()) ^ |
762 |
+ |
* (e.getValue()==null ? 0 : e.getValue().hashCode())</pre> |
763 |
+ |
* This ensures that {@code e1.equals(e2)} implies that |
764 |
+ |
* {@code e1.hashCode()==e2.hashCode()} for any two Entries |
765 |
+ |
* {@code e1} and {@code e2}, as required by the general |
766 |
+ |
* contract of {@link Object#hashCode}. |
767 |
+ |
* |
768 |
+ |
* @return the hash code value for this map entry |
769 |
+ |
* @see #equals |
770 |
+ |
*/ |
771 |
|
public int hashCode() { |
772 |
< |
return ((key == null) ? 0 : key.hashCode()) ^ |
773 |
< |
((value == null) ? 0 : value.hashCode()); |
772 |
> |
return (key == null ? 0 : key.hashCode()) ^ |
773 |
> |
(value == null ? 0 : value.hashCode()); |
774 |
|
} |
775 |
|
|
776 |
|
/** |
779 |
|
* entry's key followed by the equals character ("<tt>=</tt>") |
780 |
|
* followed by the string representation of this entry's value. |
781 |
|
* |
782 |
< |
* @return a String representation of this map entry. |
782 |
> |
* @return a String representation of this map entry |
783 |
|
*/ |
784 |
|
public String toString() { |
785 |
|
return key + "=" + value; |