Package org.apache.commons.collections4

Interface SortedBidiMap<K,V>

Type Parameters:

K - the type of the keys in the map

V - the type of the values in the map

All Superinterfaces:

BidiMap<K,V>, Get<K,V>, IterableGet<K,V>, IterableMap<K,V>, java.util.Map<K,V>, OrderedBidiMap<K,V>, OrderedMap<K,V>, Put<K,V>, java.util.SortedMap<K,V>

All Known Implementing Classes:

AbstractSortedBidiMapDecorator, DualTreeBidiMap, UnmodifiableSortedBidiMap

public interface SortedBidiMap<K,V>
extends OrderedBidiMap<K,V>, java.util.SortedMap<K,V>

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:

3.0

Version:

$Id: SortedBidiMap.java 1543255 2013-11-19 00:45:24Z ggregory $

Nested Class Summary

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

java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Method Summary

Modifier and Type	Method	Description
SortedBidiMap<V,K>	inverseBidiMap()	Gets a view of this map where the keys and values are reversed.
java.util.Comparator<? super V>	valueComparator()	Get the comparator used for the values in the value-to-key map aspect.

Methods inherited from interface org.apache.commons.collections4.BidiMap

getKey, put, removeValue, values

Methods inherited from interface org.apache.commons.collections4.Get

containsKey, containsValue, entrySet, get, isEmpty, keySet, remove, size

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entry, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, of, of, of, of, of, of, of, of, of, of, of, ofEntries, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size

Methods inherited from interface org.apache.commons.collections4.OrderedMap

firstKey, lastKey, mapIterator, nextKey, previousKey

Methods inherited from interface org.apache.commons.collections4.Put

clear, putAll

Methods inherited from interface java.util.SortedMap

comparator, entrySet, firstKey, headMap, keySet, lastKey, subMap, tailMap, values

Method Detail

inverseBidiMap

SortedBidiMap<V,K> inverseBidiMap()

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<K,V>

Specified by:

inverseBidiMap in interface OrderedBidiMap<K,V>

Returns:

an inverted bidirectional map

valueComparator

java.util.Comparator<? super V> valueComparator()

Get the comparator used for the values in the value-to-key map aspect.

Returns:

Comparator