Package org.apache.commons.collections.map

package org.apache.commons.collections.map

This package contains implementations of the Map, IterableMap, OrderedMap and SortedMap interfaces. A Map provides a lookup from a key to a value. A number of implementations also support the new MapIterator interface that enables simple iteration of map keys and values.

The following implementations are provided:

  • CaseInsensitiveMap - map that compares keys in a case insensitive way
  • CompositeMap - map that combines multiple maps into a single view
  • HashedMap - general purpose HashMap replacement supporting MapIterator
  • IdentityMap - map that uses == for comparison instead of equals()
  • Flat3Map - designed for good performance at size 3 or less
  • LinkedMap - a hash map that maintains insertion order, supporting OrderedMapIterator
  • MultiKeyMap - map that provides special methods for using more than one key to access the value
  • ReferenceMap - allows the garbage collector to collect keys and values using equals() for comparison
  • ReferenceIdentityMap - allows the garbage collector to collect keys and values using == for comparison
  • SingletonMap - a fully featured map to hold one key-value pair
  • StaticBucketMap - internally synchronized and designed for thread-contentious environments

The following decorators are provided:

  • Unmodifiable - ensures the collection cannot be altered
  • Predicated - ensures that only elements that are valid according to a predicate can be added
  • Typed - ensures that only elements that are of a specific type can be added
  • Transformed - transforms each element added
  • FixedSize - ensures that the size of the map cannot change
  • Lazy - creates objects in the map on demand
  • ListOrdered - ensures that insertion order is retained
  • Class
    Description
    AbstractHashedMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    AbstractLinkedMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    AbstractMapDecorator
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    AbstractOrderedMapDecorator
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    AbstractReferenceMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    AbstractSortedMapDecorator
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    CaseInsensitiveMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    CompositeMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    CompositeMap.MapMutator
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    DefaultedMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    FixedSizeMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    FixedSizeSortedMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    Flat3Map
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    HashedMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    IdentityMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    LazyMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    LazySortedMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    LinkedMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    ListOrderedMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    LRUMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    MultiKeyMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    MultiValueMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    PredicatedMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    PredicatedSortedMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    ReferenceIdentityMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    ReferenceMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    SingletonMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    StaticBucketMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    TransformedMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    TransformedSortedMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    TypedMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    TypedSortedMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    UnmodifiableEntrySet
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    UnmodifiableMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    UnmodifiableOrderedMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.
    UnmodifiableSortedMap
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS.