Package jadex.commons.collection
Class CheckedMap
- java.lang.Object
-
- jadex.commons.collection.CheckedMap
-
- All Implemented Interfaces:
java.util.Map
public class CheckedMap extends java.lang.Object implements java.util.Map
-
-
Constructor Summary
Constructors Constructor Description CheckedMap(java.util.Map map)
Create a new collection.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Removes all of the mappings from this map (optional operation).boolean
containsKey(java.lang.Object key)
Returnsboolean
containsValue(java.lang.Object value)
Returnsjava.util.Set
entrySet()
Returns aSet
view of the mappings contained in this map.boolean
equals(java.lang.Object o)
Compares the specified object with this map for equality.java.lang.Object
get(java.lang.Object key)
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()
Returnsjava.util.Set
keySet()
Returns aSet
view of the keys contained in this map.java.lang.Object
put(java.lang.Object key, java.lang.Object value)
Associates the specified value with the specified key in this map (optional operation).void
putAll(java.util.Map m)
Copies all of the mappings from the specified map to this map (optional operation).java.lang.Object
remove(java.lang.Object key)
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.java.util.Collection
values()
Returns aCollection
view of the values contained in this map.
-
-
-
Method Detail
-
size
public int size()
Returns the number of key-value mappings in this map. If the map contains more than- Specified by:
size
in interfacejava.util.Map
- Returns:
- the number of key-value mappings in this map
-
isEmpty
public boolean isEmpty()
Returns- Specified by:
isEmpty
in interfacejava.util.Map
- Returns:
-
containsKey
public boolean containsKey(java.lang.Object key)
Returns- Specified by:
containsKey
in interfacejava.util.Map
- Parameters:
key
- key whose presence in this map is to be tested- Returns:
-
- Throws:
java.lang.ClassCastException
- if the key is of an inappropriate type for this map (optional)java.lang.NullPointerException
- if the specified key is null and this map does not permit null keys (optional)
-
containsValue
public boolean containsValue(java.lang.Object value)
Returns- Specified by:
containsValue
in interfacejava.util.Map
- Parameters:
value
- value whose presence in this map is to be tested- Returns:
-
- Throws:
java.lang.ClassCastException
- if the value is of an inappropriate type for this map (optional)java.lang.NullPointerException
- if the specified value is null and this map does not permit null values (optional)
-
get
public java.lang.Object get(java.lang.Object key)
Returns the value to which the specified key is mapped, ornull
if this map contains no mapping for the key.k to a value
v
such that(key==null ? k==null : key.equals(k))
, then this method returnsv
; otherwise it returnsnull
. (There can be at most one such mapping.)null does not null. The
containsKey
operation may be used to distinguish these two cases.- Specified by:
get
in interfacejava.util.Map
- 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:
java.lang.ClassCastException
- if the key is of an inappropriate type for this map (optional)java.lang.NullPointerException
- if the specified key is null and this map does not permit null keys (optional)
-
put
public java.lang.Object put(java.lang.Object key, java.lang.Object value)
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.containsKey(k)
would return- Specified by:
put
in interfacejava.util.Map
- 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
- Throws:
java.lang.UnsupportedOperationException
- if thejava.lang.ClassCastException
- if the class of the specified key or value prevents it from being stored in this mapjava.lang.NullPointerException
- if the specified key or value is null and this map does not permit null keys or valuesjava.lang.IllegalArgumentException
- if some property of the specified key or value prevents it from being stored in this map
-
remove
public java.lang.Object remove(java.lang.Object key)
Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key (key==null ? k==null : key.equals(k)), that mapping is removed. (The map can contain at most one such mapping.)- Specified by:
remove
in interfacejava.util.Map
- Parameters:
key
- key whose mapping is to be removed from the map- Returns:
- the previous value associated with
- Throws:
java.lang.UnsupportedOperationException
- if thejava.lang.ClassCastException
- if the key is of an inappropriate type for this map (optional)java.lang.NullPointerException
- if the specified key is null and this map does not permit null keys (optional)
-
putAll
public void putAll(java.util.Map m)
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 key- Specified by:
putAll
in interfacejava.util.Map
- Parameters:
m
- mappings to be stored in this map- Throws:
java.lang.UnsupportedOperationException
- if thejava.lang.ClassCastException
- if the class of a key or value in the specified map prevents it from being stored in this mapjava.lang.NullPointerException
- if the specified map is null, or if this map does not permit null keys or values, and the specified map contains null keys or valuesjava.lang.IllegalArgumentException
- if some property of a key or value in the specified map prevents it from being stored in this map
-
clear
public void clear()
Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.- Specified by:
clear
in interfacejava.util.Map
- Throws:
java.lang.UnsupportedOperationException
- if the
-
keySet
public java.util.Set keySet()
Returns aSet
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 own- Specified by:
keySet
in interfacejava.util.Map
- Returns:
- a set view of the keys contained in this map
-
values
public java.util.Collection values()
Returns aCollection
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 own- Specified by:
values
in interfacejava.util.Map
- Returns:
- a collection view of the values contained in this map
-
entrySet
public java.util.Set entrySet()
Returns aSet
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 own- Specified by:
entrySet
in interfacejava.util.Map
- Returns:
- a set view of the mappings contained in this map
-
equals
public boolean equals(java.lang.Object o)
Compares the specified object with this map for equality. Returns- Specified by:
equals
in interfacejava.util.Map
- Overrides:
equals
in classjava.lang.Object
- Parameters:
o
- object to be compared for equality with this map- Returns:
-
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's Object.hashCode().- Specified by:
hashCode
in interfacejava.util.Map
- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- the hash code value for this map
- See Also:
Map.Entry.hashCode()
,Object.equals(Object)
,equals(Object)
-
-