SortedBidiMap (Commons Collections 3.2.2 API)

All Superinterfaces:

BidiMap, IterableMap, Map, OrderedBidiMap, OrderedMap, SortedMap

All Known Implementing Classes:

AbstractSortedBidiMapDecorator, DualTreeBidiMap, UnmodifiableSortedBidiMap
```
public interface SortedBidiMap
extends OrderedBidiMap, 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:

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
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K extends Object,V extends Object>

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`BidiMap`	`inverseBidiMap()`	Gets a view of this map where the keys and values are reversed.
`SortedBidiMap`	`inverseSortedBidiMap()`	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.SortedMap
comparator, entrySet, firstKey, headMap, keySet, lastKey, subMap, tailMap, values

- Method Detail
  - inverseBidiMap
```
BidiMap 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
    
    Specified by:
    
    inverseBidiMap in interface OrderedBidiMap
    
    Returns:
    
    an inverted bidirectional map
  - inverseSortedBidiMap
```
SortedBidiMap inverseSortedBidiMap()
```
    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