Class AbstractOrderedBidiMapDecorator<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> - OrderedBidiMap<K,,- V> - OrderedMap<K,,- V> - Put<K,- V> 
- Direct Known Subclasses:
- AbstractSortedBidiMapDecorator,- UnmodifiableOrderedBidiMap
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 inverse 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 SummaryConstructorsModifierConstructorDescriptionprotectedConstructor that wraps (not copies).
- 
Method SummaryModifier and TypeMethodDescriptionprotected OrderedBidiMap<K, V> Gets the map being decorated.firstKey()Gets the first key currently in this map.Gets a view of this map where the keys and values are reversed.lastKey()Gets the last key currently in this map.Obtains aMapIteratorover the map.Gets the next key after the one specified.previousKey(K key) Gets the previous key before the one specified.Methods inherited from class org.apache.commons.collections4.bidimap.AbstractBidiMapDecoratorgetKey, removeValue, valuesMethods 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.BidiMapgetKey, put, removeValue, valuesMethods inherited from interface org.apache.commons.collections4.GetcontainsKey, containsValue, entrySet, get, isEmpty, keySet, remove, size, valuesMethods 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- 
AbstractOrderedBidiMapDecoratorConstructor that wraps (not copies).- Parameters:
- map- the map to decorate, must not be null
- Throws:
- NullPointerException- if the collection is null
 
 
- 
- 
Method Details- 
decoratedGets the map being decorated.- Overrides:
- decoratedin class- AbstractBidiMapDecorator<K,- V> 
- Returns:
- the decorated map
 
- 
firstKeyDescription copied from interface:OrderedMapGets the first key currently in this map.- Specified by:
- firstKeyin interface- OrderedMap<K,- V> 
- Returns:
- the first key currently 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> 
- Specified by:
- inverseBidiMapin interface- OrderedBidiMap<K,- V> 
- Overrides:
- inverseBidiMapin class- AbstractBidiMapDecorator<K,- V> 
- Returns:
- an inverted bidirectional map
 
- 
lastKeyDescription copied from interface:OrderedMapGets the last key currently in this map.- Specified by:
- lastKeyin interface- OrderedMap<K,- V> 
- Returns:
- the last key currently 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> 
- Specified by:
- mapIteratorin interface- OrderedMap<K,- V> 
- Overrides:
- mapIteratorin class- AbstractBidiMapDecorator<K,- V> 
- Returns:
- a map iterator
 
- 
nextKeyDescription copied from interface:OrderedMapGets the next key after the one specified.- Specified by:
- nextKeyin interface- OrderedMap<K,- V> 
- Parameters:
- key- the key to search for next from
- Returns:
- the next key, null if no match or at end
 
- 
previousKeyDescription copied from interface:OrderedMapGets the previous key before the one specified.- Specified by:
- previousKeyin interface- OrderedMap<K,- V> 
- Parameters:
- key- the key to search for previous from
- Returns:
- the previous key, null if no match or at start
 
 
-