## Uses of Interface
org.apache.commons.collections.BidiMap

- Packages that use BidiMap
  Package | Description
  --- | ---
  org.apache.commons.collections | This package contains the interfaces and utilities shared across all the subpackages of this component.
  org.apache.commons.collections.bidimap | This package contains implementations of the `BidiMap`, `OrderedBidiMap` and `SortedBidiMap` interfaces.

- - ### Uses of BidiMap in org.apache.commons.collections

    Subinterfaces of BidiMap in org.apache.commons.collections
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `OrderedBidiMap` Defines a map that allows bidirectional lookup between key and values and retains and provides access to an ordering.
    `interface` | `SortedBidiMap` Defines a map that allows bidirectional lookup between key and values and retains both keys and values in sorted order.

    Methods in org.apache.commons.collections that return BidiMap
    Modifier and Type | Method and Description
    --- | ---
    `BidiMap` | BidiMap.`inverseBidiMap()` Gets a view of this map where the keys and values are reversed.
    `BidiMap` | OrderedBidiMap.`inverseBidiMap()` Gets a view of this map where the keys and values are reversed.
    `BidiMap` | SortedBidiMap.`inverseBidiMap()` Gets a view of this map where the keys and values are reversed.

  - ### Uses of BidiMap in org.apache.commons.collections.bidimap

    Classes in org.apache.commons.collections.bidimap that implement BidiMap
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractBidiMapDecorator` Provides a base decorator that enables additional functionality to be added to a BidiMap via decoration.
    `class` | `AbstractDualBidiMap` Abstract `BidiMap` implemented using two maps.
    `class` | `AbstractOrderedBidiMapDecorator` Provides a base decorator that enables additional functionality to be added to an OrderedBidiMap via decoration.
    `class` | `AbstractSortedBidiMapDecorator` Provides a base decorator that enables additional functionality to be added to a SortedBidiMap via decoration.
    `class` | `DualHashBidiMap` Implementation of `BidiMap` that uses two `HashMap` instances.
    `class` | `DualTreeBidiMap` Implementation of `BidiMap` that uses two `TreeMap` instances.
    `class` | `TreeBidiMap` Red-Black tree-based implementation of BidiMap where all objects added implement the `Comparable` interface.
    `class` | `UnmodifiableBidiMap` Decorates another `BidiMap` to ensure it can't be altered.
    `class` | `UnmodifiableOrderedBidiMap` Decorates another `OrderedBidiMap` to ensure it can't be altered.
    `class` | `UnmodifiableSortedBidiMap` Decorates another `SortedBidiMap` to ensure it can't be altered.

    Fields in org.apache.commons.collections.bidimap declared as BidiMap
    Modifier and Type | Field and Description
    --- | ---
    `protected BidiMap` | AbstractDualBidiMap.`inverseBidiMap` Inverse view of this map.

    Methods in org.apache.commons.collections.bidimap that return BidiMap
    Modifier and Type | Method and Description
    --- | ---
    `protected abstract BidiMap` | AbstractDualBidiMap.`createBidiMap(Map normalMap, Map reverseMap, BidiMap inverseMap)` Creates a new instance of the subclass.
    `protected BidiMap` | DualHashBidiMap.`createBidiMap(Map normalMap, Map reverseMap, BidiMap inverseBidiMap)` Creates a new instance of this object.
    `protected BidiMap` | DualTreeBidiMap.`createBidiMap(Map normalMap, Map reverseMap, BidiMap inverseMap)` Creates a new instance of this object.
    `static BidiMap` | UnmodifiableBidiMap.`decorate(BidiMap map)` Factory method to create an unmodifiable map.
    `protected BidiMap` | AbstractBidiMapDecorator.`getBidiMap()` Gets the map being decorated.
    `BidiMap` | AbstractDualBidiMap.`inverseBidiMap()`
    `BidiMap` | UnmodifiableBidiMap.`inverseBidiMap()`
    `BidiMap` | TreeBidiMap.`inverseBidiMap()` Gets the inverse map for comparison.
    `BidiMap` | AbstractBidiMapDecorator.`inverseBidiMap()`
    `BidiMap` | UnmodifiableSortedBidiMap.`inverseBidiMap()`
    `BidiMap` | UnmodifiableOrderedBidiMap.`inverseBidiMap()`

    Methods in org.apache.commons.collections.bidimap with parameters of type BidiMap
    Modifier and Type | Method and Description
    --- | ---
    `protected abstract BidiMap` | AbstractDualBidiMap.`createBidiMap(Map normalMap, Map reverseMap, BidiMap inverseMap)` Creates a new instance of the subclass.
    `protected BidiMap` | DualHashBidiMap.`createBidiMap(Map normalMap, Map reverseMap, BidiMap inverseBidiMap)` Creates a new instance of this object.
    `protected BidiMap` | DualTreeBidiMap.`createBidiMap(Map normalMap, Map reverseMap, BidiMap inverseMap)` Creates a new instance of this object.
    `static BidiMap` | UnmodifiableBidiMap.`decorate(BidiMap map)` Factory method to create an unmodifiable map.

    Constructors in org.apache.commons.collections.bidimap with parameters of type BidiMap
    Constructor and Description
    `AbstractBidiMapDecorator(BidiMap map)` Constructor that wraps (not copies).
    `AbstractDualBidiMap(Map normalMap, Map reverseMap, BidiMap inverseBidiMap)` Constructs a map that decorates the specified maps, used by the subclass `createBidiMap` implementation.
    `DualHashBidiMap(Map normalMap, Map reverseMap, BidiMap inverseBidiMap)` Constructs a `HashBidiMap` that decorates the specified maps.
    `DualTreeBidiMap(Map normalMap, Map reverseMap, BidiMap inverseBidiMap)` Constructs a `DualTreeBidiMap` that decorates the specified maps.

Copyright © 2001–2015 The Apache Software Foundation. All rights reserved.