Update to reflect new/removed classes

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131091 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2003-05-16 16:00:29 +00:00
parent 13d49d7341
commit 55102a32c1
1 changed files with 141 additions and 121 deletions

View File

@ -1,121 +1,141 @@
<!-- $Id: package.html,v 1.8 2002/12/08 15:30:58 scolebourne Exp $ --> <!-- $Id: package.html,v 1.9 2003/05/16 16:00:29 scolebourne Exp $ -->
<html> <body>
<head> <p>
<title>Package Documentation for org.apache.commons.collections</title> The Apache Jakarta Commons Collections Framework extensions are implemented in
</head> a number of packages.
<body> <ul>
<p> <li>The main package, described below, contains new collections
Java Collections Framework extensions. interfaces/implementations and new implementations of the standard interfaces.
</p> <li>The <code>comparators</code> subpackage contains <code>Comparator</code> implementations.
<p> <li>The <code>iterators</code> subpackage contains <code>Iterator</code> implementations.
See also the <tt>java.util</tt> package. <li>The <code>decorators</code> subpackage contains decorators that wrap other
</p> implementations to add functionality such as validation or unmodifiability.
<table border="1" cellspacing="0" cellpadding="3"> <li>The <code>primitives</code> subpackages contain implementations of collections
<tr bgcolor="#CCCCFF" class="TableHeadingColor"> based around primitive types.
<th>Category</th><th>Classes</th><th>Comments</th> </ul>
</tr> </p>
<tr> <p>
<td valign="top">List Implementations</td> See also the <tt>java.util</tt> package for the standard java collections.
<td> </p>
{@link org.apache.commons.collections.CursorableLinkedList}<br> <table border="1" cellspacing="0" cellpadding="3">
{@link org.apache.commons.collections.FastArrayList} <tr bgcolor="#CCCCFF" class="TableHeadingColor">
</td> <th>Category</th><th>Classes</th><th>Comments</th>
<td valign="top"> </tr>
Special-purpose implementations of the {@link <tr>
java.util.List} interface. <td valign="top">List Implementations</td>
</td> <td>
</tr> {@link org.apache.commons.collections.CursorableLinkedList}<br>
<tr> {@link org.apache.commons.collections.FastArrayList}<br>
<td valign="top">Map Implementations</td> {@link org.apache.commons.collections.NodeCachingLinkedList}<br>
<td> </td>
{@link org.apache.commons.collections.BeanMap}<br> <td valign="top">
{@link org.apache.commons.collections.DoubleOrderedMap}<br> Special-purpose implementations of the {@link
{@link org.apache.commons.collections.ExtendedProperties}<br> java.util.List} interface.
{@link org.apache.commons.collections.FastHashMap}<br> </td>
{@link org.apache.commons.collections.FastTreeMap}<br> </tr>
{@link org.apache.commons.collections.LRUMap}<br> <tr>
{@link org.apache.commons.collections.MultiHashMap}<br> <td valign="top">Map Implementations</td>
{@link org.apache.commons.collections.ProxyMap}<br> <td>
{@link org.apache.commons.collections.ReferenceMap}<br> {@link org.apache.commons.collections.BeanMap}<br>
{@link org.apache.commons.collections.SequencedHashMap}<br> {@link org.apache.commons.collections.DoubleOrderedMap}<br>
{@link org.apache.commons.collections.SoftRefHashMap}<br> {@link org.apache.commons.collections.ExtendedProperties}<br>
{@link org.apache.commons.collections.StaticBucketMap}<br> {@link org.apache.commons.collections.FastHashMap}<br>
</td> {@link org.apache.commons.collections.FastTreeMap}<br>
<td valign="top"> {@link org.apache.commons.collections.LRUMap}<br>
Special-purpose implementations of the {@link {@link org.apache.commons.collections.MultiHashMap}<br>
java.util.Map} interface and associated classes. {@link org.apache.commons.collections.ReferenceMap}<br>
</td> {@link org.apache.commons.collections.SequencedHashMap}<br>
</tr> {@link org.apache.commons.collections.StaticBucketMap}<br>
<tr> </td>
<td valign="top">Buffer Interface and Implementations</td> <td valign="top">
<td> Special-purpose implementations of the {@link
{@link org.apache.commons.collections.ArrayStack}<br> java.util.Map} interface and associated classes.
{@link org.apache.commons.collections.BinaryHeap}<br> </td>
{@link org.apache.commons.collections.BoundedFifoBuffer}<br> </tr>
{@link org.apache.commons.collections.Buffer}<br> <tr>
{@link org.apache.commons.collections.PriorityQueue}<br> <td valign="top">Bag Interface and Implementations</td>
{@link org.apache.commons.collections.SynchronizedPriorityQueue} <td>
{@link org.apache.commons.collections.UnboundedFifoBuffer} {@link org.apache.commons.collections.Bag}<br>
</td> {@link org.apache.commons.collections.DefaultMapBag}<br>
<td valign="top"> {@link org.apache.commons.collections.HashBag}<br>
New collection interface that specifies a removal order for {@link org.apache.commons.collections.SortedBag}<br>
the collection, used to implement queues and queue-like things. {@link org.apache.commons.collections.TreeBag}<br>
</td> </td>
</tr> <td valign="top">
<td valign="top">Bag Interface and Implementations</td> New collections interface that keeps a count of its members.
<td> </td>
{@link org.apache.commons.collections.Bag}<br> </tr>
{@link org.apache.commons.collections.DefaultMapBag}<br> <tr>
{@link org.apache.commons.collections.HashBag}<br> <td valign="top">Buffer Interface and Implementations</td>
{@link org.apache.commons.collections.SortedBag}<br> <td>
{@link org.apache.commons.collections.TreeBag} {@link org.apache.commons.collections.Buffer}<br>
</td> {@link org.apache.commons.collections.ArrayStack}<br>
<td valign="top"> {@link org.apache.commons.collections.BinaryHeap}<br>
New collections interface that keeps a count of its members. {@link org.apache.commons.collections.BoundedFifoBuffer}<br>
</td> {@link org.apache.commons.collections.CircularFifoBuffer}<br>
</tr> {@link org.apache.commons.collections.UnboundedFifoBuffer}<br>
<tr> </td>
<td valign="top">Utilities</td> <td valign="top">
<td valign="top"> New collections interface that specifies a removal order for
{@link org.apache.commons.collections.BagUtils}<br> the collection, used to implement queues and queue-like things.
{@link org.apache.commons.collections.BufferUtils}<br> </td>
{@link org.apache.commons.collections.CollectionUtils}<br> </tr>
{@link org.apache.commons.collections.ComparatorUtils}<br> <tr>
{@link org.apache.commons.collections.IteratorUtils}<br> <td valign="top">PriorityQueue Interface and Implementations</td>
{@link org.apache.commons.collections.ListUtils}<br> <td>
{@link org.apache.commons.collections.MapUtils}<br> {@link org.apache.commons.collections.PriorityQueue}<br>
{@link org.apache.commons.collections.SetUtils} {@link org.apache.commons.collections.BinaryHeap}<br>
</td> </td>
<td valign="top"> <td valign="top">
Manipulate collection objects, determine set theoretic New collections interface that defines a simple queue.
properties, ensure type-safety, provide decorators, etc. </td>
</td> </tr>
</tr> <tr>
<tr> <td valign="top">Utilities</td>
<td valign="top">Functor Interfaces</td> <td valign="top">
<td valign="top"> {@link org.apache.commons.collections.BagUtils}<br>
{@link org.apache.commons.collections.Factory}<br> {@link org.apache.commons.collections.BufferUtils}<br>
{@link org.apache.commons.collections.Predicate}<br> {@link org.apache.commons.collections.CollectionUtils}<br>
{@link org.apache.commons.collections.Closure}<br> {@link org.apache.commons.collections.ComparatorUtils}<br>
{@link org.apache.commons.collections.Transformer}<br> {@link org.apache.commons.collections.IteratorUtils}<br>
</td> {@link org.apache.commons.collections.ListUtils}<br>
<td valign="top"> {@link org.apache.commons.collections.MapUtils}<br>
Create views or functors on a collection. If your collection {@link org.apache.commons.collections.PriorityQueueUtils}<br>
represents <i>X</i>, these allow you to define and look at {@link org.apache.commons.collections.SetUtils}<br>
<i>f(X)</i>. </td>
</td> <td valign="top">
</tr> Manipulate collection objects, determine set theoretic
<tr> properties, ensure type-safety, provide decorators, etc.
<td valign="top">Miscellaneous</td> </td>
<td valign="top"> </tr>
{@link org.apache.commons.collections.StringStack}<br> <tr>
{@link org.apache.commons.collections.DefaultMapEntry}<br> <td valign="top">Functor Interfaces and Utilities</td>
{@link org.apache.commons.collections.BoundedCollection}<br> <td valign="top">
</td> {@link org.apache.commons.collections.Closure}<br>
<td valign="top"> {@link org.apache.commons.collections.ClosureUtils}<br>
Other collection related classes. {@link org.apache.commons.collections.Factory}<br>
</td> {@link org.apache.commons.collections.FactoryUtils}<br>
</tr> {@link org.apache.commons.collections.Predicate}<br>
</table> {@link org.apache.commons.collections.PredicateUtils}<br>
</body> {@link org.apache.commons.collections.Transformer}<br>
</html> {@link org.apache.commons.collections.TransformerUtils}<br>
</td>
<td valign="top">
Create views or functors on a collection. If your collection
represents <i>X</i>, these allow you to define and look at
<i>f(X)</i>. The utilities contain numerous implementations.
</td>
</tr>
<tr>
<td valign="top">Miscellaneous</td>
<td valign="top">
{@link org.apache.commons.collections.DefaultMapEntry}<br>
{@link org.apache.commons.collections.BoundedCollection}<br>
{@link org.apache.commons.collections.MultiKey}<br>
</td>
<td valign="top">
Other collection related classes.
</td>
</tr>
</table>
</body>