public interface

OrderedBidiMap

implements BidiMap OrderedMap
org.apache.commons.collections.OrderedBidiMap
Known Indirect Subclasses

Class Overview

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.

Summary

Public Methods
abstract BidiMap inverseBidiMap()
Gets a view of this map where the keys and values are reversed.
abstract OrderedBidiMap inverseOrderedBidiMap()
Gets a view of this map where the keys and values are reversed.
[Expand]
Inherited Methods
From interface java.util.Map
From interface org.apache.commons.collections.BidiMap
From interface org.apache.commons.collections.IterableMap
From interface org.apache.commons.collections.OrderedMap

Public Methods

public abstract 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
  • an inverted bidirectional map

public abstract OrderedBidiMap inverseOrderedBidiMap ()

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.

Returns
  • an inverted bidirectional map