Class AbstractSortedBidiMapDecorator
- All Implemented Interfaces:
Map
,SequencedMap
,SortedMap
,BidiMap
,IterableMap
,OrderedBidiMap
,OrderedMap
,SortedBidiMap
- Direct Known Subclasses:
UnmodifiableSortedBidiMap
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:
- Commons Collections 3.0
- Version:
- $Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
- Author:
- Stephen Colebourne
-
Nested Class Summary
-
Field Summary
Fields inherited from class org.apache.commons.collections.map.AbstractMapDecorator
map
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionprotected SortedBidiMap
Gets the map being decorated.Gets a view of this map where the keys and values are reversed.Methods inherited from class org.apache.commons.collections.bidimap.AbstractOrderedBidiMapDecorator
firstKey, getOrderedBidiMap, inverseOrderedBidiMap, lastKey, nextKey, orderedMapIterator, previousKey
Methods inherited from class org.apache.commons.collections.bidimap.AbstractBidiMapDecorator
getBidiMap, getKey, inverseBidiMap, mapIterator, removeValue
Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator
clear, containsKey, containsValue, entrySet, equals, get, getMap, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.commons.collections.BidiMap
getKey, mapIterator, put, removeValue
Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size
Methods inherited from interface org.apache.commons.collections.OrderedBidiMap
inverseOrderedBidiMap
Methods inherited from interface org.apache.commons.collections.OrderedMap
firstKey, lastKey, nextKey, orderedMapIterator, previousKey
Methods inherited from interface java.util.SequencedMap
firstEntry, lastEntry, pollFirstEntry, pollLastEntry, sequencedEntrySet, sequencedKeySet, sequencedValues
Methods inherited from interface org.apache.commons.collections.SortedBidiMap
inverseBidiMap
-
Constructor Details
-
AbstractSortedBidiMapDecorator
Constructor that wraps (not copies).- Parameters:
map
- the map to decorate, must not be null- Throws:
IllegalArgumentException
- if the collection is null
-
-
Method Details
-
getSortedBidiMap
Gets the map being decorated.- Returns:
- the decorated map
-
inverseSortedBidiMap
Description copied from interface:SortedBidiMap
Gets 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
SortedMap
.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.The inverse map returned by
inverseBidiMap()
should be the same object as returned by this method.- Specified by:
inverseSortedBidiMap
in interfaceSortedBidiMap
- Returns:
- an inverted bidirectional map
-
comparator
- Specified by:
comparator
in interfaceSortedMap
-
subMap
-
headMap
-
tailMap
-