Class MapAdapter
- All Implemented Interfaces:
HMap
-
Nested Class Summary
Nested classes/interfaces inherited from interface myAdapter.HMap
HMap.HEntry
-
Constructor Summary
ConstructorDescriptionDefault constructor with no arguments.MapAdapter
(HMap map) Constructor with map arguments. -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Removes all of the mappings from this map.boolean
containsKey
(Object key) Returnstrue
if this map contains a mapping for the specified key.boolean
containsValue
(Object value) Returnstrue
if this map maps one or more keys to the specified value.entrySet()
Returns aHSet
view of the mappings contained in this map.boolean
Compares the specified object with this map for equality.Returns the value to which the specified key is mapped, ornull
if this map contains no mapping for the key.int
hashCode()
Returns the hash code value for this map.boolean
isEmpty()
Returnstrue
if this map contains no key-value mappings.keySet()
Returns aHSet
view of the keys contained in this map.Associates the specified value with the specified key in this map (optional operation).void
Copies all of the mappings from the specified map to this map (optional operation).Removes the mapping for a key from this map if it is present (optional operation).int
size()
Returns the number of key-value mappings in this map.toString()
Returns a string representation of thisHMap
object in the form of a set of entries, enclosed in braces and separated by the ASCII characters ",
" (comma and space).values()
Returns aHCollection
view of the values contained in this map.
-
Constructor Details
-
MapAdapter
public MapAdapter()Default constructor with no arguments. -
MapAdapter
Constructor with map arguments. All the elements in the map argument should be included in the map- Parameters:
map
- to be included in this map
-
-
Method Details
-
size
public int size()Returns the number of key-value mappings in this map. If the map contains more thanInteger.MAX_VALUE
elements, returnsInteger.MAX_VALUE
. -
isEmpty
public boolean isEmpty()Returnstrue
if this map contains no key-value mappings. -
containsKey
Returnstrue
if this map contains a mapping for the specified key. More formally, returnstrue
if and only if this map contains a mapping for a keyk
such thatObjects.equals(key, k)
. (There can be at most one such mapping.)- Specified by:
containsKey
in interfaceHMap
- Parameters:
key
- key whose presence in this map is to be tested- Returns:
true
if this map contains a mapping for the specified key- Throws:
NullPointerException
- if the specified key is null (this map does not permit null key).
-
containsValue
Returnstrue
if this map maps one or more keys to the specified value. More formally, returnstrue
if and only if this map contains at least one mapping to a valuev
such thatObjects.equals(value, v)
. This operation will probably require time linear in the map size for most implementations of theMap
interface.- Specified by:
containsValue
in interfaceHMap
- Parameters:
value
- value whose presence in this map is to be tested- Returns:
true
if this map maps one or more keys to the specified value- Throws:
NullPointerException
- if the specified value is null (this map does not permit null values).
-
get
Returns the value to which the specified key is mapped, ornull
if this map contains no mapping for the key.More formally, if this map contains a mapping from a key
k
to a valuev
such thatObjects.equals(key, k)
, then this method returnsv
; otherwise it returnsnull
. (There can be at most one such mapping.)If this map permits null values, then 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 tonull
. ThecontainsKey
operation may be used to distinguish these two cases.- Specified by:
get
in interfaceHMap
- Parameters:
key
- the key whose associated value is to be returned- Returns:
- the value to which the specified key is mapped, or
null
if this map contains no mapping for the key - Throws:
NullPointerException
- if the specified key is null (this map does not permit null key).
-
put
Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A mapm
is said to contain a mapping for a keyk
if and only ifm.containsKey(k)
would returntrue
.)- Specified by:
put
in interfaceHMap
- Parameters:
key
- key with which the specified value is to be associatedvalue
- value to be associated with the specified key- Returns:
- the previous value associated with
key
, ornull
if there was no mapping forkey
. (Anull
return can also indicate that the map previously associatednull
withkey
, if the implementation supportsnull
values.) - Throws:
NullPointerException
- if the specified key or value is null (this map does not permit null key).
-
remove
Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from keyk
to valuev
such thatObjects.equals(key, k)
, that mapping is removed. (The map can contain at most one such mapping.)Returns the value to which this map previously associated the key, or
null
if the map contained no mapping for the key.If this map permits null values, then a return value of
null
does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key tonull
.The map will not contain a mapping for the specified key once the call returns.
- Specified by:
remove
in interfaceHMap
- Parameters:
key
- key whose mapping is to be removed from the map- Returns:
- the previous value associated with
key
, ornull
if there was no mapping forkey
. - Throws:
NullPointerException
- if the specified key is null (this map does not permit null key).
-
putAll
Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of callingput(k, v)
on this map once for each mapping from keyk
to valuev
in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress.- Specified by:
putAll
in interfaceHMap
- Parameters:
m
- mappings to be stored in this map- Throws:
NullPointerException
- the specified map is null, or if this map does not permit null keys or values, and the specified map contains null keys or values. (this map does not permit null key).
-
clear
public void clear()Removes all of the mappings from this map. The map will be empty after this call returns. -
keySet
Returns aHSet
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 (except through the iterator's ownremove
operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via theHIterator.remove
,HSet.remove
,removeAll
,retainAll
, andclear
operations. It does not support theadd
oraddAll
operations. -
values
Returns aHCollection
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 (except through the iterator's ownremove
operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via theHIterator.remove
,HCollection.remove
,removeAll
,retainAll
andclear
operations. It does not support theadd
oraddAll
operations. -
entrySet
Returns aHSet
view of the mappings 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 (except through the iterator's ownremove
operation, or through thesetValue
operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via theHIterator.remove
,HSet.remove
,removeAll
,retainAll
andclear
operations. It does not support theadd
oraddAll
operations. -
equals
Compares the specified object with this map for equality. Returnstrue
if the given object is also a map and the two maps represent the same mappings. More formally, two mapsm1
andm2
represent the same mappings ifm1.entrySet().equals(m2.entrySet())
. This ensures that theequals
method works properly across different implementations of theMap
interface. -
hashCode
public int hashCode()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'sentrySet()
view. This ensures thatm1.equals(m2)
implies thatm1.hashCode()==m2.hashCode()
for any two mapsm1
andm2
, as required by the general contract ofObject.hashCode()
. -
toString
Returns a string representation of thisHMap
object in the form of a set of entries, enclosed in braces and separated by the ASCII characters ",
" (comma and space). Each entry is rendered as the key, an equals sign=
, and the associated element, where thetoString
method is used to convert the key and element to strings.
-