Debian Codegraph @

src/java/org/apache/commons/collections/map/package.html

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