| java.lang.Object
 java.util.AbstractMap
All known Subclasses: java.util.IdentityHashMap, sun.misc.SoftCache, sun.awt.IdentityWeakHashMap, java.util.WeakHashMap, java.util.HashMap, java.util.TreeMap,
| AbstractMap | | abstract public class AbstractMap implements Map(Code) | | This class provides a skeletal implementation of the Map
interface, to minimize the effort required to implement this interface.
To implement an unmodifiable map, the programmer needs only to extend this
class and provide an implementation for the entrySet method, which
returns a set-view of the map's mappings. Typically, the returned set
will, in turn, be implemented atop AbstractSet. This set should
not support the add or remove methods, and its iterator
should not support the remove method.
To implement a modifiable map, the programmer must additionally override
this class's put method (which otherwise throws an
UnsupportedOperationException), and the iterator returned by
entrySet().iterator() must additionally implement its
remove method.
The programmer should generally provide a void (no argument) and map
constructor, as per the recommendation in the Map interface
specification.
The documentation for each non-abstract methods in this class describes its
implementation in detail. Each of these methods may be overridden if the
map being implemented admits a more efficient implementation.
This class is a member of the
Java Collections Framework.
author:
Josh Bloch
version:
1.21, 02/02/00
See Also: Map
See Also: Collection
since:
1.2 |
| Inner Class :static class SimpleEntry implements Entry | |
| Field Summary | |
| transient volatile Set | keySet
Each of these fields are initialized to contain an instance of the
appropriate view the first time this view is requested. | | transient volatile Collection | values
|
| Constructor Summary | |
| protected | AbstractMap()
Sole constructor. |
| Method Summary | |
| public void | clear()
Removes all mappings from this map (optional operation). | | protected Object | clone()
Returns a shallow copy of this AbstractMap instance: the keys
and values themselves are not cloned. | | public boolean | containsKey(Object key)
Returns true if this map contains a mapping for the specified
key. | | public boolean | containsValue(Object value)
Returns true if this map maps one or more keys to this value.
More formally, returns true if and only if this map contains
at least one mapping to a value v such that (value==null ?
v==null : value.equals(v)). | | abstract public Set | entrySet()
Returns a set view of the mappings contained in this map. | | public boolean | equals(Object o)
Compares the specified object with this map for equality. | | public Object | get(Object key)
Returns the value to which this map maps the specified key. | | public int | hashCode()
Returns the hash code value for this map. | | public boolean | isEmpty()
Returns true if this map contains no key-value mappings. | | public Set | keySet()
Returns a Set view of the keys contained in this map. | | public Object | put(Object key, Object value)
Associates the specified value with the specified key in this map
(optional operation). | | public void | putAll(Map t)
Copies all of the mappings from the specified map to this map
(optional operation). | | public Object | remove(Object key)
Removes the mapping for this key from this map if present (optional
operation). | | public int | size()
Returns the number of key-value mappings in this map. | | public String | toString()
Returns a string representation of this map. | | public Collection | values()
Returns a collection view of the values contained in this map. |
| keySet | | transient volatile Set keySet(Code) | | Each of these fields are initialized to contain an instance of the
appropriate view the first time this view is requested. The views are
stateless, so there's no reason to create more than one of each.
|
| AbstractMap | | protected AbstractMap()(Code) | | Sole constructor. (For invocation by subclass constructors, typically
implicit.)
|
| clear | | public void clear()(Code) | | Removes all mappings from this map (optional operation).
This implementation calls entrySet().clear().
Note that this implementation throws an
UnsupportedOperationException if the entrySet
does not support the clear operation.
throws:
UnsupportedOperationException - clear is not supportedby this map. |
| clone | | protected Object clone() throws CloneNotSupportedException(Code) | | Returns a shallow copy of this AbstractMap instance: the keys
and values themselves are not cloned.
a shallow copy of this map. |
| containsKey | | public boolean containsKey(Object key)(Code) | | Returns true if this map contains a mapping for the specified
key.
This implementation iterates over entrySet() searching for an
entry with the specified key. If such an entry is found, true
is returned. If the iteration terminates without finding such an
entry, false is returned. Note that this implementation
requires linear time in the size of the map; many implementations will
override this method.
Parameters:
key - key whose presence in this map is to be tested. true if this map contains a mapping for the specifiedkey.
throws:
NullPointerException - key is null and this map does notnot permit null keys. |
| containsValue | | public boolean containsValue(Object value)(Code) | | Returns true if this map maps one or more keys to this value.
More formally, returns true if and only if this map contains
at least one mapping to a value v such that (value==null ?
v==null : value.equals(v)). This operation will probably require
time linear in the map size for most implementations of map.
This implementation iterates over entrySet() searching for an entry
with the specified value. If such an entry is found, true is
returned. If the iteration terminates without finding such an entry,
false is returned. Note that this implementation requires
linear time in the size of the map.
Parameters:
value - value whose presence in this map is to be tested. true if this map maps one or more keys to this value. |
| entrySet | | abstract public Set entrySet()(Code) | | Returns a set view of the mappings contained in this map. Each element
in this set is a Map.Entry. The set is backed by the map, so changes
to the map are reflected in the set, and vice-versa. (If the map is
modified while an iteration over the set is in progress, the results of
the iteration are undefined.) The set supports element removal, which
removes the corresponding entry from the map, via the
Iterator.remove, Set.remove, removeAll,
retainAll and clear operations. It does not support
the add or addAll operations.
a set view of the mappings contained in this map. |
| equals | | public boolean equals(Object o)(Code) | | Compares the specified object with this map for equality. Returns
true if the given object is also a map and the two maps
represent the same mappings. More formally, two maps t1 and
t2 represent the same mappings if
t1.keySet().equals(t2.keySet()) and for every key k
in t1.keySet(), (t1.get(k)==null ? t2.get(k)==null :
t1.get(k).equals(t2.get(k))) . This ensures that the
equals method works properly across different implementations
of the map interface.
This implementation first checks if the specified object is this map;
if so it returns true. Then, it checks if the specified
object is a map whose size is identical to the size of this set; if
not, it it returns false. If so, it iterates over this map's
entrySet collection, and checks that the specified map
contains each mapping that this map contains. If the specified map
fails to contain such a mapping, false is returned. If the
iteration completes, true is returned.
Parameters:
o - object to be compared for equality with this map. true if the specified object is equal to this map. |
| get | | public Object get(Object key)(Code) | | Returns the value to which this map maps the specified key. Returns
null if the map contains no mapping for this key. A return
value of null does not necessarily indicate that the
map contains no mapping for the key; it's also possible that the map
explicitly maps the key to null. The containsKey operation
may be used to distinguish these two cases.
This implementation iterates over entrySet() searching for an
entry with the specified key. If such an entry is found, the entry's
value is returned. If the iteration terminates without finding such an
entry, null is returned. Note that this implementation
requires linear time in the size of the map; many implementations will
override this method.
Parameters:
key - key whose associated value is to be returned. the value to which this map maps the specified key.
throws:
NullPointerException - if the key is null and this mapdoes not not permit null keys.
See Also: AbstractMap.containsKey(Object) |
| hashCode | | public int hashCode()(Code) | | Returns the hash code value for this map. The hash code of a map is
defined to be the sum of the hash codes of each entry in the map's
entrySet() view. This ensures that t1.equals(t2)
implies that t1.hashCode()==t2.hashCode() for any two maps
t1 and t2, as required by the general contract of
Object.hashCode.
This implementation iterates over entrySet(), calling
hashCode on each element (entry) in the Collection, and adding
up the results.
the hash code value for this map.
See Also: Map.Entry.hashCode
See Also: Object.hashCode
See Also: Object.equals(Object)
See Also: Set.equals(Object) |
| isEmpty | | public boolean isEmpty()(Code) | | Returns true if this map contains no key-value mappings.
This implementation returns size() == 0.
true if this map contains no key-value mappings. |
| keySet | | public Set keySet()(Code) | | Returns a Set view of the keys contained in this map. The Set is
backed by the map, so changes to the map are reflected in the Set,
and vice-versa. (If the map is modified while an iteration over
the Set is in progress, the results of the iteration are undefined.)
The Set supports element removal, which removes the corresponding entry
from the map, via the Iterator.remove, Set.remove, removeAll
retainAll, and clear operations. It does not support the add or
addAll operations.
This implementation returns a Set that subclasses
AbstractSet. The subclass's iterator method returns a "wrapper
object" over this map's entrySet() iterator. The size method delegates
to this map's size method and the contains method delegates to this
map's containsKey method.
The Set is created the first time this method is called,
and returned in response to all subsequent calls. No synchronization
is performed, so there is a slight chance that multiple calls to this
method will not all return the same Set.
a Set view of the keys contained in this map. |
| put | | public Object put(Object key, Object value)(Code) | | Associates the specified value with the specified key in this map
(optional operation). If the map previously contained a mapping for
this key, the old value is replaced.
This implementation always throws an
UnsupportedOperationException.
Parameters:
key - key with which the specified value is to be associated.
Parameters:
value - value to be associated with the specified key. previous value associated with specified key, or nullif there was no mapping for key. (A null return canalso indicate that the map previously associated nullwith the specified key, if the implementation supportsnull values.)
throws:
UnsupportedOperationException - if the put operation isnot supported by this map.
throws:
ClassCastException - if the class of the specified key or valueprevents it from being stored in this map.
throws:
IllegalArgumentException - if some aspect of this key or value *prevents it from being stored in this map.
throws:
NullPointerException - this map does not permit nullkeys or values, and the specified key or value isnull. |
| putAll | | public void putAll(Map t)(Code) | | Copies all of the mappings from the specified map to this map
(optional operation). These mappings will replace any mappings that
this map had for any of the keys currently in the specified map.
This implementation iterates over the specified map's
entrySet() collection, and calls this map's put
operation once for each entry returned by the iteration.
Note that this implementation throws an
UnsupportedOperationException if this map does not support
the put operation and the specified map is nonempty.
Parameters:
t - mappings to be stored in this map.
throws:
UnsupportedOperationException - if the putAll operationis not supported by this map.
throws:
ClassCastException - if the class of a key or value in thespecified map prevents it from being stored in this map.
throws:
IllegalArgumentException - if some aspect of a key or value inthe specified map prevents it from being stored in this map.
throws:
NullPointerException - the specified map is null, or ifthis map does not permit null keys or values, and thespecified map contains null keys or values. |
| remove | | public Object remove(Object key)(Code) | | Removes the mapping for this key from this map if present (optional
operation).
This implementation iterates over entrySet() searching for an
entry with the specified key. If such an entry is found, its value is
obtained with its getValue operation, the entry is is removed
from the Collection (and the backing map) with the iterator's
remove operation, and the saved value is returned. If the
iteration terminates without finding such an entry, null is
returned. Note that this implementation requires linear time in the
size of the map; many implementations will override this method.
Note that this implementation throws an
UnsupportedOperationException if the entrySet iterator
does not support the remove method and this map contains a
mapping for the specified key.
Parameters:
key - key whose mapping is to be removed from the map. previous value associated with specified key, or nullif there was no entry for key. (A null return canalso indicate that the map previously associated nullwith the specified key, if the implementation supportsnull values.)
throws:
UnsupportedOperationException - if the remove operationis not supported by this map. |
| size | | public int size()(Code) | | Returns the number of key-value mappings in this map. If the map
contains more than Integer.MAX_VALUE elements, returns
Integer.MAX_VALUE.
This implementation returns entrySet().size().
the number of key-value mappings in this map. |
| toString | | public String toString()(Code) | | Returns a string representation of this map. The string representation
consists of a list of key-value mappings in the order returned by the
map's entrySet view's iterator, enclosed in braces
("{}"). Adjacent mappings are separated by the characters
", " (comma and space). Each key-value mapping is rendered as
the key followed by an equals sign ("=") followed by the
associated value. Keys and values are converted to strings as by
String.valueOf(Object).
This implementation creates an empty string buffer, appends a left
brace, and iterates over the map's entrySet view, appending
the string representation of each map.entry in turn. After
appending each entry except the last, the string ", " is
appended. Finally a right brace is appended. A string is obtained
from the stringbuffer, and returned.
a String representation of this map. |
| values | | public Collection values()(Code) | | Returns a collection view of the values contained in this map. The
collection is backed by the map, so changes to the map are reflected in
the collection, and vice-versa. (If the map is modified while an
iteration over the collection is in progress, the results of the
iteration are undefined.) The collection supports element removal,
which removes the corresponding entry from the map, via the
Iterator.remove, Collection.remove,
removeAll, retainAll and clear operations.
It does not support the add or addAll operations.
This implementation returns a collection that subclasses abstract
collection. The subclass's iterator method returns a "wrapper object"
over this map's entrySet() iterator. The size method
delegates to this map's size method and the contains method delegates
to this map's containsValue method.
The collection is created the first time this method is called, and
returned in response to all subsequent calls. No synchronization is
performed, so there is a slight chance that multiple calls to this
method will not all return the same Collection.
a collection view of the values contained in this map. |
|
|