SortedBidiMap documentation

FRAMES NO FRAMES SUMMARY: NESTED CONSTR ENUM FIELD METHOD ELEMENT

DETAIL: FIELD CONSTR ENUM METHOD ELEMENT

org.apache.commons.collections

Interface SortedBidiMap

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.

SinceCommons Co

Version$Revision:

AuthorStephen Colebourne

Wiki javadoc Use textile entry format.

Add your comments here.

Method Summary
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 org.apache.commons.collectionsBidiMap
getKey (Object) mapIterator () put (Object, Object) removeValue (Object)

Methods inherited from org.apache.commons.collectionsIterableMap
mapIterator ()

Methods inherited from java.utilMap
clear () containsKey (Object) containsValue (Object) entrySet () equals (Object) get (Object) hashCode () isEmpty () keySet () put (Object, Object) putAll (Map) remove (Object) size () values ()

Methods inherited from org.apache.commons.collectionsOrderedBidiMap
inverseOrderedBidiMap ()

Methods inherited from org.apache.commons.collectionsOrderedMap
firstKey () lastKey () nextKey (Object) orderedMapIterator () previousKey (Object)

Methods inherited from java.utilSortedMap
comparator () firstKey () headMap (Object) lastKey () subMap (Object, Object) tailMap (Object)

Method Detail

inverseBidiMap

public 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().

Implements method in BidiMap

Wiki javadoc Use textile entry format.

Add your comments here.

inverseSortedBidiMap

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

Wiki javadoc Use textile entry format.

Add your comments here.