org.apache.commons.collections
Interface SortedBidiMap
- BidiMap, IterableMap, Map, OrderedBidiMap, OrderedMap, SortedMap
- AbstractSortedBidiMapDecorator, DualTreeBidiMap, UnmodifiableSortedBidiMap
public interface SortedBidiMap
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.
$Revision: 1.6 $ $Date: 2004/02/18 01:15:42 $
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()
.
- inverseBidiMap in interface OrderedBidiMap
- inverseBidiMap in interface BidiMap
- an inverted bidirectional map
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.
- an inverted bidirectional map
Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.