Interface SetValuedMap<K,V> 
- Type Parameters:
- K- the type of the keys in this map
- V- the type of the values in this map
- All Superinterfaces:
- MultiValuedMap<K,- V> 
- All Known Implementing Classes:
- AbstractSetValuedMap,- HashSetValuedHashMap,- LinkedHashSetValuedLinkedHashMap
Defines a map that holds a set of values against each key.
 
 A SetValuedMap is a Map with slightly different semantics:
 
- Since:
- 4.1
- 
Method SummaryMethods inherited from interface org.apache.commons.collections4.MultiValuedMapasMap, clear, containsKey, containsMapping, containsValue, entries, isEmpty, keys, keySet, mapIterator, put, putAll, putAll, putAll, removeMapping, size, values
- 
Method Details- 
getGets the set of values associated with the specified key.Implementations typically return an empty Setif no values have been mapped to the key.- Specified by:
- getin interface- MultiValuedMap<K,- V> 
- Parameters:
- key- the key to retrieve
- Returns:
- the Setof values, implementations should return an emptySetfor no mapping
- Throws:
- NullPointerException- if the key is null and null keys are invalid
 
- 
removeRemoves all values associated with the specified key.The returned set may be modifiable, but updates will not be propagated to this set-valued map. In case no mapping was stored for the specified key, an empty, unmodifiable set will be returned. - Specified by:
- removein interface- MultiValuedMap<K,- V> 
- Parameters:
- key- the key to remove values from
- Returns:
- the Setof values removed, implementations should return null for no mapping found, but may return an empty collection
- Throws:
- UnsupportedOperationException- if the map is unmodifiable
- NullPointerException- if the key is null and null keys are invalid
 
 
-