Class AbstractMapDecorator<K,V> 
java.lang.Object
org.apache.commons.collections4.map.AbstractIterableMap<K,V>
 
org.apache.commons.collections4.map.AbstractMapDecorator<K,V> 
- Type Parameters:
- K- the type of the keys in the map
- V- the type of the values in the map
- All Implemented Interfaces:
- Map<K,,- V> - Get<K,,- V> - IterableGet<K,,- V> - IterableMap<K,,- V> - Put<K,- V> 
- Direct Known Subclasses:
- AbstractBidiMapDecorator,- AbstractOrderedMapDecorator,- AbstractSortedMapDecorator,- DefaultedMap,- FixedSizeMap,- LazyMap,- ListOrderedMap,- MultiKeyMap,- MultiValueMap,- PassiveExpiringMap,- PredicatedMap,- TransformedMap,- UnmodifiableMap
Provides a base decorator that enables additional functionality to be added
 to a Map via decoration.
 
Methods are forwarded directly to the decorated map.
 This implementation does not perform any special processing with
 entrySet(), keySet() or values(). Instead
 it simply returns the set/collection from the wrapped map. This may be
 undesirable, for example if you are trying to write a validating
 implementation it would provide a loophole around the validation.
 But, you might want that loophole, so this class is kept simple.
 
- Since:
- 3.0
- 
Nested Class Summary
- 
Constructor SummaryConstructorsModifierConstructorDescriptionprotectedConstructor only used in deserialization, do not use otherwise.protectedAbstractMapDecorator(Map<K, V> map) Constructor that wraps (not copies).
- 
Method SummaryModifier and TypeMethodDescriptionvoidclear()Removes all of the mappings from this map.booleancontainsKey(Object key) Tests for presence of a given key.booleancontainsValue(Object value) Tests for presence of a given value.Gets the map being decorated.entrySet()Gets a set view of the mappings contained in this map.booleanGets a value at a given key.inthashCode()booleanisEmpty()Tests whether this instance contains any key-value mappings.keySet()Gets a view of the keys contained in this map.Associates the specified value with the specified key in this map.voidCopies all of the mappings from the specified map to this map.Remove a key-value mappings.intsize()Gets the number of key-value mappings in this map.toString()values()Gets a a collection view of the values contained in this map.Methods inherited from class org.apache.commons.collections4.map.AbstractIterableMapmapIteratorMethods inherited from class java.lang.Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Mapcompute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
- 
Constructor Details- 
AbstractMapDecoratorprotected AbstractMapDecorator()Constructor only used in deserialization, do not use otherwise.- Since:
- 3.1
 
- 
AbstractMapDecoratorConstructor that wraps (not copies).- Parameters:
- map- the map to decorate, must not be null
- Throws:
- NullPointerException- if the map is null
 
 
- 
- 
Method Details- 
clear
- 
containsKeyDescription copied from interface:GetTests for presence of a given key.- Parameters:
- key- key whose presence in this map is to be tested
- Returns:
- trueif this map contains a mapping for the specified key
- See Also:
 
- 
containsValueDescription copied from interface:GetTests for presence of a given value.- Parameters:
- value- value whose presence in this map is to be tested
- Returns:
- trueif this map maps one or more keys to the specified value
- See Also:
 
- 
decorated
- 
entrySet
- 
equals
- 
get
- 
hashCode
- 
isEmpty
- 
keySet
- 
putDescription copied from interface:PutAssociates the specified value with the specified key in this map.Note that the return type is Object, rather than V as in the Map interface. See the class Javadoc for further info. - Parameters:
- key- key with which the specified value is to be associated
- value- value to be associated with the specified key
- Returns:
- the previous value associated with key, ornullif there was no mapping forkey. (Anullreturn can also indicate that the map previously associatednullwithkey, if the implementation supportsnullvalues.)
- See Also:
 
- 
putAll
- 
remove
- 
size
- 
toString
- 
valuesDescription copied from interface:GetGets a a collection view of the values contained in this map.- Returns:
- a collection view of the values contained in this map.
- See Also:
 
 
-