## Uses of Interface
org.apache.commons.collections4.OrderedMap

- Packages that use OrderedMap
  Package | Description
  --- | ---
  org.apache.commons.collections4 | This package contains the interfaces and utilities shared across all the subpackages of this component.
  org.apache.commons.collections4.bidimap | This package contains implementations of the `BidiMap`, `OrderedBidiMap` and `SortedBidiMap` interfaces.
  org.apache.commons.collections4.map | This package contains implementations of the `Map`, `IterableMap`, `OrderedMap` and `SortedMap` interfaces.
  org.apache.commons.collections4.trie | This package contains implementations of the `Trie` interface.

- - ### Uses of OrderedMap in org.apache.commons.collections4

    Subinterfaces of OrderedMap in org.apache.commons.collections4
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `IterableSortedMap<K,V>` `SortedMap` + `OrderedMap`.
    `interface` | `OrderedBidiMap<K,V>` Defines a map that allows bidirectional lookup between key and values and retains and provides access to an ordering.
    `interface` | `SortedBidiMap<K,V>` Defines a map that allows bidirectional lookup between key and values and retains both keys and values in sorted order.
    `interface` | `Trie<K,V>` Defines the interface for a prefix tree, an ordered tree data structure.

    Methods in org.apache.commons.collections4 that return OrderedMap
    Modifier and Type | Method and Description
    --- | ---
    `static <K,V> OrderedMap<K,V>` | MapUtils.`orderedMap(Map<K,V> map)` Returns a map that maintains the order of keys that are added backed by the given map.

  - ### Uses of OrderedMap in org.apache.commons.collections4.bidimap

    Classes in org.apache.commons.collections4.bidimap that implement OrderedMap
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractOrderedBidiMapDecorator<K,V>` Provides a base decorator that enables additional functionality to be added to an OrderedBidiMap via decoration.
    `class` | `AbstractSortedBidiMapDecorator<K,V>` Provides a base decorator that enables additional functionality to be added to a SortedBidiMap via decoration.
    `class` | `DualTreeBidiMap<K,V>` Implementation of `BidiMap` that uses two `TreeMap` instances.
    `protected static class` | `DualTreeBidiMap.ViewMap<K,V>` Internal sorted map view.
    `class` | `TreeBidiMap<K extends Comparable<K>,V extends Comparable<V>>` Red-Black tree-based implementation of BidiMap where all objects added implement the `Comparable` interface.
    `class` | `UnmodifiableOrderedBidiMap<K,V>` Decorates another `OrderedBidiMap` to ensure it can't be altered.
    `class` | `UnmodifiableSortedBidiMap<K,V>` Decorates another `SortedBidiMap` to ensure it can't be altered.

  - ### Uses of OrderedMap in org.apache.commons.collections4.map

    Classes in org.apache.commons.collections4.map that implement OrderedMap
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractLinkedMap<K,V>` An abstract implementation of a hash-based map that links entries to create an ordered map and which provides numerous points for subclasses to override.
    `class` | `AbstractOrderedMapDecorator<K,V>` Provides a base decorator that enables additional functionality to be added to an OrderedMap via decoration.
    `class` | `AbstractSortedMapDecorator<K,V>` Provides a base decorator that enables additional functionality to be added to a Map via decoration.
    `class` | `FixedSizeSortedMap<K,V>` Decorates another `SortedMap` to fix the size blocking add/remove.
    `class` | `LinkedMap<K,V>` A `Map` implementation that maintains the order of the entries.
    `class` | `ListOrderedMap<K,V>` Decorates a `Map` to ensure that the order of addition is retained using a `List` to maintain order.
    `class` | `LRUMap<K,V>` A `Map` implementation with a fixed maximum size which removes the least recently used entry if an entry is added when full.
    `class` | `SingletonMap<K,V>` A `Map` implementation that holds a single item and is fixed size.
    `class` | `UnmodifiableOrderedMap<K,V>` Decorates another `OrderedMap` to ensure it can't be altered.
    `class` | `UnmodifiableSortedMap<K,V>` Decorates another `SortedMap` to ensure it can't be altered.

    Methods in org.apache.commons.collections4.map that return OrderedMap
    Modifier and Type | Method and Description
    --- | ---
    `protected OrderedMap<K,V>` | AbstractOrderedMapDecorator.`decorated()` Gets the map being decorated.
    `static <K,V> OrderedMap<K,V>` | UnmodifiableOrderedMap.`unmodifiableOrderedMap(OrderedMap<? extends K,? extends V> map)` Factory method to create an unmodifiable sorted map.

    Methods in org.apache.commons.collections4.map with parameters of type OrderedMap
    Modifier and Type | Method and Description
    --- | ---
    `static <K,V> OrderedMap<K,V>` | UnmodifiableOrderedMap.`unmodifiableOrderedMap(OrderedMap<? extends K,? extends V> map)` Factory method to create an unmodifiable sorted map.

    Constructors in org.apache.commons.collections4.map with parameters of type OrderedMap
    Constructor and Description
    `AbstractOrderedMapDecorator(OrderedMap<K,V> map)` Constructor that wraps (not copies).

  - ### Uses of OrderedMap in org.apache.commons.collections4.trie

    Classes in org.apache.commons.collections4.trie that implement OrderedMap
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractBitwiseTrie<K,V>` This class provides some basic `Trie` functionality and utility methods for actual bitwise `Trie` implementations.
    `class` | `PatriciaTrie<E>` Implementation of a PATRICIA Trie (Practical Algorithm to Retrieve Information Coded in Alphanumeric).
    `class` | `UnmodifiableTrie<K,V>` An unmodifiable `Trie`.

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