Top Description Methods
org.apache.commons.collections4

public Interface SortedBidiMap<K, V>

extends OrderedBidiMap<K, V>, SortedMap<K, V>
Known Direct Implementers
org.apache.commons.collections4.bidimap.AbstractSortedBidiMapDecorator, org.apache.commons.collections4.bidimap.DualTreeBidiMap
Type Parameters
<K>
the type of the keys in the map
<V>
the type of the values in the map
Imports
java.util.Comparator, .SortedMap

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

Method Summary

Modifier and TypeMethod and Description
public SortedBidiMap<V, K>

Returns:

an inverted bidirectional map
inverseBidiMap
()

Redeclares org.apache.commons.collections4.OrderedBidiMap.inverseBidiMap.

Gets a view of this map where the keys and values are reversed.
public Comparator<? super V>

Returns:

Comparator<? super V>
valueComparator
()

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

Inherited from java.util.SortedMap:
comparatorentrySetfirstKeyheadMapkeySetlastKeyputFirstputLastreversedsubMaptailMapvalues

Method Detail

inverseBidiMapback to summary
public SortedBidiMap<V, K> inverseBidiMap()

Redeclares org.apache.commons.collections4.OrderedBidiMap.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().

Returns:SortedBidiMap<V, K>

an inverted bidirectional map

Annotations
@Override
valueComparatorback to summary
public Comparator<? super V> valueComparator()

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

Returns:Comparator<? super V>

Comparator<? super V>