Class UnmodifiableMultiValuedMap<K,V>
- Type Parameters:
K- the type of key elementsV- the type of value elements
- All Implemented Interfaces:
Serializable,MultiValuedMap<K,,V> Unmodifiable
MultiValuedMap to ensure it can't be altered.
Attempts to modify it will result in an UnsupportedOperationException.
- Since:
- 4.1
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionMap<K, Collection<V>> asMap()Returns a view of this multivalued map as aMapfrom each distinct key to the non-empty collection of that key's associated values.voidclear()Removes all of the mappings from this map (optional operation).entries()Returns aCollectionview of the mappings contained in this multivalued map.Gets a view collection of the values associated with the specified key.keys()Returns aMultiSetview of the keys contained in this multivalued map.keySet()Returns aSetview of the keys contained in this multivalued map.Obtains aMapIteratorover this multivalued map.booleanAdds a key-value mapping to this multivalued map.booleanCopies all mappings from the specified map to this multivalued map (optional operation).booleanAdds a mapping to the specified key for all values contained in the given Iterable.booleanputAll(MultiValuedMap<? extends K, ? extends V> map) Copies all mappings from the specified map to this multivalued map (optional operation).Removes all values associated with the specified key.booleanremoveMapping(Object key, Object item) Removes a key-value mapping from the map.static <K,V> UnmodifiableMultiValuedMap <K, V> unmodifiableMultiValuedMap(MultiValuedMap<? extends K, ? extends V> map) Factory method to create an unmodifiable MultiValuedMap.values()Gets aCollectionview of all values contained in this multivalued map.Methods inherited from class org.apache.commons.collections4.multimap.AbstractMultiValuedMapDecorator
containsKey, containsMapping, containsValue, decorated, equals, hashCode, isEmpty, size, toString
-
Method Details
-
unmodifiableMultiValuedMap
public static <K,V> UnmodifiableMultiValuedMap<K,V> unmodifiableMultiValuedMap(MultiValuedMap<? extends K, ? extends V> map) Factory method to create an unmodifiable MultiValuedMap.If the map passed in is already unmodifiable, it is returned.
- Type Parameters:
K- the type of key elementsV- the type of value elements- Parameters:
map- the map to decorate, may not be null- Returns:
- an unmodifiable MultiValuedMap
- Throws:
NullPointerException- if map is null
-
asMap
Description copied from interface:MultiValuedMapReturns a view of this multivalued map as aMapfrom each distinct key to the non-empty collection of that key's associated values.Note that
this.asMap().get(k)is equivalent tothis.get(k)only whenkis a key contained in the multivalued map; otherwise it returnsnullas opposed to an empty collection.Changes to the returned map or the collections that serve as its values will update the underlying multivalued map, and vice versa. The map does not support
putorputAll, nor do its entries supportsetValue.- Specified by:
asMapin interfaceMultiValuedMap<K,V> - Overrides:
asMapin classAbstractMultiValuedMapDecorator<K,V> - Returns:
- a map view of the mappings in this multivalued map
-
clear
Description copied from interface:MultiValuedMapRemoves all of the mappings from this map (optional operation).The map will be empty after this call returns.
- Specified by:
clearin interfaceMultiValuedMap<K,V> - Overrides:
clearin classAbstractMultiValuedMapDecorator<K,V>
-
entries
Description copied from interface:MultiValuedMapReturns aCollectionview of the mappings contained in this multivalued map.The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa.
- Specified by:
entriesin interfaceMultiValuedMap<K,V> - Overrides:
entriesin classAbstractMultiValuedMapDecorator<K,V> - Returns:
- a set view of the mappings contained in this map
-
get
Description copied from interface:MultiValuedMapGets a view collection of the values associated with the specified key.This method will return an empty collection if
MultiValuedMap.containsKey(Object)returnsfalse. Changes to the returned collection will update the underlyingMultiValuedMapand vice-versa.- Specified by:
getin interfaceMultiValuedMap<K,V> - Overrides:
getin classAbstractMultiValuedMapDecorator<K,V> - Parameters:
key- the key to retrieve- Returns:
- the
Collectionof values, implementations should return an empty collection for no mapping
-
keys
Description copied from interface:MultiValuedMapReturns aMultiSetview of the keys contained in this multivalued map.The
MultiSet.getCount(Object)method of the returned multiset will give the same result a callingget(Object).size()for the same key.This multiset is backed by the map, so any changes in the map are reflected in the multiset.
- Specified by:
keysin interfaceMultiValuedMap<K,V> - Overrides:
keysin classAbstractMultiValuedMapDecorator<K,V> - Returns:
- a multiset view of the keys contained in this map
-
keySet
Description copied from interface:MultiValuedMapReturns aSetview of the keys contained in this multivalued map.The set is backed by the map, so changes to the map are reflected in the set, and vice-versa.
If the map is modified while an iteration over the set is in progress (except through the iterator's own
removeoperation), the result of the iteration is undefined. The set supports element removal, which removes the corresponding mapping from the map, via theIterator.remove,Set.remove,removeAll,retainAll, andclearoperations. It does not support theaddoraddAlloperations.- Specified by:
keySetin interfaceMultiValuedMap<K,V> - Overrides:
keySetin classAbstractMultiValuedMapDecorator<K,V> - Returns:
- a set view of the keys contained in this map
-
mapIterator
Description copied from interface:MultiValuedMapObtains aMapIteratorover this multivalued map.A map iterator is an efficient way of iterating over maps. There is no need to access the entries collection or use
Map.Entryobjects.- Specified by:
mapIteratorin interfaceMultiValuedMap<K,V> - Overrides:
mapIteratorin classAbstractMultiValuedMapDecorator<K,V> - Returns:
- a map iterator
-
put
Description copied from interface:MultiValuedMapAdds a key-value mapping to this multivalued map.Unlike a normal
Mapthe previous value is not replaced. Instead, the new value is added to the collection stored against the key. Depending on the collection type used, duplicate key-value mappings may be allowed.The method will return
trueif the size of the multivalued map has been increased because of this operation.- Specified by:
putin interfaceMultiValuedMap<K,V> - Overrides:
putin classAbstractMultiValuedMapDecorator<K,V> - Parameters:
key- the key to store againstvalue- the value to add to the collection at the key- Returns:
- true if the map changed as a result of this put operation, or false if the map already contained the key-value mapping and the collection type does not allow duplicate values, for example when using a Set
-
putAll
Description copied from interface:MultiValuedMapAdds a mapping to the specified key for all values contained in the given Iterable.- Specified by:
putAllin interfaceMultiValuedMap<K,V> - Overrides:
putAllin classAbstractMultiValuedMapDecorator<K,V> - Parameters:
key- the key to store againstvalues- the values to add to the collection at the key, may not be null- Returns:
- true if the map changed as a result of this operation
-
putAll
Description copied from interface:MultiValuedMapCopies all mappings from the specified map to this multivalued map (optional operation).The effect of this call is equivalent to that of calling
put(k, v)on this map once for each mapping from keykto valuevin the specified map.The behavior of this operation is undefined if the specified map is modified while the operation is in progress.
- Specified by:
putAllin interfaceMultiValuedMap<K,V> - Overrides:
putAllin classAbstractMultiValuedMapDecorator<K,V> - Parameters:
map- mappings to be stored in this map, may not be null- Returns:
- true if the map changed as a result of this operation
-
putAll
Description copied from interface:MultiValuedMapCopies all mappings from the specified map to this multivalued map (optional operation).The effect of this call is equivalent to that of calling
put(k, v)on this map once for each mapping from keykto valuevin the specified map.The behavior of this operation is undefined if the specified map is modified while the operation is in progress.
- Specified by:
putAllin interfaceMultiValuedMap<K,V> - Overrides:
putAllin classAbstractMultiValuedMapDecorator<K,V> - Parameters:
map- mappings to be stored in this map, may not be null- Returns:
- true if the map changed as a result of this operation
-
remove
Description copied from interface:MultiValuedMapRemoves all values associated with the specified key.The returned collection may be modifiable, but updates will not be propagated to this multivalued map. In case no mapping was stored for the specified key, an empty, unmodifiable collection will be returned.
- Specified by:
removein interfaceMultiValuedMap<K,V> - Overrides:
removein classAbstractMultiValuedMapDecorator<K,V> - Parameters:
key- the key to remove values from- Returns:
- the values that were removed
-
removeMapping
Description copied from interface:MultiValuedMapRemoves a key-value mapping from the map.The item is removed from the collection mapped to the specified key. Other values attached to that key are unaffected.
If the last value for a key is removed, implementations typically return an empty collection from a subsequent
get(Object).- Specified by:
removeMappingin interfaceMultiValuedMap<K,V> - Overrides:
removeMappingin classAbstractMultiValuedMapDecorator<K,V> - Parameters:
key- the key to remove fromitem- the item to remove- Returns:
- true if the mapping was removed, false otherwise
-
values
Description copied from interface:MultiValuedMapGets aCollectionview of all values contained in this multivalued map.Implementations typically return a collection containing the combination of values from all keys.
- Specified by:
valuesin interfaceMultiValuedMap<K,V> - Overrides:
valuesin classAbstractMultiValuedMapDecorator<K,V> - Returns:
- a collection view of the values contained in this multivalued map
-