Class UnmodifiableBidiMap<K,V> 
- Type Parameters:
- K- the type of the keys in this map
- V- the type of the values in this map
- All Implemented Interfaces:
- Map<K,,- V> - BidiMap<K,,- V> - Get<K,,- V> - IterableGet<K,,- V> - IterableMap<K,,- V> - Put<K,,- V> - Unmodifiable
BidiMap to ensure it can't be altered.
 Attempts to modify it will result in an UnsupportedOperationException.
- Since:
- 3.0
- 
Nested Class Summary
- 
Method SummaryModifier and TypeMethodDescriptionvoidclear()Removes all of the mappings from this map.entrySet()Gets a set view of the mappings contained in this map.Gets a view of this map where the keys and values are reversed.keySet()Gets a view of the keys contained in this map.Obtains aMapIteratorover the map.Associates the specified value with the specified key in this map.voidCopies all of the mappings from the specified map to this map.Remove a key-value mappings.removeValue(Object value) Removes the key-value pair that is currently mapped to the specified value (optional operation).static <K,V> BidiMap <K, V> unmodifiableBidiMap(BidiMap<? extends K, ? extends V> map) Factory method to create an unmodifiable map.values()Gets a a collection view of the values contained in this map.Methods inherited from class org.apache.commons.collections4.bidimap.AbstractBidiMapDecoratordecorated, getKeyMethods inherited from class org.apache.commons.collections4.map.AbstractMapDecoratorcontainsKey, containsValue, equals, get, hashCode, isEmpty, size, toStringMethods inherited from class java.lang.Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.collections4.GetcontainsKey, containsValue, get, isEmpty, sizeMethods inherited from interface java.util.Mapcompute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, size
- 
Method Details- 
unmodifiableBidiMapFactory method to create an unmodifiable map.If the map passed in is already unmodifiable, it is returned. - Type Parameters:
- K- the key type
- V- the value type
- Parameters:
- map- the map to decorate, must not be null
- Returns:
- an unmodifiable BidiMap
- Throws:
- NullPointerException- if map is null
- Since:
- 4.0
 
- 
clear
- 
entrySetDescription copied from interface:GetGets a set view of the mappings contained in this map.
- 
inverseBidiMapDescription copied from interface:BidiMapGets a view of this map where the keys and values are reversed.Changes to one map will be visible in the other and vice versa. This enables both directions of the map to be accessed as a Map.Implementations should seek to avoid creating a new object every time this method is called. See AbstractMap.values()etc. Calling this method on the inverse map should return the original.- Specified by:
- inverseBidiMapin interface- BidiMap<K,- V> 
- Overrides:
- inverseBidiMapin class- AbstractBidiMapDecorator<K,- V> 
- Returns:
- an inverted bidirectional map
 
- 
keySetDescription copied from interface:GetGets a view of the keys contained in this map.
- 
mapIteratorDescription copied from class:AbstractIterableMapObtains aMapIteratorover the map.A map iterator is an efficient way of iterating over maps. There is no need to access the entry set or use Map Entry objects. IterableMap<String,Integer> map = new HashedMap<String,Integer>(); MapIterator<String,Integer> it = map.mapIterator(); while (it.hasNext()) { String key = it.next(); Integer value = it.getValue(); it.setValue(value + 1); }- Specified by:
- mapIteratorin interface- IterableGet<K,- V> 
- Overrides:
- mapIteratorin class- AbstractBidiMapDecorator<K,- V> 
- Returns:
- a map iterator
 
- 
putDescription copied from interface:PutAssociates the specified value with the specified key in this map.Note that the return type is Object, rather than V as in the Map interface. See the class Javadoc for further info. - Specified by:
- putin interface- BidiMap<K,- V> 
- Specified by:
- putin interface- Map<K,- V> 
- Specified by:
- putin interface- Put<K,- V> 
- Overrides:
- putin class- AbstractMapDecorator<K,- V> 
- Parameters:
- key- key with which the specified value is to be associated
- value- value to be associated with the specified key
- Returns:
- the previous value associated with key, ornullif there was no mapping forkey. (Anullreturn can also indicate that the map previously associatednullwithkey, if the implementation supportsnullvalues.)
- See Also:
 
- 
putAllDescription copied from interface:PutCopies all of the mappings from the specified map to this map.
- 
removeDescription copied from interface:GetRemove a key-value mappings.- Specified by:
- removein interface- Get<K,- V> 
- Specified by:
- removein interface- Map<K,- V> 
- Overrides:
- removein class- AbstractMapDecorator<K,- V> 
- Parameters:
- key- key whose mapping is to be removed from the map
- Returns:
- the previous value associated with key, ornullif there was no mapping forkey.
- See Also:
 
- 
removeValueDescription copied from interface:BidiMapRemoves the key-value pair that is currently mapped to the specified value (optional operation).If the value is not contained in the map, nullis returned.Implementations should seek to make this method perform equally as well as remove(Object).- Specified by:
- removeValuein interface- BidiMap<K,- V> 
- Overrides:
- removeValuein class- AbstractBidiMapDecorator<K,- V> 
- Parameters:
- value- the value to find the key-value pair for
- Returns:
- the key that was removed, nullif nothing removed
 
- 
valuesDescription copied from interface:GetGets a a collection view of the values contained in this map.
 
-