java.lang.Object | +--org.apache.commons.collections.map.CompositeMapAll Implemented Interfaces:
Create a new, empty, CompositeMap. |
CompositeMap(Map one, Map two) Create a new CompositeMap with two composited Map instances. |
CompositeMap(Map one, Map two, CompositeMap.MapMutator mutator) Create a new CompositeMap with two composited Map instances. |
CompositeMap(Map[] composite) Create a new CompositeMap which composites all of the Map instances in the argument. |
CompositeMap(Map[] composite, CompositeMap.MapMutator mutator) Create a new CompositeMap which composites all of the Map instances in the argument. |
synchronized void | addComposited(Map map) Add an additional Map to the composite. |
void | clear() Calls clear() on all composited Maps. |
boolean | containsKey(Object key) Returns true if this map contains a mapping for the specified key. |
boolean | containsValue(Object value) 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 obj) Checks if this Map equals another as per the Map specification. |
Object | get(Object key) 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. |
Object | put(Object key, Object value) Associates the specified value with the specified key in this map (optional operation). |
void | putAll(Map map) Copies all of the mappings from the specified map to this map (optional operation). |
Object | remove(Object key) Removes the mapping for this key from this map if it is present (optional operation). |
synchronized Map | removeComposited(Map map) Remove a Map from the composite. |
void | setMutator(CompositeMap.MapMutator mutator) 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. |
public CompositeMap()
public CompositeMap(Map one, Map two, CompositeMap.MapMutator mutator)
public CompositeMap(Map one, Map two)
- if there is a key collisionpublic CompositeMap(Map[] composite, CompositeMap.MapMutator mutator)
public CompositeMap(Map[] composite)
- if there is a key collisionpublic synchronized void addComposited(Map map)
- if there is a key collision and there is no
MapMutator set to handle it.public void clear()
clear()
on all composited Maps.
- if any of the composited Maps do not support clear()public boolean containsKey(Object key)
- if the key is of an inappropriate type for
this map (optional).
- if the key is null and this map
does not not permit null keys (optional).public boolean containsValue(Object value)
- if the value is of an inappropriate type for
this map (optional).
- if the value is null and this map
does not not permit null values (optional).public Set 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.
CompositeSet
public boolean equals(Object obj)
public Object get(Object key)
- if the key is of an inappropriate type for
this map (optional).
- key is null and this map does not
not permit null keys (optional).containsKey(Object)
public int hashCode()
public boolean isEmpty()
public Set keySet()
CompositeSet
which
composites the key sets from all of the composited maps.
public Object put(Object key, Object value)
- if no MapMutator has been specified
- if the class of the specified key or value
prevents it from being stored in this map.
- if some aspect of this key or value
prevents it from being stored in this map.
- this map does not permit null
keys or values, and the specified key or value is
null.public void putAll(Map map)
- if the putAll method is
not supported by this map.
- if the class of a key or value in the
specified map prevents it from being stored in this map.
- some aspect of a key or value in the
specified map prevents it from being stored in this map.
- 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.public Object remove(Object key)
(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.
- if the key is of an inappropriate type for
the composited map (optional).
- if the key is null and the composited map
does not not permit null keys (optional).
- if the remove method is
not supported by the composited map containing the keypublic synchronized Map removeComposited(Map map)
public void setMutator(CompositeMap.MapMutator mutator)
public int size()
public Collection values()