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 mapV- 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 Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor only used in deserialization, do not use otherwise.protectedAbstractMapDecorator(Map<K, V> map) Constructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionvoidclear()booleancontainsKey(Object key) booleancontainsValue(Object value) Gets the map being decorated.entrySet()booleaninthashCode()booleanisEmpty()keySet()Note that the return type is Object, rather than V as in the Map interface.voidintsize()toString()values()Methods inherited from class org.apache.commons.collections4.map.AbstractIterableMap
mapIteratorMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
Constructor Details
-
AbstractMapDecorator
protected AbstractMapDecorator()Constructor only used in deserialization, do not use otherwise.- Since:
- 3.1
-
AbstractMapDecorator
Constructor that wraps (not copies).- Parameters:
map- the map to decorate, must not be null- Throws:
NullPointerException- if the map is null
-
-
Method Details
-
clear
- See Also:
-
containsKey
- 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:
-
containsValue
- 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
Gets the map being decorated.- Returns:
- the decorated map
-
entrySet
- Returns:
- a set view of the mappings contained in this map
- See Also:
-
equals
-
get
- Parameters:
key- the key whose associated value is to be returned- Returns:
- the value to which the specified key is mapped, or
nullif this map contains no mapping for the key - See Also:
-
hashCode
-
isEmpty
- Returns:
trueif this map contains no key-value mappings- See Also:
-
keySet
- Returns:
- a set view of the keys contained in this map
- See Also:
-
put
Description copied from interface:PutNote 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 associatedvalue- 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
- Parameters:
mapToCopy- mappings to be stored in this map- See Also:
-
remove
- Parameters:
key- key whose mapping is to be removed from the map- Returns:
- the previous value associated with
key, ornullif there was no mapping forkey. - See Also:
-
size
- Returns:
- the number of key-value mappings in this map
- See Also:
-
toString
-
values
- Returns:
- a collection view of the values contained in this map
- See Also:
-