sample/java.util.HashMap.txt

   1 *java.util.HashMap* *HashMap* Hash table based implementation of the Map interfa
   2
   3 public class HashMap<K,V>
   4   extends    |java.util.AbstractMap|
   5   implements |java.util.Map|
   6              |java.lang.Cloneable|
   7              |java.io.Serializable|
   8
   9 |java.util.HashMap_Description|
  10 |java.util.HashMap_Fields|
  11 |java.util.HashMap_Constructors|
  12 |java.util.HashMap_Methods|
  13
  14 ================================================================================
  15
  16 *java.util.HashMap_Constructors*
  17 |java.util.HashMap()|Constructs an empty HashMap with the default initial capac
  18 |java.util.HashMap(int)|Constructs an empty HashMap with the specified initial
  19 |java.util.HashMap(int,float)|Constructs an empty HashMap with the specified in
  20 |java.util.HashMap(Map<?extendsK,?extendsV>)|Constructs a new HashMap with the
  21
  22 *java.util.HashMap_Methods*
  23 |java.util.HashMap.clear()|Removes all of the mappings from this map.
  24 |java.util.HashMap.clone()|Returns a shallow copy of this HashMap instance: the
  25 |java.util.HashMap.containsKey(Object)|Returns true if this map contains a mapp
  26 |java.util.HashMap.containsValue(Object)|Returns true if this map maps one or m
  27 |java.util.HashMap.entrySet()|Returns aSetview of the mappings contained in thi
  28 |java.util.HashMap.get(Object)|Returns the value to which the specified key is
  29 |java.util.HashMap.isEmpty()|Returns true if this map contains no key-value map
  30 |java.util.HashMap.keySet()|Returns aSetview of the keys contained in this map.
  31 |java.util.HashMap.put(K,V)|Associates the specified value with the specified k
  32 |java.util.HashMap.putAll(Map<?extendsK,?extendsV>)|Copies all of the mappings
  33 |java.util.HashMap.remove(Object)|Removes the mapping for the specified key fro
  34 |java.util.HashMap.size()|Returns the number of key-value mappings in this map.
  35 |java.util.HashMap.values()|Returns aCollectionview of the values contained in
  36
  37 *java.util.HashMap_Description*
  38
  39 Hash table based implementation of the Map interface. This implementation
  40 provides all of the optional map operations, and permits null values and the
  41 null key. (The HashMap class is roughly equivalent to Hashtable, except that it
  42 is unsynchronized and permits nulls.) This class makes no guarantees as to the
  43 order of the map; in particular, it does not guarantee that the order will
  44 remain constant over time.
  45
  46 This implementation provides constant-time performance for the basic operations
  47 (get and put), assuming the hash function disperses the elements properly among
  48 the buckets. Iteration over collection views requires time proportional to the
  49 "capacity" of the HashMap instance (the number of buckets) plus its size (the
  50 number of key-value mappings). Thus, it's very important not to set the initial
  51 capacity too high (or the load factor too low) if iteration performance is
  52 important.
  53
  54 An instance of HashMap has two parameters that affect its performance: initial
  55 capacity and load factor. The capacity is the number of buckets in the hash
  56 table, and the initial capacity is simply the capacity at the time the hash
  57 table is created. The load factor is a measure of how full the hash table is
  58 allowed to get before its capacity is automatically increased. When the number
  59 of entries in the hash table exceeds the product of the load factor and the
  60 current capacity, the hash table is rehashed (that is, internal data structures
  61 are rebuilt) so that the hash table has approximately twice the number of
  62 buckets.
  63
  64 As a general rule, the default load factor (.75) offers a good tradeoff between
  65 time and space costs. Higher values decrease the space overhead but increase
  66 the lookup cost (reflected in most of the operations of the HashMap class,
  67 including get and put). The expected number of entries in the map and its load
  68 factor should be taken into account when setting its initial capacity, so as to
  69 minimize the number of rehash operations. If the initial capacity is greater
  70 than the maximum number of entries divided by the load factor, no rehash
  71 operations will ever occur.
  72
  73 If many mappings are to be stored in a HashMap instance, creating it with a
  74 sufficiently large capacity will allow the mappings to be stored more
  75 efficiently than letting it perform automatic rehashing as needed to grow the
  76 table.
  77
  78 Note that this implementation is not synchronized. If multiple threads access a
  79 hash map concurrently, and at least one of the threads modifies the map
  80 structurally, it must be synchronized externally. (A structural modification is
  81 any operation that adds or deletes one or more mappings; merely changing the
  82 value associated with a key that an instance already contains is not a
  83 structural modification.) This is typically accomplished by synchronizing on
  84 some object that naturally encapsulates the map.
  85
  86 If no such object exists, the map should be "wrapped" using the
  87 Collections.synchronizedMap(|java.util.Collections|) method. This is best done
  88 at creation time, to prevent accidental unsynchronized access to the map:
  89
  90 Map m = Collections.synchronizedMap(new HashMap(...));
  91
  92 The iterators returned by all of this class's "collection view methods" are
  93 fail-fast: if the map is structurally modified at any time after the iterator
  94 is created, in any way except through the iterator's own remove method, the
  95 iterator will throw a (|java.util.ConcurrentModificationException|) . Thus, in
  96 the face of concurrent modification, the iterator fails quickly and cleanly,
  97 rather than risking arbitrary, non-deterministic behavior at an undetermined
  98 time in the future.
  99
 100 Note that the fail-fast behavior of an iterator cannot be guaranteed as it is,
 101 generally speaking, impossible to make any hard guarantees in the presence of
 102 unsynchronized concurrent modification. Fail-fast iterators throw
 103 ConcurrentModificationException on a best-effort basis. Therefore, it would be
 104 wrong to write a program that depended on this exception for its correctness:
 105 the fail-fast behavior of iterators should be used only to detect bugs.
 106
 107 This class is a member of the <a
 108 href="/../technotes/guides/collections/index.html"> Java Collections Framework.
 109
 110
 111
 112 *java.util.HashMap()*
 113
 114 public HashMap()
 115
 116 Constructs an empty HashMap with the default initial capacity (16) and the
 117 default load factor (0.75).
 118
 119
 120 *java.util.HashMap(int)*
 121
 122 public HashMap(int initialCapacity)
 123
 124 Constructs an empty HashMap with the specified initial capacity and the default
 125 load factor (0.75).
 126
 127     initialCapacity - the initial capacity.
 128
 129 *java.util.HashMap(int,float)*
 130
 131 public HashMap(
 132   int initialCapacity,
 133   float loadFactor)
 134
 135 Constructs an empty HashMap with the specified initial capacity and load
 136 factor.
 137
 138     initialCapacity - the initial capacity
 139     loadFactor - the load factor
 140
 141 *java.util.HashMap(Map<?extendsK,?extendsV>)*
 142
 143 public HashMap(java.util.Map<? extends K, ? extends V> m)
 144
 145 Constructs a new HashMap with the same mappings as the specified Map. The
 146 HashMap is created with default load factor (0.75) and an initial capacity
 147 sufficient to hold the mappings in the specified Map.
 148
 149     m - the map whose mappings are to be placed in this map
 150
 151 *java.util.HashMap.clear()*
 152
 153 public void clear()
 154
 155 Removes all of the mappings from this map. The map will be empty after this
 156 call returns.
 157
 158
 159
 160 *java.util.HashMap.clone()*
 161
 162 public |java.lang.Object| clone()
 163
 164 Returns a shallow copy of this HashMap instance: the keys and values themselves
 165 are not cloned.
 166
 167
 168
 169     Returns: a shallow copy of this map
 170
 171 *java.util.HashMap.containsKey(Object)*
 172
 173 public boolean containsKey(java.lang.Object key)
 174
 175 Returns true if this map contains a mapping for the specified key.
 176
 177
 178     key - The key whose presence in this map is to be tested
 179
 180     Returns: true if this map contains a mapping for the specified key.
 181
 182 *java.util.HashMap.containsValue(Object)*
 183
 184 public boolean containsValue(java.lang.Object value)
 185
 186 Returns true if this map maps one or more keys to the specified value.
 187
 188
 189     value - value whose presence in this map is to be tested
 190
 191     Returns: true if this map maps one or more keys to the specified value
 192
 193 *java.util.HashMap.entrySet()*
 194
 195 public |java.util.Set|<Entry<K,V>> entrySet()
 196
 197 Returns a (|java.util.Set|) view of the mappings contained in this map. The set
 198 is backed by the map, so changes to the map are reflected in the set, and
 199 vice-versa. If the map is modified while an iteration over the set is in
 200 progress (except through the iterator's own remove operation, or through the
 201 setValue operation on a map entry returned by the iterator) the results of the
 202 iteration are undefined. The set supports element removal, which removes the
 203 corresponding mapping from the map, via the Iterator.remove, Set.remove,
 204 removeAll, retainAll and clear operations. It does not support the add or
 205 addAll operations.
 206
 207
 208
 209     Returns: a set view of the mappings contained in this map
 210
 211 *java.util.HashMap.get(Object)*
 212
 213 public |V| get(java.lang.Object key)
 214
 215 Returns the value to which the specified key is mapped, ornullif this map
 216 contains no mapping for the key.
 217
 218 More formally, if this map contains a mapping from a keykto a valuevsuch
 219 that(key==null ? k==null : key.equals(k)), then this method returnsv; otherwise
 220 it returnsnull. (There can be at most one such mapping.)
 221
 222 A return value ofnulldoes not necessarily indicate that the map contains no
 223 mapping for the key; it's also possible that the map explicitly maps the key
 224 tonull. The containsKey(|java.util.HashMap|) operation may be used to
 225 distinguish these two cases.
 226
 227
 228
 229 *java.util.HashMap.isEmpty()*
 230
 231 public boolean isEmpty()
 232
 233 Returns true if this map contains no key-value mappings.
 234
 235
 236
 237     Returns: true if this map contains no key-value mappings
 238
 239 *java.util.HashMap.keySet()*
 240
 241 public |java.util.Set|<K> keySet()
 242
 243 Returns a (|java.util.Set|) view of the keys contained in this map. The set is
 244 backed by the map, so changes to the map are reflected in the set, and
 245 vice-versa. If the map is modified while an iteration over the set is in
 246 progress (except through the iterator's own remove operation), the results of
 247 the iteration are undefined. The set supports element removal, which removes
 248 the corresponding mapping from the map, via the Iterator.remove, Set.remove,
 249 removeAll, retainAll, and clear operations. It does not support the add or
 250 addAll operations.
 251
 252
 253
 254 *java.util.HashMap.put(K,V)*
 255
 256 public |V| put(
 257   K key,
 258   V value)
 259
 260 Associates the specified value with the specified key in this map. If the map
 261 previously contained a mapping for the key, the old value is replaced.
 262
 263
 264     key - key with which the specified value is to be associated
 265     value - value to be associated with the specified key
 266
 267     Returns: the previous value associated with key, or null if there was no mapping for
 268              key. (A null return can also indicate that the map previously
 269              associated null with key.)
 270
 271 *java.util.HashMap.putAll(Map<?extendsK,?extendsV>)*
 272
 273 public void putAll(java.util.Map<? extends K, ? extends V> m)
 274
 275 Copies all of the mappings from the specified map to this map. These mappings
 276 will replace any mappings that this map had for any of the keys currently in
 277 the specified map.
 278
 279
 280     m - mappings to be stored in this map
 281
 282 *java.util.HashMap.remove(Object)*
 283
 284 public |V| remove(java.lang.Object key)
 285
 286 Removes the mapping for the specified key from this map if present.
 287
 288
 289     key - key whose mapping is to be removed from the map
 290
 291     Returns: the previous value associated with key, or null if there was no mapping for
 292              key. (A null return can also indicate that the map previously
 293              associated null with key.)
 294
 295 *java.util.HashMap.size()*
 296
 297 public int size()
 298
 299 Returns the number of key-value mappings in this map.
 300
 301
 302
 303     Returns: the number of key-value mappings in this map
 304
 305 *java.util.HashMap.values()*
 306
 307 public |java.util.Collection|<V> values()
 308
 309 Returns a (|java.util.Collection|) view of the values contained in this map.
 310 The collection is backed by the map, so changes to the map are reflected in the
 311 collection, and vice-versa. If the map is modified while an iteration over the
 312 collection is in progress (except through the iterator's own remove operation),
 313 the results of the iteration are undefined. The collection supports element
 314 removal, which removes the corresponding mapping from the map, via the
 315 Iterator.remove, Collection.remove, removeAll, retainAll and clear operations.
 316 It does not support the add or addAll operations.
 317
 318
 319
 320