Top Description Methods
org.apache.commons.collections4

public Interface OrderedBidiMap<K, V>

extends BidiMap<K, V>, OrderedMap<K, V>
Known Direct Subinterfaces
org.apache.commons.collections4.SortedBidiMap
Known Direct Implementers
org.apache.commons.collections4.bidimap.AbstractOrderedBidiMapDecorator, org.apache.commons.collections4.bidimap.TreeBidiMap, org.apache.commons.collections4.bidimap.TreeBidiMap.Inverse
Type Parameters
<K>
the type of the keys in the map
<V>
the type of the values in the map

Defines a map that allows bidirectional lookup between key and values and retains and provides access to an ordering.

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 OrderedBidiMap<V, K>

Returns:

an inverted bidirectional map
inverseBidiMap
()

Redeclares org.apache.commons.collections4.BidiMap.inverseBidiMap.

Gets a view of this map where the keys and values are reversed.
Inherited from org.apache.commons.collections4.BidiMap:
getKeyputremoveValuevalues
Inherited from org.apache.commons.collections4.OrderedMap:
firstKeylastKeymapIteratornextKeypreviousKey

Method Detail

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

Redeclares org.apache.commons.collections4.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 an OrderedBidiMap instance, usually by forwarding to inverseOrderedBidiMap().

Returns:OrderedBidiMap<V, K>

an inverted bidirectional map

Annotations
@Override