| 1 |
<!-- $Id: overview.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 |
Commons-Collections contains implementations, enhancements and utilities |
| 21 |
that complement the Java Collections Framework. |
| 22 |
</p> |
| 23 |
<p> |
| 24 |
The Apache Jakarta Commons Collections Framework component adds a significant |
| 25 |
amount of enhancements to the standard JDK collections. These enhancements |
| 26 |
come in the form of new interfaces, new implementations and utility classes. |
| 27 |
</p> |
| 28 |
<p> |
| 29 |
See also the <code>java.util</code> package for the standard Java collections. |
| 30 |
</p> |
| 31 |
|
| 32 |
<h4>Main features</h4> |
| 33 |
<p> |
| 34 |
Commons-Collections defines a number of key interfaces: |
| 35 |
</p> |
| 36 |
<table border="1" cellspacing="0" cellpadding="3"> |
| 37 |
<tr bgcolor="#CCCCFF" class="TableHeadingColor"> |
| 38 |
<th>Interface</th><th>Description</th> |
| 39 |
</tr> |
| 40 |
<tr> |
| 41 |
<td> |
| 42 |
{@link org.apache.commons.collections.Bag} |
| 43 |
</td> |
| 44 |
<td valign="top"> |
| 45 |
A new <code>Collection</code> subinterface that stores each object together |
| 46 |
with the number of occurances. Methods are provided to get the number of |
| 47 |
occurances, and to add and remove a certain number of that object. |
| 48 |
</td> |
| 49 |
</tr> |
| 50 |
<tr> |
| 51 |
<td> |
| 52 |
{@link org.apache.commons.collections.Buffer} |
| 53 |
</td> |
| 54 |
<td valign="top"> |
| 55 |
A new <code>Collection</code> subinterface that allows objects to be removed |
| 56 |
in some well-defined order. Methods enable the next item to be peeked and removed. |
| 57 |
</td> |
| 58 |
</tr> |
| 59 |
<tr> |
| 60 |
<td> |
| 61 |
{@link org.apache.commons.collections.BidiMap} |
| 62 |
</td> |
| 63 |
<td valign="top"> |
| 64 |
A new <code>Map</code> subinterface that allows lookup from key to value and |
| 65 |
from value to key with equal ease. |
| 66 |
</td> |
| 67 |
</tr> |
| 68 |
<tr> |
| 69 |
<td> |
| 70 |
{@link org.apache.commons.collections.OrderedMap} |
| 71 |
</td> |
| 72 |
<td valign="top"> |
| 73 |
A new <code>Map</code> subinterface that is used when a map has an order, but is |
| 74 |
not sorted. Methods enable bidriectional iteration through the map. |
| 75 |
</td> |
| 76 |
</tr> |
| 77 |
<tr> |
| 78 |
<td> |
| 79 |
{@link org.apache.commons.collections.MapIterator} |
| 80 |
</td> |
| 81 |
<td valign="top"> |
| 82 |
A new <code>Iterator</code> subinterface specially designed for maps. This iterator |
| 83 |
avoids the need for entrySet iteration of a map, and is simpler to use. |
| 84 |
</td> |
| 85 |
</tr> |
| 86 |
<tr> |
| 87 |
<td> |
| 88 |
{@link org.apache.commons.collections.ResettableIterator} |
| 89 |
</td> |
| 90 |
<td valign="top"> |
| 91 |
A new <code>Iterator</code> subinterface that allows the iteration to be reset back |
| 92 |
to the start. Many iterators in this library have this functionality. |
| 93 |
</td> |
| 94 |
</tr> |
| 95 |
<tr> |
| 96 |
<td> |
| 97 |
{@link org.apache.commons.collections.Closure}<br /> |
| 98 |
{@link org.apache.commons.collections.Predicate}<br /> |
| 99 |
{@link org.apache.commons.collections.Transformer}<br /> |
| 100 |
{@link org.apache.commons.collections.Factory}<br /> |
| 101 |
</td> |
| 102 |
<td valign="top"> |
| 103 |
A group of <i>functor</i> interfaces that provide plugin behaviour to various |
| 104 |
collections and utilities. |
| 105 |
</td> |
| 106 |
</tr> |
| 107 |
</table> |
| 108 |
<p> |
| 109 |
In addition to the interfaces, there are many implementations. |
| 110 |
Consult each subpackage for full details of these. |
| 111 |
</p> |
| 112 |
|
| 113 |
</body> |