Class AbstractBidiMapDecorator<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> 
- Direct Known Subclasses:
- AbstractOrderedBidiMapDecorator,- UnmodifiableBidiMap
Methods are forwarded directly to the decorated map.
This implementation does not perform any special processing with the map views. Instead it simply returns the set/collection from the wrapped map. This may be undesirable, for example if you are trying to write a validating implementation it would provide a loophole around the validation. But, you might want that loophole, so this class is kept simple.
- Since:
- 3.0
- 
Nested Class Summary
- 
Constructor SummaryConstructorsModifierConstructorDescriptionprotectedAbstractBidiMapDecorator(BidiMap<K, V> map) Constructor that wraps (not copies).
- 
Method SummaryModifier and TypeMethodDescriptionGets the map being decorated.Gets the key that is currently mapped to the specified value.Gets a view of this map where the keys and values are reversed.Obtains aMapIteratorover the map.removeValue(Object value) Removes the key-value pair that is currently mapped to the specified value (optional operation).values()Gets a a collection view of the values contained in this map.Methods inherited from class org.apache.commons.collections4.map.AbstractMapDecoratorclear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, toStringMethods inherited from class java.lang.Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.collections4.GetcontainsKey, containsValue, entrySet, get, isEmpty, keySet, remove, sizeMethods inherited from interface java.util.Mapclear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size
- 
Constructor Details- 
AbstractBidiMapDecoratorConstructor that wraps (not copies).- Parameters:
- map- the map to decorate, must not be null
- Throws:
- NullPointerException- if the collection is null
 
 
- 
- 
Method Details- 
decorated
- 
getKeyDescription copied from interface:BidiMapGets the key that is currently mapped to the specified value.If the value is not contained in the map, nullis returned.Implementations should seek to make this method perform equally as well as get(Object).
- 
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> 
- Returns:
- an inverted bidirectional 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- AbstractIterableMap<K,- V> 
- Returns:
- a map iterator
 
- 
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> 
- 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.
 
-