org.apache.commons.collections4.multimap

Class AbstractListValuedMap<K,V>

java.lang.Object

org.apache.commons.collections4.multimap.AbstractMultiValuedMap<K,V>

org.apache.commons.collections4.multimap.AbstractListValuedMap<K,V>

All Implemented Interfaces:

ListValuedMap<K,V>, MultiValuedMap<K,V>

Direct Known Subclasses:

ArrayListValuedHashMap

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

Method Summary

Modifier and Type	Method and Description
java.util.List<V>	get(K key) Gets the list of values associated with the specified key.
java.util.List<V>	remove(java.lang.Object key) Removes all values associated with the specified key.

Methods inherited from class org.apache.commons.collections4.multimap.AbstractMultiValuedMap

asMap, clear, containsKey, containsMapping, containsValue, entries, equals, hashCode, isEmpty, keys, keySet, mapIterator, put, putAll, putAll, putAll, removeMapping, size, toString, values

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods 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

Method Detail

get

public java.util.List<V> get(K key)

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:

get in interface ListValuedMap<K,V>

Specified by:

get in interface MultiValuedMap<K,V>

Overrides:

get in class AbstractMultiValuedMap<K,V>

Parameters:

key - the key to retrieve

Returns:

the List of values, will return an empty List for no mapping

remove

public java.util.List<V> remove(java.lang.Object key)

Removes all values associated with the specified key.

A subsequent get(Object) would return an empty list.

Specified by:

remove in interface ListValuedMap<K,V>

Specified by:

remove in interface MultiValuedMap<K,V>

Overrides:

remove in class AbstractMultiValuedMap<K,V>

Parameters:

key - the key to remove values from

Returns:

the List of values removed, will return an empty, unmodifiable list for no mapping found.