Apache Commons Collections 4.4 · org.apache.commons.collections4.map.AbstractMapDecorator

Modifier and Type	Field and Description
pack-priv transient Map<K, V>	map The map to decorate

Access	Constructor and Description
protected	AbstractMapDecorator() Constructor only used in deserialization, do not use otherwise.
protected	AbstractMapDecorator(final Map<K, V> the map to decorate, must not be null map) Constructor that wraps (not copies).

Method Summary

Modifier and Type	Method and Description
public void	clear() Implements java.util.Map.clear, org.apache.commons.collections4.Put.clear. Removes all of the mappings from this map (optional operation).
public boolean	containsKey(final Object key whose presence in this map is to be tested key) Implements java.util.Map.containsKey, org.apache.commons.collections4.Get.containsKey. Returns `true` if this map contains a mapping for the specified key.
public boolean	containsValue(final Object value whose presence in this map is to be tested value) Implements java.util.Map.containsValue, org.apache.commons.collections4.Get.containsValue. Returns `true` if this map maps one or more keys to the specified value.
protected Map<K, V>	Returns: the decorated map decorated() Gets the map being decorated.
public Set<Map.Entry<K, V>>	entrySet() Implements java.util.Map.entrySet, org.apache.commons.collections4.Get.entrySet. Returns a `Set` view of the mappings contained in this map.
public boolean	equals(final Object object to be compared for equality with this map object) Overrides java.lang.Object.equals. Implements java.util.Map.equals. Compares the specified object with this map for equality.
public V	get(final Object the key whose associated value is to be returned key) Implements java.util.Map.get, org.apache.commons.collections4.Get.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
public int	hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Map.hashCode. Returns the hash code value for this map.
public boolean	isEmpty() Implements java.util.Map.isEmpty, org.apache.commons.collections4.Get.isEmpty. Returns `true` if this map contains no key-value mappings.
public Set<K>	keySet() Implements java.util.Map.keySet, org.apache.commons.collections4.Get.keySet. Returns a `Set` view of the keys contained in this map.
public V	put(final K key with which the specified value is to be associated key, final V value to be associated with the specified key value) Implements java.util.Map.put, org.apache.commons.collections4.Put.put. Associates the specified value with the specified key in this map (optional operation).
public void	putAll(final Map<? extends K, ? extends V> mappings to be stored in this map mapToCopy) Implements java.util.Map.putAll, org.apache.commons.collections4.Put.putAll. Copies all of the mappings from the specified map to this map (optional operation).
public V	remove(final Object key whose mapping is to be removed from the map key) Implements java.util.Map.remove, org.apache.commons.collections4.Get.remove. Removes the mapping for a key from this map if it is present (optional operation).
public int	size() Implements java.util.Map.size, org.apache.commons.collections4.Get.size. Returns the number of key-value mappings in this map.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public Collection<V>	values() Implements java.util.Map.values, org.apache.commons.collections4.Get.values. Returns a `Collection` view of the values contained in this map.

Inherited from org.apache.commons.collections4.map.AbstractIterableMap:: mapIterator

map	back to summary
pack-priv transient Map<K, V> map The map to decorate

AbstractMapDecorator	back to summary
protected AbstractMapDecorator() Constructor only used in deserialization, do not use otherwise. Since 3.1

AbstractMapDecorator	back to summary
protected AbstractMapDecorator(final Map<K, V> map) Constructor that wraps (not copies). Parameters map:Map<K, V> the map to decorate, must not be null Exceptions NullPointerException: if the map is null

Method Detail

clear	back to summary
public void clear() Implements java.util.Map.clear, org.apache.commons.collections4.Put.clear. Doc from java.util.Map.clear. Removes all of the mappings from this map (optional operation). The map will be empty after this call returns. Annotations @Override

clear

back to summary

public void clear()

Implements java.util.Map.clear, org.apache.commons.collections4.Put.clear.

Doc from java.util.Map.clear.

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Annotations

@Override

containsKey back to summary

containsKey	back to summary
public boolean containsKey(final Object key) Implements java.util.Map.containsKey, org.apache.commons.collections4.Get.containsKey. Doc from java.util.Map.containsKey. Returns `true` if this map contains a mapping for the specified key. More formally, returns `true` if and only if this map contains a mapping for a key `k` such that `Objects.equals(key, k)`. (There can be at most one such mapping.) Parameters key:Object key whose presence in this map is to be tested Returns:boolean `true` if this map contains a mapping for the specified key Annotations @Override

public boolean containsKey(final Object key)

Implements java.util.Map.containsKey, org.apache.commons.collections4.Get.containsKey.

Doc from java.util.Map.containsKey.

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that Objects.equals(key, k). (There can be at most one such mapping.)

Parameters

key:Object: key whose presence in this map is to be tested

Returns:boolean

true if this map contains a mapping for the specified key

Annotations

@Override

containsValue back to summary

containsValue	back to summary
public boolean containsValue(final Object value) Implements java.util.Map.containsValue, org.apache.commons.collections4.Get.containsValue. Doc from java.util.Map.containsValue. 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 `Objects.equals(value, v)`. This operation will probably require time linear in the map size for most implementations of the `Map` interface. Parameters value:Object value whose presence in this map is to be tested Returns:boolean `true` if this map maps one or more keys to the specified value Annotations @Override

public boolean containsValue(final Object value)

Implements java.util.Map.containsValue, org.apache.commons.collections4.Get.containsValue.

Doc from java.util.Map.containsValue.

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 Objects.equals(value, v). This operation will probably require time linear in the map size for most implementations of the Map interface.

Parameters

value:Object: value whose presence in this map is to be tested

Returns:boolean

true if this map maps one or more keys to the specified value

Annotations

@Override

decorated	back to summary
protected Map<K, V> decorated() Gets the map being decorated. Returns:Map<K, V> the decorated map

decorated

back to summary

protected Map<K, V> decorated()

Gets the map being decorated.

Returns:Map<K, V>: the decorated map

entrySet back to summary

entrySet	back to summary
public Set<Map.Entry<K, V>> entrySet() Implements java.util.Map.entrySet, org.apache.commons.collections4.Get.entrySet. Doc from java.util.Map.entrySet. Returns a `Set` 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 `remove` operation, or through the `setValue` 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 the `Iterator.remove`, `Set.remove`, `removeAll`, `retainAll` and `clear` operations. It does not support the `add` or `addAll` operations. Returns:Set<Map.Entry<K, V>> a set view of the mappings contained in this map Annotations @Override

public Set<Map.Entry<K, V>> entrySet()

Implements java.util.Map.entrySet, org.apache.commons.collections4.Get.entrySet.

Doc from java.util.Map.entrySet.

Returns a Set 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 remove operation, or through the setValue 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 the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Set<Map.Entry<K, V>>

a set view of the mappings contained in this map

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(final Object object) Overrides java.lang.Object.equals. Implements java.util.Map.equals. Doc from java.util.Map.equals. Compares the specified object with this map for equality. Returns `true` if the given object is also a map and the two maps represent the same mappings. More formally, two maps `m1` and `m2` represent the same mappings if `m1.entrySet().equals(m2.entrySet())`. This ensures that the `equals` method works properly across different implementations of the `Map` interface. Parameters object:Object object to be compared for equality with this map Returns:boolean `true` if the specified object is equal to this map Annotations @Override

public boolean equals(final Object object)

Overrides java.lang.Object.equals.

Implements java.util.Map.equals.

Doc from java.util.Map.equals.

Compares the specified object with this map for equality. Returns true if the given object is also a map and the two maps represent the same mappings. More formally, two maps m1 and m2 represent the same mappings if m1.entrySet().equals(m2.entrySet()). This ensures that the equals method works properly across different implementations of the Map interface.

Parameters

object:Object: object to be compared for equality with this map

Returns:boolean

true if the specified object is equal to this map

Annotations

@Override

get back to summary

get	back to summary
public V get(final Object key) Implements java.util.Map.get, org.apache.commons.collections4.Get.get. Doc from java.util.Map.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key. More formally, if this map contains a mapping from a key `k` to a value `v` such that `Objects.equals(key, k)`, then this method returns `v`; otherwise it returns `null`. (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 to `null`. The `containsKey` operation may be used to distinguish these two cases. Parameters key:Object the key whose associated value is to be returned Returns:V the value to which the specified key is mapped, or `null` if this map contains no mapping for the key Annotations @Override

public V get(final Object key)

Implements java.util.Map.get, org.apache.commons.collections4.Get.get.

Doc from java.util.Map.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that Objects.equals(key, k), then this method returns v; otherwise it returns null. (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 to null. The containsKey operation may be used to distinguish these two cases.

Parameters

key:Object: the key whose associated value is to be returned

Returns:V

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Map.hashCode. Doc from java.util.Map.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 `entrySet()` view. This ensures that `m1.equals(m2)` implies that `m1.hashCode()==m2.hashCode()` for any two maps `m1` and `m2`, as required by the general contract of `Object#hashCode`. Returns:int the hash code value for this map Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.util.Map.hashCode.

Doc from java.util.Map.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 entrySet() view. This ensures that m1.equals(m2) implies that m1.hashCode()==m2.hashCode() for any two maps m1 and m2, as required by the general contract of Object#hashCode.

Returns:int

the hash code value for this map

Annotations

@Override

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Implements java.util.Map.isEmpty, org.apache.commons.collections4.Get.isEmpty. Doc from java.util.Map.isEmpty. Returns `true` if this map contains no key-value mappings. Returns:boolean `true` if this map contains no key-value mappings Annotations @Override

public boolean isEmpty()

Implements java.util.Map.isEmpty, org.apache.commons.collections4.Get.isEmpty.

Doc from java.util.Map.isEmpty.

Returns true if this map contains no key-value mappings.

Returns:boolean

true if this map contains no key-value mappings

Annotations

@Override

keySet back to summary

keySet	back to summary
public Set<K> keySet() Implements java.util.Map.keySet, org.apache.commons.collections4.Get.keySet. Doc from java.util.Map.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 (except through the iterator's own `remove` operation), 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. Returns:Set<K> a set view of the keys contained in this map Annotations @Override

public Set<K> keySet()

Implements java.util.Map.keySet, org.apache.commons.collections4.Get.keySet.

Doc from java.util.Map.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 (except through the iterator's own remove operation), 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.

Returns:Set<K>

a set view of the keys contained in this map

Annotations

@Override

put back to summary

put	back to summary
public V put(final K key, final V value) Implements java.util.Map.put, org.apache.commons.collections4.Put.put. Doc from java.util.Map.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 map `m` is said to contain a mapping for a key `k` if and only if `m.containsKey(k)` would return `true`.) Parameters key:K key with which the specified value is to be associated value:V value to be associated with the specified key Returns:V the previous value associated with `key`, or `null` if there was no mapping for `key`. (A `null` return can also indicate that the map previously associated `null` with `key`, if the implementation supports `null` values.) Annotations @Override

public V put(final K key, final V value)

Implements java.util.Map.put, org.apache.commons.collections4.Put.put.

Doc from java.util.Map.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 map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)

Parameters

key:K: key with which the specified value is to be associated
value:V: value to be associated with the specified key

Returns:V

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

Annotations

@Override

putAll back to summary

putAll	back to summary
public void putAll(final Map<? extends K, ? extends V> mapToCopy) Implements java.util.Map.putAll, org.apache.commons.collections4.Put.putAll. Doc from java.util.Map.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 calling `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 undefined if the specified map is modified while the operation is in progress. If the specified map has a defined encounter order, processing of its mappings generally occurs in that order. Parameters mapToCopy:Map<? extends K, ? extends V> mappings to be stored in this map Annotations @Override

public void putAll(final Map<? extends K, ? extends V> mapToCopy)

Implements java.util.Map.putAll, org.apache.commons.collections4.Put.putAll.

Doc from java.util.Map.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 calling 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 undefined if the specified map is modified while the operation is in progress. If the specified map has a defined encounter order, processing of its mappings generally occurs in that order.

Parameters

mapToCopy:Map<? extends K, ? extends V>: mappings to be stored in this map

Annotations

@Override

remove back to summary

remove	back to summary
public V remove(final Object key) Implements java.util.Map.remove, org.apache.commons.collections4.Get.remove. Doc from java.util.Map.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 key `k` to value `v` such that `Objects.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 to `null`. The map will not contain a mapping for the specified key once the call returns. Parameters key:Object key whose mapping is to be removed from the map Returns:V the previous value associated with `key`, or `null` if there was no mapping for `key`. Annotations @Override

public V remove(final Object key)

Implements java.util.Map.remove, org.apache.commons.collections4.Get.remove.

Doc from java.util.Map.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 key k to value v such that Objects.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 to null.

The map will not contain a mapping for the specified key once the call returns.

Parameters

key:Object: key whose mapping is to be removed from the map

Returns:V

the previous value associated with key, or null if there was no mapping for key.

Annotations

@Override

size back to summary

size	back to summary
public int size() Implements java.util.Map.size, org.apache.commons.collections4.Get.size. Doc from java.util.Map.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`. Returns:int the number of key-value mappings in this map Annotations @Override

public int size()

Implements java.util.Map.size, org.apache.commons.collections4.Get.size.

Doc from java.util.Map.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.

Returns:int

the number of key-value mappings in this map

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

values back to summary

values	back to summary
public Collection<V> values() Implements java.util.Map.values, org.apache.commons.collections4.Get.values. Doc from java.util.Map.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 (except through the iterator's own `remove` operation), 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. Returns:Collection<V> a collection view of the values contained in this map Annotations @Override

public Collection<V> values()

Implements java.util.Map.values, org.apache.commons.collections4.Get.values.

Doc from java.util.Map.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 (except through the iterator's own remove operation), 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.

Returns:Collection<V>

a collection view of the values contained in this map

Annotations

@Override

public abstract Class AbstractMapDecorator<K, V>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail