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
-
Interface Summary Interface Description CompositeMap.MapMutator Deprecated. Please use Apache Commons Collections 4 instead. -
Class Summary Class Description AbstractHashedMap Deprecated. Please use Apache Commons Collections 4 instead.AbstractLinkedMap Deprecated. Please use Apache Commons Collections 4 instead.AbstractMapDecorator Deprecated. Please use Apache Commons Collections 4 instead.AbstractOrderedMapDecorator Deprecated. Please use Apache Commons Collections 4 instead.AbstractReferenceMap Deprecated. Please use Apache Commons Collections 4 instead.AbstractSortedMapDecorator Deprecated. Please use Apache Commons Collections 4 instead.CaseInsensitiveMap Deprecated. Please use Apache Commons Collections 4 instead.CompositeMap Deprecated. Please use Apache Commons Collections 4 instead.DefaultedMap Deprecated. Please use Apache Commons Collections 4 instead.FixedSizeMap Deprecated. Please use Apache Commons Collections 4 instead.FixedSizeSortedMap Deprecated. Please use Apache Commons Collections 4 instead.Flat3Map Deprecated. Please use Apache Commons Collections 4 instead.HashedMap Deprecated. Please use Apache Commons Collections 4 instead.IdentityMap Deprecated. Please use Apache Commons Collections 4 instead.LazyMap Deprecated. Please use Apache Commons Collections 4 instead.LazySortedMap Deprecated. Please use Apache Commons Collections 4 instead.LinkedMap Deprecated. Please use Apache Commons Collections 4 instead.ListOrderedMap Deprecated. Please use Apache Commons Collections 4 instead.LRUMap Deprecated. Please use Apache Commons Collections 4 instead.MultiKeyMap Deprecated. Please use Apache Commons Collections 4 instead.MultiValueMap Deprecated. Please use Apache Commons Collections 4 instead.PredicatedMap Deprecated. Please use Apache Commons Collections 4 instead.PredicatedSortedMap Deprecated. Please use Apache Commons Collections 4 instead.ReferenceIdentityMap Deprecated. Please use Apache Commons Collections 4 instead.ReferenceMap Deprecated. Please use Apache Commons Collections 4 instead.SingletonMap Deprecated. Please use Apache Commons Collections 4 instead.StaticBucketMap Deprecated. Please use Apache Commons Collections 4 instead.TransformedMap Deprecated. Please use Apache Commons Collections 4 instead.TransformedSortedMap Deprecated. Please use Apache Commons Collections 4 instead.TypedMap Deprecated. Please use Apache Commons Collections 4 instead.TypedSortedMap Deprecated. Please use Apache Commons Collections 4 instead.UnmodifiableEntrySet Deprecated. Please use Apache Commons Collections 4 instead.UnmodifiableMap Deprecated. Please use Apache Commons Collections 4 instead.UnmodifiableOrderedMap Deprecated. Please use Apache Commons Collections 4 instead.UnmodifiableSortedMap Deprecated. Please use Apache Commons Collections 4 instead.