Debian Codegraph @

src/java/org/apache/commons/collections/bidimap/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 org.apache.commons.collections.BidiMap BidiMap},
22 {@link org.apache.commons.collections.OrderedBidiMap OrderedBidiMap} and
23 {@link org.apache.commons.collections.SortedBidiMap SortedBidiMap} interfaces.
24 A BidiMap is an extension to Map that allows keys and values to be looked up with equal ease.
25 One example usage is a system communicating to a legacy datasource that must convert codes
26 from the new format to the old format and vice versa.
27 <p>
28 The following implementations are provided in the package:
29 <ul>
30 <li>DualHashBidiMap - uses two HashMaps to implement BidiMap
31 <li>DualTreeBidiMap - uses two TreeMaps to implement SortedBidiMap
32 <li>TreeBidiMap - red-black tree implementation of OrderedBidiMap
33 </ul>
34 <p>
35 The following decorators are provided in the package:
36 <ul>
37 <li>Unmodifiable - ensures the map cannot be altered
38 <!--
39 <li>Synchronized - synchronizes method access for multi-threaded environments
40 <li>Predicated - ensures that only elements that are valid according to a predicate can be added
41 <li>Typed - ensures that only elements that are of a specific type can be added
42 <li>Transformed - transforms each element added
43 <li>FixedSize - ensures that the size of the map cannot change
44 <li>Lazy - creates objects in the map on demand
45 <li>ListOrdered - ensures that insertion order is retained-->
46 </ul>
47 </pre>
48 </BODY>