Package de.intarsys.tools.collection
Class PartitionedMap
- java.lang.Object
-
- de.intarsys.tools.collection.PartitionedMap
-
- All Implemented Interfaces:
java.util.Map
public class PartitionedMap extends java.lang.Object implements java.util.Map
A map that wraps two other maps.
-
-
Constructor Summary
Constructors Constructor Description PartitionedMap()
PartitionedMap(java.util.Map parent, java.util.Map child)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Removes all mappings from this map (optional operation).boolean
containsKey(java.lang.Object key)
Returns true if this map contains a mapping for the specified key.boolean
containsValue(java.lang.Object value)
Returns true if this map maps one or more keys to the specified value.static java.util.Map
create(java.util.Map parent, java.util.Map child)
java.util.Set
entrySet()
Returns a set view of the mappings contained in this map.java.lang.Object
get(java.lang.Object key)
Returns the value to which this map maps the specified key.protected java.util.Map
getChild()
java.util.Map
getParent()
boolean
isEmpty()
Returns true if this map contains no key-value mappings.java.util.Set
keySet()
Returns a set 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 t)
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 this key from this map if present (optional operation).void
setParent(java.util.Map newParent)
int
size()
Returns the number of key-value mappings in this map.java.lang.String
toString()
java.util.Collection
values()
Returns a collection view of the values contained in this map.
-
-
-
Method Detail
-
create
public static java.util.Map create(java.util.Map parent, java.util.Map child)
-
clear
public void clear()
Removes all mappings from this map (optional operation).- Specified by:
clear
in interfacejava.util.Map
-
containsKey
public boolean containsKey(java.lang.Object key)
Returns true if this map contains a mapping for the specified key.- Specified by:
containsKey
in interfacejava.util.Map
- Parameters:
key
- key whose presence in this map is to be tested.- Returns:
- true if this map contains a mapping for the specified key.
-
containsValue
public boolean containsValue(java.lang.Object value)
Returns true if this map maps one or more keys to the specified 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 the Map interface.- Specified by:
containsValue
in interfacejava.util.Map
- 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.
-
entrySet
public java.util.Set entrySet()
Returns a set view of the mappings contained in this map. Each element in the returned 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 mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.- Specified by:
entrySet
in interfacejava.util.Map
- Returns:
- a set view of the mappings contained in this map.
-
get
public java.lang.Object get(java.lang.Object key)
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.- Specified by:
get
in interfacejava.util.Map
- Parameters:
key
- key whose associated value is to be returned.- Returns:
- the value to which this map maps the specified key, or null if the map contains no mapping for this key.
- See Also:
containsKey(Object)
-
getChild
protected java.util.Map getChild()
-
getParent
public java.util.Map getParent()
-
isEmpty
public boolean isEmpty()
Returns true if this map contains no key-value mappings.- Specified by:
isEmpty
in interfacejava.util.Map
- Returns:
- true if this map contains no key-value mappings.
-
keySet
public java.util.Set keySet()
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 mapping from the map, via the Iterator.remove, Set.remove, removeAllretainAll, and clear operations. It does not support the add or addAll operations.- Specified by:
keySet
in interfacejava.util.Map
- Returns:
- a set view of the keys contained in this map.
-
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 this key, the old value is replaced.- Specified by:
put
in interfacejava.util.Map
- Parameters:
key
- key with which the specified value is to be associated.value
- value to be associated with the specified key.- Returns:
- previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key, if the implementation supports null values.
-
putAll
public void putAll(java.util.Map t)
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.- Specified by:
putAll
in interfacejava.util.Map
- Parameters:
t
- Mappings to be stored in this map.
-
remove
public java.lang.Object remove(java.lang.Object key)
Removes the mapping for this key from this map if present (optional operation).- Specified by:
remove
in interfacejava.util.Map
- Parameters:
key
- key whose mapping is to be removed from the map.- Returns:
- previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key, if the implementation supports null values.
-
setParent
public void setParent(java.util.Map newParent)
-
size
public int size()
Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.- Specified by:
size
in interfacejava.util.Map
- Returns:
- the number of key-value mappings in this map.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
values
public java.util.Collection values()
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 mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.- Specified by:
values
in interfacejava.util.Map
- Returns:
- a collection view of the values contained in this map.
-
-