2002-07-24 22:36:45 -04:00
<?xml version="1.0"?>
2004-02-17 20:00:08 -05:00
<!--
Copyright 2002-2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
2002-07-24 22:36:45 -04:00
<document >
<properties >
2004-01-14 16:01:30 -05:00
<title > Commons Collections</title>
2002-07-24 22:36:45 -04:00
<author email= "commons-dev@jakarta.apache.org" > Commons Documentation Team</author>
</properties>
<body >
2004-01-14 16:01:30 -05:00
<section name= "Commons Collections" >
2002-07-24 22:36:45 -04:00
<p >
2004-01-05 19:44:20 -05:00
The <a href= "http://java.sun.com/products/j2se/1.4/docs/guide/collections/" > Java Collections Framework</a>
was a major addition in JDK 1.2.
It added many powerful data structures that accelerate development of most significant Java applications.
2004-01-14 04:15:08 -05:00
Since that time it has become the recognised standard for collection handling in Java.
2002-07-24 22:36:45 -04:00
</p>
<p >
2004-01-05 19:44:20 -05:00
Commons-Collections seek to build upon the JDK classes by providing new interfaces, implementations and utilities.
There are many features, including:
2002-07-24 22:36:45 -04:00
<ul >
2004-01-05 19:44:20 -05:00
<li > Bag interface for collections that have a number of copies of each object</li>
<li > Buffer interface for collections that have a well defined removal order, like FIFOs</li>
<li > BidiMap interface for maps that can be looked up from value to key as well and key to value</li>
<li > MapIterator interface to provide simple and quick iteration over maps</li>
<li > Type checking decorators to ensure that only instances of a certain type can be added</li>
<li > Transforming decorators that alter each object as it is added to the collection</li>
<li > Composite collections that make multiple collections look like one</li>
<li > Ordered maps and sets that retain the order elements are added in, including an LRU based map</li>
<li > Identity map that compares objects based on their identity (==) instead of the equals method</li>
<li > Reference map that allows keys and/or values to be garbage collected under close control</li>
<li > Many comparator implementations</li>
<li > Many iterator implementations</li>
<li > Adapter classes from array and enumerations to collections</li>
<li > Utilities to test or create typical set-theory properties of collections such as union, intersection, and closure</li>
2002-07-24 22:36:45 -04:00
</ul>
</p>
</section>
2004-01-05 19:44:20 -05:00
2002-07-24 22:36:45 -04:00
<section name= "Documentation" >
<p >
2004-01-14 04:15:08 -05:00
A getting started<span > </span> <a href= "userguide.html" > User's Guide</a> is available.
2002-07-24 22:36:45 -04:00
</p>
<p >
2004-01-14 04:15:08 -05:00
The JavaDoc API documents are available online:
2004-01-05 19:44:20 -05:00
</p>
2004-01-14 04:15:08 -05:00
<ul >
<li > The <a href= "apidocs-COLLECTIONS_3_0/index.html" > current release 3.0</a> </li>
<li > The <a href= "apidocs-COLLECTIONS_2_1/index.html" > previous version 2.1</a> </li>
<li > The <a href= "apidocs/index.html" > latest CVS</a> </li>
</ul>
2004-01-05 19:44:20 -05:00
<p >
The <a href= "http://cvs.apache.org/viewcvs/jakarta-commons/collections/" > CVS repository</a> can be browsed.
2002-07-24 22:36:45 -04:00
</p>
</section>
2004-01-05 19:44:20 -05:00
2002-07-24 22:36:45 -04:00
<section name= "Releases" >
2004-01-05 19:44:20 -05:00
<p >
Version 3.0 -
<a href= "http://jakarta.apache.org/site/binindex.cgi" > Binary</a> -
<a href= "http://jakarta.apache.org/site/sourceindex.cgi" > Source</a>
</p>
<p >
For previous releases, see the <a href= "http://archive.apache.org/dist/jakarta/commons/collections/" > Apache Archive</a>
</p>
2002-07-24 22:36:45 -04:00
</section>
2004-01-24 08:33:29 -05:00
<section name= "Bugs" >
<p >
Bugs may be reported via the Bugzilla Management system. The following links may prove useful:
</p>
<ul >
<li > <a href= "http://issues.apache.org/bugzilla/createaccount.cgi" > Create a Bugzilla account</a> </li>
<li > <a href= "http://issues.apache.org/bugzilla/enter_bug.cgi?product=Commons&component=Collections&version=3.0%20Final" > Submit a bug report</a> </li>
<li > <a href= "http://issues.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Commons&component=Collections&short_desc=&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&newqueryname=&order=Reuse+same+sort+as+last+time" > All open Collections bugs</a> </li>
<li > <a href= "http://issues.apache.org/bugzilla/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=RESOLVED&bug_status=VERIFIED&bug_status=CLOSED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Commons&component=Collections&short_desc=&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&newqueryname=&order=Reuse+same+sort+as+last+time" > All Collections bugs</a> </li>
</ul>
</section>
2002-07-24 22:36:45 -04:00
</body>
</document>
