org.apache.commons.collections4.map

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:

java.util.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

public abstract class AbstractMapDecorator<K,V>
extends AbstractIterableMap<K,V>

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

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<K,V>>	entrySet()
boolean	equals(java.lang.Object object)
V	get(java.lang.Object key)
int	hashCode()
boolean	isEmpty()
java.util.Set<K>	keySet()
V	put(K key, V value) Note that the return type is Object, rather than V as in the Map interface.
void	putAll(java.util.Map<? extends K,? extends V> mapToCopy)
V	remove(java.lang.Object key)
int	size()
java.lang.String	toString()
java.util.Collection<V>	values()

Methods inherited from class org.apache.commons.collections4.map.AbstractIterableMap

mapIterator

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Method Detail

clear

public void clear()

See Also:

Map.clear()

containsKey

public boolean containsKey(java.lang.Object key)

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(java.lang.Object value)

See Also:

Map.containsValue(Object)

entrySet

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

See Also:

Map.entrySet()

get

public V get(java.lang.Object key)

See Also:

Map.get(Object)

isEmpty

public boolean isEmpty()

See Also:

Map.isEmpty()

keySet

public java.util.Set<K> keySet()

See Also:

Map.keySet()

put

public V put(K key,
             V value)

Description copied from interface: Put

Note that the return type is Object, rather than V as in the Map interface. See the class Javadoc for further info.

See Also:

Map.put(Object, Object)

putAll

public void putAll(java.util.Map<? extends K,? extends V> mapToCopy)

See Also:

Map.putAll(Map)

remove

public V remove(java.lang.Object key)

See Also:

Map.remove(Object)

size

public int size()

See Also:

Map.size()

values

public java.util.Collection<V> values()

See Also:

Map.values()

equals

public boolean equals(java.lang.Object object)

Specified by:

equals in interface java.util.Map<K,V>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map<K,V>

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object