Package org.apache.commons.collections

Interface SortedBidiMap

All Superinterfaces:

BidiMap, IterableMap, Map, OrderedBidiMap, OrderedMap, SequencedMap, SortedMap

All Known Implementing Classes:

AbstractSortedBidiMapDecorator, DualTreeBidiMap, UnmodifiableSortedBidiMap

@Deprecated(since="2021-04-30")
public interface SortedBidiMap
extends OrderedBidiMap, SortedMap

Deprecated.

Apache Commons Collections version 3.x is being deprecated from AEMaaCS. The upgraded version 4.4 of Commons Collections is already included as replacement. Customers are advised to upgrade to this version of the library. Please note: the package name was changed to org.apache.commons.collections4. Further note that there are AEM APIs currently exposing the old collections classes; these will be updated in upcoming releases.

Defines a map that allows bidirectional lookup between key and values and retains both keys and values in sorted order.

Implementations should allow a value to be looked up from a key and a key to be looked up from a value with equal performance.

Since:

Commons Collections 3.0

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method	Description
BidiMap	inverseBidiMap()	Deprecated. Gets a view of this map where the keys and values are reversed.
SortedBidiMap	inverseSortedBidiMap()	Deprecated. Gets a view of this map where the keys and values are reversed.

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 java.util.SortedMap

comparator, entrySet, firstKey, headMap, keySet, lastKey, putFirst, putLast, reversed, subMap, tailMap, values

Method Details

inverseBidiMap

BidiMap inverseBidiMap()

Deprecated.

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 equally.

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.

Implementations must return a SortedBidiMap instance, usually by forwarding to inverseSortedBidiMap().

Specified by:

inverseBidiMap in interface BidiMap

Specified by:

inverseBidiMap in interface OrderedBidiMap

Returns:

an inverted bidirectional map

inverseSortedBidiMap

SortedBidiMap inverseSortedBidiMap()

Deprecated.

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.

Returns:

an inverted bidirectional map