public class CompositeMap<K,V> extends AbstractIterableMap<K ,V> implements Serializable
Changes made to this map will actually be made on the decorated map. Add and remove operations require the use of a pluggable strategy. If no strategy is provided then add and remove are unsupported.
Note that CompositeMap is not synchronized and is not thread-safe. If you wish to use this map from multiple threads concurrently, you must use appropriate synchronization. The simplest approach is to wrap this map using Collections. This class may throw exceptions when accessed by concurrent threads without synchronization.
| Modifier and Type | Class and Description |
|---|---|
static interface |
CompositeMap
This interface allows definition for all of the indeterminate mutators in a CompositeMap, as well as providing a hook for callbacks on key collisions.
|
| Constructor and Description |
|---|
CompositeMap()
Create a new, empty, CompositeMap.
|
CompositeMap(Map
Create a new CompositeMap which composites all of the Map instances in the argument.
|
CompositeMap(Map
Create a new CompositeMap which composites all of the Map instances in the argument.
|
CompositeMap(Map
Create a new CompositeMap with two composited Map instances.
|
CompositeMap(Map
Create a new CompositeMap with two composited Map instances.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addComposited(Map
Add an additional Map to the composite.
|
void |
clear()
Calls
clear() on all composited Maps.
|
boolean |
containsKey(Object
Returns
true if this map contains a mapping for the specified key.
|
boolean |
containsValue(Object
Returns
true if this map maps one or more keys to the specified value.
|
Set |
entrySet()
Returns a set view of the mappings contained in this map.
|
boolean |
equals(Object
Checks if this Map equals another as per the Map specification.
|
V |
get(Object
Returns the value to which this map maps the specified key.
|
int |
hashCode()
Gets a hash code for the Map as per the Map specification.
|
boolean |
isEmpty()
Returns
true if this map contains no key-value mappings.
|
Set |
keySet()
Returns a set view of the keys contained in this map.
|
V |
put(K key, V value)
Associates the specified value with the specified key in this map (optional operation).
|
void |
putAll(Map
Copies all of the mappings from the specified map to this map (optional operation).
|
V |
remove(Object
Removes the mapping for this key from this map if it is present (optional operation).
|
Map |
removeComposited(Map
Remove a Map from the composite.
|
void |
setMutator(CompositeMap
Specify the MapMutator to be used by mutation operations.
|
int |
size()
Returns the number of key-value mappings in this map.
|
Collection |
values()
Returns a collection view of the values contained in this map.
|
mapIteratorclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitcompute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAllpublic CompositeMap()
public CompositeMap(Map<K ,V> one, Map <K ,V> two)
one - the first Map to be composited
two - the second Map to be composited
IllegalArgumentException - if there is a key collision
public CompositeMap(Map<K ,V> one, Map <K ,V> two, CompositeMap .MapMutator <K ,V> mutator)
one - the first Map to be composited
two - the second Map to be composited
mutator - MapMutator to be used for mutation operations
public CompositeMap(Map<K ,V>... composite)
composite - the Maps to be composited
IllegalArgumentException - if there is a key collision
public CompositeMap(Map<K ,V>[] composite, CompositeMap .MapMutator <K ,V> mutator)
composite - Maps to be composited
mutator - MapMutator to be used for mutation operations
public void setMutator(CompositeMap.MapMutator <K ,V> mutator)
mutator - the MapMutator to be used for mutation delegation
public void addComposited(Map<K ,V> map) throws IllegalArgumentException
map - the Map to be added to the composite
IllegalArgumentException - if there is a key collision and there is no MapMutator set to handle it.
public Map<K ,V> removeComposited(Map <K ,V> map)
map - the Map to be removed from the composite
null if map is not in the composite
public void clear()
clear() on all composited Maps.
clear in interface
Map<K,V>
clear in interface
Put<K,V>
UnsupportedOperationException - if any of the composited Maps do not support clear()
Map.clear()
public boolean containsKey(Objectkey)
true if this map contains a mapping for the specified key. More formally, returns
true if and only if this map contains at a mapping for a key
k such that
(key==null ? k==null : key.equals(k)). (There can be at most one such mapping.)
containsKey in interface
Map<K,V>
containsKey in interface
Get<K,V>
key - key whose presence in this map is to be tested.
true if this map contains a mapping for the specified key.
ClassCastException - if the key is of an inappropriate type for this map (optional).
NullPointerException - if the key is
null and this map does not not permit
null keys (optional).
Map.containsKey(Object)
public boolean containsValue(Objectvalue)
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.
containsValue in interface
Map<K,V>
containsValue in interface
Get<K,V>
value - value whose presence in this map is to be tested.
true if this map maps one or more keys to the specified value.
ClassCastException - if the value is of an inappropriate type for this map (optional).
NullPointerException - if the value is
null and this map does not not permit
null values (optional).
Map.containsValue(Object)
public Set<Map .Entry <K ,V>> entrySet()
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.
This implementation returns a CompositeSet which composites the entry sets from all of the composited maps.
public V get(Objectkey)
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.
More formally, if this map contains a mapping from a key k to a value v such that (key==null ? k==null : key.equals(k)), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)
get in interface
Map<K,V>
get in interface
Get<K,V>
key - key whose associated value is to be returned.
null if the map contains no mapping for this key.
ClassCastException - if the key is of an inappropriate type for this map (optional).
NullPointerException - key is
null and this map does not not permit
null keys (optional).
containsKey(Object)
public boolean isEmpty()
true if this map contains no key-value mappings.
public Set<K> keySet()
Iterator.remove,
Set.remove,
removeAll
retainAll, and
clear operations. It does not support the add or
addAll operations.
This implementation returns a CompositeSet which composites the key sets from all of the composited maps.
public V put(K key, V value)
m is said to contain a mapping for a key
k if and only if
m.containsKey(k) would return
true.))
put in interface
Map<K,V>
put in interface
Put<K,V>
key - key with which the specified value is to be associated.
value - value to be associated with the specified key.
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.
UnsupportedOperationException - if no MapMutator has been specified
ClassCastException - if the class of the specified key or value prevents it from being stored in this map.
IllegalArgumentException - if some aspect of this key or value prevents it from being stored in this map.
NullPointerException - this map does not permit
null keys or values, and the specified key or value is
null.
Map.put(Object, Object)
public void putAll(Map<? extends K ,? extends V> map)
put(k, v) on this map once for each mapping from key
k to value
v in the specified map. The behavior of this operation is unspecified if the specified map is modified while the operation is in progress.
putAll in interface
Map<K,V>
putAll in interface
Put<K,V>
map - Mappings to be stored in this map.
UnsupportedOperationException - if the
putAll method is not supported by this map.
ClassCastException - if the class of a key or value in the specified map prevents it from being stored in this map.
IllegalArgumentException - some aspect of a key or value in the specified map prevents it from being stored in this map.
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.
Map.putAll(Map)
public V remove(Objectkey)
k to value
v such that
(key==null ? k==null : key.equals(k)), that mapping is removed. (The map can contain at most one such mapping.)
Returns the value to which the map previously associated the key, or null if the map contained no mapping for this key. (A null return can also indicate that the map previously associated null with the specified key if the implementation supports null values.) The map will not contain a mapping for the specified key once the call returns.
remove in interface
Map<K,V>
remove in interface
Get<K,V>
key - key whose mapping is to be removed from the map.
null if there was no mapping for key.
ClassCastException - if the key is of an inappropriate type for the composited map (optional).
NullPointerException - if the key is
null and the composited map does not not permit
null keys (optional).
UnsupportedOperationException - if the
remove method is not supported by the composited map containing the key
Map.remove(Object)
public int size()
Integer.MAX_VALUE elements, returns
Integer.MAX_VALUE.
public Collection<V> values()
Iterator.remove,
Collection.remove,
removeAll,
retainAll and
clear operations. It does not support the add or
addAll operations.
public boolean equals(Objectobj)
public int hashCode()