Package org.apache.commons.collections.bidimap

This package contains implementations of the BidiMap, OrderedBidiMap and SortedBidiMap interfaces. A BidiMap is an extension to Map that allows keys and values to be looked up with equal ease. One example usage is a system communicating to a legacy datasource that must convert codes from the new format to the old format and vice versa.

The following implementations are provided in the package:

  • DualHashBidiMap - uses two HashMaps to implement BidiMap
  • DualTreeBidiMap - uses two TreeMaps to implement SortedBidiMap
  • TreeBidiMap - red-black tree implementation of OrderedBidiMap

The following decorators are provided in the package:

  • Unmodifiable - ensures the map cannot be altered