Apache
/
commons-collections
mirror of https://github.com/apache/commons-collections.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update docs prior to 3.2 

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@333026 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2005-11-13 15:44:19 +00:00
parent e76bffaf96
commit 01bf1138f9
4 changed files with 39 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
xdocs/index.xml
View File

@ -1,6 +1,6 @@
<?xml version="1.0"?> <?xml version="1.0"?>
<!-- <!--
Copyright 2002-2004 The Apache Software Foundation Copyright 2002-2005 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
@ -14,18 +14,14 @@
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
--> -->
<document> <document>
<properties> <properties>
<title>Commons Collections</title> <title>Commons Collections</title>
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author> <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
</properties> </properties>
<body>
<body> <!-- ================================================== -->
<section name="Commons Collections"> <section name="Commons Collections">
<p> <p>
The <a href="http://java.sun.com/products/j2se/1.4/docs/guide/collections/">Java Collections Framework</a> 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. was a major addition in JDK 1.2.
@ -57,11 +53,11 @@ Version 3.1 and patch version 2.1.1 have just been released.
These provides a work around to a <a href="compatibility.html">version compatibility</a> issue between v2.1 and v3.0. These provides a work around to a <a href="compatibility.html">version compatibility</a> issue between v2.1 and v3.0.
</p> </p>
</section> </section>
<!-- ================================================== -->
<section name="Documentation"> <section name="Documentation">
<p> <p>
A getting started<span> </span><a href="userguide.html">User's Guide</a> is available. A getting started<span> </span><a href="userguide.html">User's Guide</a> is available
as are various <a href="maven-reports.html">project reports</a>.
</p> </p>
<p> <p>
The JavaDoc API documents are available online: The JavaDoc API documents are available online:
@ -75,36 +71,32 @@ The JavaDoc API documents are available online:
The <a href="http://cvs.apache.org/viewcvs/jakarta-commons/collections/">CVS repository</a> can be browsed. The <a href="http://cvs.apache.org/viewcvs/jakarta-commons/collections/">CVS repository</a> can be browsed.
</p> </p>
</section> </section>
<!-- ================================================== -->
<section name="Releases"> <section name="Releases">
<p> <p>
Version 3.1/2.1.1 - The latest version is v3.1. -
<a href="http://jakarta.apache.org/site/binindex.cgi#commons-collections">Binary</a> - <a href="http://jakarta.apache.org/site/downloads/downloads_commons-collections.cgi">Download now!</a><br />
<a href="http://jakarta.apache.org/site/sourceindex.cgi#commons-collections">Source</a> <!--The <a href="upgradeto3_2.html">upgrade notes</a> are also available.-->
</p> </p>
<p> <p>
For previous releases, see the <a href="http://archive.apache.org/dist/jakarta/commons/collections/">Apache Archive</a> For previous releases, see the <a href="http://archive.apache.org/dist/jakarta/commons/collections/">Apache Archive</a>
</p> </p>
</section> </section>
<!-- ================================================== -->
<section name="Bugs"> <section name="Support">
<p> <p>
Bugs may be reported via the Bugzilla Management system. The following links may prove useful: The <a href="mail-lists.html">commons mailing lists</a> act as the main support forum.
The user list is suitable for most library usage queries.
The dev list is intended for the development discussion.
Please remember that the lists are shared between all commons components,
so prefix your email by [collections].
</p>
<p>
Issues may be reported via <a href="issue-tracking.html">ASF Bugzilla</a>.
Please remember that Bugzilla is shared between all commons components,
so prefix your issue by [collections].
</p> </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&amp;component=Collections&amp;version=3.0%20Final">Submit a bug report</a></li>
<li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;email1=&amp;emailtype1=substring&amp;emailassigned_to1=1&amp;email2=&amp;emailtype2=substring&amp;emailreporter2=1&amp;bugidtype=include&amp;bug_id=&amp;changedin=&amp;votes=&amp;chfieldfrom=&amp;chfieldto=Now&amp;chfieldvalue=&amp;product=Commons&amp;component=Collections&amp;short_desc=&amp;short_desc_type=allwordssubstr&amp;long_desc=&amp;long_desc_type=allwordssubstr&amp;bug_file_loc=&amp;bug_file_loc_type=allwordssubstr&amp;keywords=&amp;keywords_type=anywords&amp;field0-0-0=noop&amp;type0-0-0=noop&amp;value0-0-0=&amp;cmdtype=doit&amp;newqueryname=&amp;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&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=RESOLVED&amp;bug_status=VERIFIED&amp;bug_status=CLOSED&amp;email1=&amp;emailtype1=substring&amp;emailassigned_to1=1&amp;email2=&amp;emailtype2=substring&amp;emailreporter2=1&amp;bugidtype=include&amp;bug_id=&amp;changedin=&amp;votes=&amp;chfieldfrom=&amp;chfieldto=Now&amp;chfieldvalue=&amp;product=Commons&amp;component=Collections&amp;short_desc=&amp;short_desc_type=allwordssubstr&amp;long_desc=&amp;long_desc_type=allwordssubstr&amp;bug_file_loc=&amp;bug_file_loc_type=allwordssubstr&amp;keywords=&amp;keywords_type=anywords&amp;field0-0-0=noop&amp;type0-0-0=noop&amp;value0-0-0=&amp;cmdtype=doit&amp;newqueryname=&amp;order=Reuse+same+sort+as+last+time">All Collections bugs</a></li>
</ul>
</section> </section>
<!-- ================================================== -->
</body> </body>
</document> </document>

17
xdocs/navigation.xml
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<!-- <!--
Copyright 2002-2004 The Apache Software Foundation Copyright 2002-2005 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
@ -30,17 +30,20 @@
<menu name="Commons Collections"> <menu name="Commons Collections">
<item name="Overview" href="/index.html"/> <item name="Overview" href="/index.html"/>
<item name="Download" href="http://jakarta.apache.org/site/sourceindex.cgi#commons-collections"/> <item name="Download" href="http://jakarta.apache.org/site/downloads/downloads_commons-collections.cgi"/>
<item name="Users guide" href="/userguide.html"/> <item name="Users guide" href="/userguide.html"/>
<item name="History" href="/history.html"/> <item name="History" href="/history.html"/>
<item name="Javadoc (3.1 release)" href="apidocs-COLLECTIONS_3_1/index.html"/> <item name="Javadoc (3.1 release)" href="api-release/index.html"/>
</menu>
<menu name="Development">
<item name="Building" href="/building.html"/>
<item name="Mailing lists" href="/mail-lists.html"/> <item name="Mailing lists" href="/mail-lists.html"/>
<item name="Team" href="/team-list.html"/> <item name="Team" href="/team-list.html"/>
<item name="Tasks" href="/tasks.html"/> <item name="Tasks" href="/tasks.html"/>
<item name="CVS" href="http://cvs.apache.org/viewcvs/jakarta-commons/collections/"/> <item name="Proposal" href="/proposal.html"/>
<item name="Javadoc (CVS latest)" href="apidocs/index.html"/> <item name="SVN repository" href="http://svn.apache.org/viewcvs.cgi/jakarta/commons/proper/collections/trunk/"/>
<item name="Javadoc (3.0 old)" href="apidocs-COLLECTIONS_3_0/index.html"/> <item name="Javadoc (SVN latest)" href="apidocs/index.html"/>
<item name="Javadoc (2.1.1 old)" href="apidocs-COLLECTIONS_2_1_1/index.html"/>
</menu> </menu>
&common-menus; &common-menus;

2
xdocs/pick.xml
View File

@ -168,7 +168,7 @@ The <a href="http://java.sun.com/j2se/1.4/docs/api/java/util/Map.html">Map</a> i
</tr> </tr>
<tr> <tr>
<td><a href="http://jakarta.apache.org/commons/collections/apidocs-COLLECTIONS_3_1/org/apache/commons/collections/map/Flat3Map.html">Flat3Map</a></td> <td><a href="http://jakarta.apache.org/commons/collections/apidocs-COLLECTIONS_3_1/org/apache/commons/collections/map/Flat3Map.html">Flat3Map</a></td>
<td>This map is optimised to store one, two or three key-value pairs and outperforms HashMap at these sizes. For size four and above performance is about 5% slower than HashMap. This map also has good garbage collection characteristics when below size four. It provides a MapIterator. This map should be used if are 99% sure that the map will be size four or less.</td> <td>This map is optimised to store one, two or three key-value pairs and outperforms HashMap at these sizes. For size four and above performance is about 5% slower than HashMap. This map also has good garbage collection characteristics when below size four. It provides a MapIterator. This map should be used if are 99% sure that the map will be size three or less.</td>
</tr> </tr>
<tr> <tr>
<td><a href="http://jakarta.apache.org/commons/collections/apidocs-COLLECTIONS_3_1/org/apache/commons/collections/map/StaticBucketMap.html">StaticBucketMap</a></td> <td><a href="http://jakarta.apache.org/commons/collections/apidocs-COLLECTIONS_3_1/org/apache/commons/collections/map/StaticBucketMap.html">StaticBucketMap</a></td>

6
xdocs/userguide.xml
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<!-- <!--
Copyright 2003-2004 The Apache Software Foundation Copyright 2003-2005 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
@ -18,13 +18,13 @@
<document> <document>
<properties> <properties>
<title>Commons Collections - Users guide</title> <title>Commons Collections - User guide</title>
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author> <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
</properties> </properties>
<body> <body>
<section name="Introduction"> <section name="User guide">
<p> <p>
Commons-Collections provides a large number of classes to aid day to day programming. Commons-Collections provides a large number of classes to aid day to day programming.