| mparker | 8bdb122 | 2009-05-27 22:16:16 +0000 | [diff] [blame^] | 1 | <!-- $Id: package.html,v 1.1 2009/05/27 22:16:30 mparker Exp $ --> |
| 2 | <!-- |
| 3 | Copyright 2003-2004 The Apache Software Foundation |
| 4 | |
| 5 | Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | you may not use this file except in compliance with the License. |
| 7 | You may obtain a copy of the License at |
| 8 | |
| 9 | http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | |
| 11 | Unless required by applicable law or agreed to in writing, software |
| 12 | distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | See the License for the specific language governing permissions and |
| 15 | limitations under the License. |
| 16 | --> |
| 17 | <BODY> |
| 18 | <p> |
| 19 | This package contains implementations of the |
| 20 | {@link java.util.Map Map}, |
| 21 | {@link org.apache.commons.collections.IterableMap IterableMap}, |
| 22 | {@link org.apache.commons.collections.OrderedMap OrderedMap} and |
| 23 | {@link java.util.SortedMap SortedMap} interfaces. |
| 24 | A Map provides a lookup from a key to a value. |
| 25 | A number of implementations also support the new MapIterator interface that enables |
| 26 | simple iteration of map keys and values. |
| 27 | <p> |
| 28 | The following implementations are provided: |
| 29 | <ul> |
| 30 | <li>CaseInsensitiveMap - map that compares keys in a case insensitive way |
| 31 | <li>CompositeMap - map that combines multiple maps into a single view |
| 32 | <li>HashedMap - general purpose HashMap replacement supporting MapIterator |
| 33 | <li>IdentityMap - map that uses == for comparison instead of equals() |
| 34 | <li>Flat3Map - designed for good performance at size 3 or less |
| 35 | <li>LinkedMap - a hash map that maintains insertion order, supporting OrderedMapIterator |
| 36 | <li>MultiKeyMap - map that provides special methods for using more than one key to access the value |
| 37 | <li>ReferenceMap - allows the garbage collector to collect keys and values using equals() for comparison |
| 38 | <li>ReferenceIdentityMap - allows the garbage collector to collect keys and values using == for comparison |
| 39 | <li>SingletonMap - a fully featured map to hold one key-value pair |
| 40 | <li>StaticBucketMap - internally synchronized and designed for thread-contentious environments |
| 41 | </ul> |
| 42 | <p> |
| 43 | The following decorators are provided: |
| 44 | <ul> |
| 45 | <li>Unmodifiable - ensures the collection cannot be altered |
| 46 | <li>Predicated - ensures that only elements that are valid according to a predicate can be added |
| 47 | <li>Typed - ensures that only elements that are of a specific type can be added |
| 48 | <li>Transformed - transforms each element added |
| 49 | <li>FixedSize - ensures that the size of the map cannot change |
| 50 | <li>Lazy - creates objects in the map on demand |
| 51 | <li>ListOrdered - ensures that insertion order is retained |
| 52 | </ul> |
| 53 | </pre> |
| 54 | </BODY> |