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>, Map<K,V>, OrderedBidiMap<K,V>, OrderedMap<K,V>, Put<K,V>, SortedMap<K,V>
All Known Implementing Classes:
AbstractSortedBidiMapDecorator, DualTreeBidiMap, UnmodifiableSortedBidiMap

public interface SortedBidiMap<K,V>
extends OrderedBidiMap<K,V>, 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 1477779 2013-04-30 18:55:24Z tn $

Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Method Summary
 SortedBidiMap<V,K> inverseBidiMap()
          Gets a view of this map where the keys and values are reversed.
 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
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, putAll, remove, size, values
 
Methods inherited from interface org.apache.commons.collections4.Put
clear, putAll
 
Methods inherited from interface org.apache.commons.collections4.Get
containsKey, containsValue, entrySet, get, isEmpty, keySet, remove, size, values
 
Methods inherited from interface org.apache.commons.collections4.OrderedMap
firstKey, lastKey, mapIterator, nextKey, previousKey
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, putAll, remove, size, values
 
Methods inherited from interface org.apache.commons.collections4.Put
clear, putAll
 
Methods inherited from interface org.apache.commons.collections4.Get
containsKey, containsValue, entrySet, get, isEmpty, keySet, remove, size, values
 
Methods inherited from interface java.util.SortedMap
comparator, firstKey, headMap, lastKey, subMap, tailMap
 

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

Comparator<? super V> valueComparator()
Get the comparator used for the values in the value-to-key map aspect.

Returns:
Comparator


Copyright © 2001–2013 The Apache Software Foundation. All rights reserved.