Class AbstractListValuedMap<K,V>
java.lang.Object
org.apache.commons.collections4.multimap.AbstractMultiValuedMap<K,V>
org.apache.commons.collections4.multimap.AbstractListValuedMap<K,V>
- Type Parameters:
K- the type of the keys in this mapV- the type of the values in this map
- All Implemented Interfaces:
ListValuedMap<K,,V> MultiValuedMap<K,V>
- Direct Known Subclasses:
ArrayListValuedHashMap,ArrayListValuedLinkedHashMap
public abstract class AbstractListValuedMap<K,V>
extends AbstractMultiValuedMap<K,V>
implements ListValuedMap<K,V>
Abstract implementation of the
ListValuedMap interface to simplify
the creation of subclass implementations.
Subclasses specify a Map implementation to use as the internal storage and the List implementation to use as values.
- Since:
- 4.1
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor needed for subclass serialization.protectedAbstractListValuedMap(Map<K, ? extends List<V>> map) A constructor that wraps, not copies -
Method Summary
Modifier and TypeMethodDescriptionCreates a new value collection using the provided factory.Gets the list of values associated with the specified key.getMap()Gets the map being wrapped.Removes all values associated with the specified key.Methods inherited from class org.apache.commons.collections4.multimap.AbstractMultiValuedMap
asMap, clear, containsKey, containsMapping, containsValue, doReadObject, doWriteObject, entries, equals, hashCode, isEmpty, keys, keySet, mapIterator, put, putAll, putAll, putAll, removeMapping, setMap, size, toString, valuesMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.collections4.MultiValuedMap
asMap, clear, containsKey, containsMapping, containsValue, entries, isEmpty, keys, keySet, mapIterator, put, putAll, putAll, putAll, removeMapping, size, values
-
Constructor Details
-
AbstractListValuedMap
protected AbstractListValuedMap()Constructor needed for subclass serialization. -
AbstractListValuedMap
A constructor that wraps, not copies- Parameters:
map- the map to wrap, must not be null- Throws:
NullPointerException- if the map is null
-
-
Method Details
-
createCollection
Creates a new value collection using the provided factory.- Specified by:
createCollectionin classAbstractMultiValuedMap<K,V> - Returns:
- a new list
-
get
Gets the list of values associated with the specified key. This would return an empty list in case the mapping is not present- Specified by:
getin interfaceListValuedMap<K,V> - Specified by:
getin interfaceMultiValuedMap<K,V> - Overrides:
getin classAbstractMultiValuedMap<K,V> - Parameters:
key- the key to retrieve- Returns:
- the
Listof values, will return an emptyListfor no mapping
-
getMap
Description copied from class:AbstractMultiValuedMapGets the map being wrapped.- Overrides:
getMapin classAbstractMultiValuedMap<K,V> - Returns:
- the wrapped map
-
remove
Removes all values associated with the specified key.A subsequent
get(Object)would return an empty list.- Specified by:
removein interfaceListValuedMap<K,V> - Specified by:
removein interfaceMultiValuedMap<K,V> - Overrides:
removein classAbstractMultiValuedMap<K,V> - Parameters:
key- the key to remove values from- Returns:
- the
Listof values removed, will return an empty, unmodifiable list for no mapping found.
-