rwaldhoff 2003/10/29 14:00:29 Modified: primitives/xdocs index.xml Log: update docs Revision Changes Path 1.5 +57 -10 jakarta-commons/primitives/xdocs/index.xml Index: index.xml =================================================================== RCS file: /home/cvs/jakarta-commons/primitives/xdocs/index.xml,v retrieving revision 1.4 retrieving revision 1.5 diff -u -r1.4 -r1.5 --- index.xml 27 Oct 2003 22:11:20 -0000 1.4 +++ index.xml 29 Oct 2003 22:00:29 -0000 1.5 @@ -15,23 +15,70 @@ for working with Java primitives (boolean, byte, char, double, float, int, long, short). Generally, the Commons-Primitives classes are faster, smaller and easier to work with than their purely Object based alternatives. -</p><p> -For more information on Commons Primitives, you might like to visit the -<a href="./apidocs/index.html">JavaDocs</a>, -<a href="./project-info.html">project info</a> -or <a href="./maven-reports.html">project reports</a> pages. </p> </section> <section name="Status"> <p> -Currently Commons Primitives contains a stable and <a href="./clover">well-tested</a> -implementation of primitive Collection and List classes previously unreleased from the -Commons Collections component. +Commons Primitives has not yet had a formal release. +Daily builds and tarballs are available from +<a href="http://cvs.apache.org/builds/jakarta-commons/nightly/commons-primitives/">http://cvs.apache.org/builds/jakarta-commons/nightly/commons-primitives/</a>. </p><p> -Additional Collection-related and utility classes are planned. -If you'd like to help, please contact the commons-dev mailing list and prefix emails with "[primitives]". +The current codebase is stable and <a href="./clover">well-tested</a> +nevertheless. A 1.0 release is expected "real soon now". +</p> +</section> + +<section name="Overview"> +<p> +Currently Commons Primitives is primarily composed of implementations of the +java.util collections adapted for the primitive types. </p> +<blockquote> +<dl> +<dt>org.apache.commons.collections.primitives</dt> +<dd> +<p>Contains interfaces, base classes and concrete implementations for primitive collections.</p> +<dl> +<dt><Type>Collection</dt><dd>The java.util.Collection interface adapted for the primitive type <Type></dd> +<dt><Type>Iterator</dt><dd>The java.util.Iterator interface adapted for the primitive type <Type></dd> +<dt><Type>List</dt><dd>The java.util.List interface adapted for the primitive type <Type></dd> +<dt><Type>ListIterator</dt><dd>The java.util.ListIterator interface adapted for the primitive type <Type></dd> +<dt>Abstract<Type>Collection</dt><dd>An abstract base for <Type>Collection implementations</dd> +<dt>RandomAccess<Type>List</dt><dd>An abstract base for <Type>List implementations backed by random access data structures like arrays</dd> +<dt>Array<Type>List</dt><dd>A <Type>List backed by an array</dd> +<dt><Type>Collections</dt><dd>Static utility methods for working with <Type>Collection instances</dd> +</dl> +</dd> + +<dt>org.apache.commons.collections.primitives.adapters</dt> +<dd> +<p>Contains adapters between the Object-based and primitive collections.</p> +</dd> + +<dt>org.apache.commons.collections.primitives.adapters.io</dt> +<dd> +<p>Contains adapters that convert between I/O Streams/Readers and byte/char iterators.</p> +</dd> + +<dt>org.apache.commons.collections.primitives.decorators</dt> +<dd> +<dl> +<dt>Umodifiable<Type>List</dt><dd>Makes a <Type>List unmodifiable</dd> +<dt>Umodifiable<Type>Iterator</dt><dd>Makes a <Type>Iterator unmodifiable</dd> +<dt>Umodifiable<Type>ListIterator</dt><dd>Makes a <Type>ListIterator unmodifiable</dd> +</dl> +</dd> + +</dl> +</blockquote> + +<p> +For more information on Commons Primitives, you might like to visit the +<a href="./apidocs/index.html">JavaDocs</a>, <a href="./project-info.html">project information</a> +or <a href="./maven-reports.html">project reports</a>. +</p> + </section> </body>
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]