org.apache.commons.collections.bidimap (Commons Collections 3.2.1 API)

Package org.apache.commons.collections.bidimap

This package contains implementations of the BidiMap, OrderedBidiMap and SortedBidiMap interfaces.

Class Summary
AbstractBidiMapDecorator	Provides a base decorator that enables additional functionality to be added to a BidiMap via decoration.
AbstractDualBidiMap	Abstract `BidiMap` implemented using two maps.
AbstractDualBidiMap.BidiMapIterator	Inner class MapIterator.
AbstractDualBidiMap.EntrySet	Inner class EntrySet.
AbstractDualBidiMap.EntrySetIterator	Inner class EntrySetIterator.
AbstractDualBidiMap.KeySet	Inner class KeySet.
AbstractDualBidiMap.KeySetIterator	Inner class KeySetIterator.
AbstractDualBidiMap.MapEntry	Inner class MapEntry.
AbstractDualBidiMap.Values	Inner class Values.
AbstractDualBidiMap.ValuesIterator	Inner class ValuesIterator.
AbstractDualBidiMap.View	Inner class View.
AbstractOrderedBidiMapDecorator	Provides a base decorator that enables additional functionality to be added to an OrderedBidiMap via decoration.
AbstractSortedBidiMapDecorator	Provides a base decorator that enables additional functionality to be added to a SortedBidiMap via decoration.
DualHashBidiMap	Implementation of `BidiMap` that uses two `HashMap` instances.
DualTreeBidiMap	Implementation of `BidiMap` that uses two `TreeMap` instances.
DualTreeBidiMap.BidiOrderedMapIterator	Inner class MapIterator.
DualTreeBidiMap.ViewMap	Internal sorted map view.
TreeBidiMap	Red-Black tree-based implementation of BidiMap where all objects added implement the `Comparable` interface.
UnmodifiableBidiMap	Decorates another `BidiMap` to ensure it can't be altered.
UnmodifiableOrderedBidiMap	Decorates another `OrderedBidiMap` to ensure it can't be altered.
UnmodifiableSortedBidiMap	Decorates another `SortedBidiMap` to ensure it can't be altered.

Class Summary

AbstractBidiMapDecorator

Provides a base decorator that enables additional functionality to be added to a BidiMap via decoration.

AbstractDualBidiMap

Abstract BidiMap implemented using two maps.

AbstractDualBidiMap.BidiMapIterator

Inner class MapIterator.

AbstractDualBidiMap.EntrySet

Inner class EntrySet.

AbstractDualBidiMap.EntrySetIterator

Inner class EntrySetIterator.

AbstractDualBidiMap.KeySet

Inner class KeySet.

AbstractDualBidiMap.KeySetIterator

Inner class KeySetIterator.

AbstractDualBidiMap.MapEntry

Inner class MapEntry.

AbstractDualBidiMap.Values

Inner class Values.

AbstractDualBidiMap.ValuesIterator

Inner class ValuesIterator.

AbstractDualBidiMap.View

Inner class View.

AbstractOrderedBidiMapDecorator

Provides a base decorator that enables additional functionality to be added to an OrderedBidiMap via decoration.

AbstractSortedBidiMapDecorator

Provides a base decorator that enables additional functionality to be added to a SortedBidiMap via decoration.

DualHashBidiMap

Implementation of BidiMap that uses two HashMap instances.

DualTreeBidiMap

Implementation of BidiMap that uses two TreeMap instances.

DualTreeBidiMap.BidiOrderedMapIterator

Inner class MapIterator.

DualTreeBidiMap.ViewMap

Internal sorted map view.

TreeBidiMap

Red-Black tree-based implementation of BidiMap where all objects added implement the Comparable interface.

UnmodifiableBidiMap

Decorates another BidiMap to ensure it can't be altered.

UnmodifiableOrderedBidiMap

Decorates another OrderedBidiMap to ensure it can't be altered.

UnmodifiableSortedBidiMap

Decorates another SortedBidiMap to ensure it can't be altered.

Package org.apache.commons.collections.bidimap Description:

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