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

committing ungenerated parts of documentation patch from Chuck Burdick 

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@130492 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Rodney Waldhoff 2001-08-17 23:00:26 +00:00
parent e549ed5b85
commit 54345a5c91
2 changed files with 329 additions and 240 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

480
build.xml
View File

@ -1,239 +1,241 @@
<!-- $Id: build.xml,v 1.18 2001/07/15 00:17:24 craigmcc Exp $ --> <!-- $Id: build.xml,v 1.19 2001/08/17 23:00:26 rwaldhoff Exp $ -->
<project name="commons-collections" default="test" basedir="."> <project name="commons-collections" default="test" basedir=".">
<!-- patternset describing files to be copied from the doc directory --> <!-- patternset describing files to be copied from the doc directory -->
<patternset id="patternset-doc"/> <patternset id="patternset-doc"/>
<!-- patternset describing test classes --> <!-- patternset describing test classes -->
<patternset id="patternset-test-classes"> <patternset id="patternset-test-classes">
<include name="**/Test*.class"/> <include name="**/Test*.class"/>
</patternset> </patternset>
<!-- patternset describing non test classes --> <!-- patternset describing non test classes -->
<patternset id="patternset-non-test-classes"> <patternset id="patternset-non-test-classes">
<include name="**/*.class"/> <include name="**/*.class"/>
<exclude name="**/Test*.class"/> <exclude name="**/Test*.class"/>
</patternset> </patternset>
<!-- patternset describing non test source files (*.java, *html, etc.) --> <!-- patternset describing non test source files (*.java, *html, etc.) -->
<patternset id="patternset-javadocable-sources"> <patternset id="patternset-javadocable-sources">
<include name="**/*"/> <include name="**/*"/>
<exclude name="**/Test*.java"/> <exclude name="**/Test*.java"/>
</patternset> </patternset>
<!-- ######################################################### --> <!-- ######################################################### -->
<target name="init"> <target name="init">
<tstamp/> <tstamp/>
<!-- read properties from the build.properties, if any --> <!-- read properties from the build.properties, if any -->
<property name="component-propfile" value="${basedir}/build.properties"/> <property name="component-propfile" value="${basedir}/build.properties"/>
<property file="${component-propfile}"/> <property file="${component-propfile}"/>
<!-- read properties from the commons build.properties, if any --> <!-- read properties from the commons build.properties, if any -->
<property name="commons-propfile" value="${basedir}/../build.properties"/> <property name="commons-propfile" value="${basedir}/../build.properties"/>
<property file="${commons-propfile}"/> <property file="${commons-propfile}"/>
<!-- read properties from the ${user.home}/propfile, if any --> <!-- read properties from the ${user.home}/propfile, if any -->
<property name="user-propfile" value="${user.home}/build.properties"/> <property name="user-propfile" value="${user.home}/build.properties"/>
<property file="${user-propfile}"/> <property file="${user-propfile}"/>
<!-- command line classpath, if any --> <!-- command line classpath, if any -->
<property name="cp" value=""/> <property name="cp" value=""/>
<!-- now combine the classpaths --> <!-- now combine the classpaths -->
<property name="classpath" value="${cp}:${junit.jar}"/> <property name="classpath" value="${cp}:${junit.jar}"/>
<property name="name" value="commons-collections"/> <property name="name" value="commons-collections"/>
<property name="Name" value="Commons-Collections"/> <property name="Name" value="Commons-Collections"/>
<property name="Name-Long" value="Jakarta Commons Collections Package"/> <property name="Name-Long" value="Jakarta Commons Collections Package"/>
<!-- The current version number of this component --> <!-- The current version number of this component -->
<property name="component.version" value="1.1-dev"/> <property name="component.version" value="1.1-dev"/>
<property name="test.entry" value="org.apache.commons.collections.TestAll"/> <property name="test.entry" value="org.apache.commons.collections.TestAll"/>
<property name="test.failonerror" value="true" /> <property name="test.failonerror" value="true" />
<property name="test.runner" value="junit.textui.TestRunner" /> <property name="test.runner" value="junit.textui.TestRunner" />
<property name="workdir" value="${java.io.tmpdir}/buildtemp_${DSTAMP}${TSTAMP}"/> <property name="workdir" value="${java.io.tmpdir}/buildtemp_${DSTAMP}${TSTAMP}"/>
<property name="source" value="${basedir}"/> <property name="source" value="${basedir}"/>
<property name="source.src" value="${basedir}/src"/> <property name="source.src" value="${basedir}/src"/>
<property name="source.src.java" value="${source.src}/java"/> <property name="source.src.java" value="${source.src}/java"/>
<property name="source.src.test" value="${source.src}/test"/> <property name="source.src.test" value="${source.src}/test"/>
<property name="source.doc" value="${basedir}/doc"/> <property name="source.doc" value="${basedir}/doc"/>
<property name="dest" value="${basedir}/dist"/> <property name="dest" value="${basedir}/dist"/>
<property name="dest.classes" value="${dest}/classes"/> <property name="dest.classes" value="${dest}/classes"/>
<property name="dest.doc" value="${dest}/docs"/> <property name="dest.doc" value="${dest}/docs"/>
<property name="dest.doc.api" value="${dest.doc}/api"/> <property name="dest.doc.api" value="${dest.doc}/api"/>
<property name="dest.jardir" value="${dest}"/> <property name="dest.jardir" value="${dest}"/>
<property name="dest.jardir.jar" value="${dest.jardir}/${name}.jar"/> <property name="dest.jardir.jar" value="${dest.jardir}/${name}.jar"/>
<available property="available-doc" file="${source.doc}"/> <!-- does this module have docs? --> <available property="available-doc" file="${source.doc}"/> <!-- does this module have docs? -->
<available property="available-src-java" file="${source.src.java}"/> <!-- does this module have java src? --> <available property="available-src-java" file="${source.src.java}"/> <!-- does this module have java src? -->
<available property="available-src-test" file="${source.src.test}"/> <!-- does this module have test src? --> <available property="available-src-test" file="${source.src.test}"/> <!-- does this module have test src? -->
</target> </target>
<!-- ######################################################### --> <!-- ######################################################### -->
<target name="copy-javadoc-source" depends="init" if="available-src-java"> <target name="copy-javadoc-source" depends="init" if="available-src-java">
<mkdir dir="${javadoc-source-dir}"/> <mkdir dir="${javadoc-source-dir}"/>
<copy todir="${javadoc-source-dir}" filtering="no"> <copy todir="${javadoc-source-dir}" filtering="no">
<fileset dir="${source.src.java}"> <fileset dir="${source.src.java}">
<patternset refid="patternset-javadocable-sources"/> <patternset refid="patternset-javadocable-sources"/>
</fileset> </fileset>
</copy> </copy>
</target> </target>
<target name="copy-doc" depends="init" if="available-doc"> <target name="copy-doc" depends="init" if="available-doc">
<mkdir dir="${doc-source-dir}/${name}"/> <mkdir dir="${doc-source-dir}/${name}"/>
<copy todir="${doc-source-dir}/${name}" filtering="no"> <copy todir="${doc-source-dir}/${name}" filtering="no">
<fileset dir="${source.doc}"> <fileset dir="${source.doc}">
<patternset refid="patternset-doc"/> <patternset refid="patternset-doc"/>
</fileset> </fileset>
</copy> </copy>
</target> </target>
<!-- ######################################################### --> <!-- ######################################################### -->
<target name="clean" depends="init" description="removes generated files"> <target name="clean" depends="init" description="removes generated files">
<delete dir="${dest}"/> <delete dir="${dest}"/>
</target> </target>
<target name="clean-doc" depends="init,clean-javadoc"> <target name="clean-doc" depends="init,clean-javadoc">
<delete dir="${dest.doc}"/> <delete dir="${dest.doc}"/>
</target> </target>
<target name="clean-javadoc" depends="init"> <target name="clean-javadoc" depends="init">
<delete dir="${dest.doc.api}"/> <delete dir="${dest.doc.api}"/>
</target> </target>
<target name="clean-build" depends="init"> <target name="clean-build" depends="init">
<delete dir="${dest.classes}"/> <delete dir="${dest.classes}"/>
</target> </target>
<target name="clean-dist" depends="init"> <target name="clean-dist" depends="init">
<delete file="${dest.jardir.jar}"/> <delete file="${dest.jardir.jar}"/>
</target> </target>
<!-- ######################################################### --> <!-- ######################################################### -->
<target name="doc" depends="init,doc-top,doc-copy,doc-javadoc" description="generates javadocs and other documentation"> <target name="doc" depends="init,doc-top,doc-copy,doc-javadoc" description="generates javadocs and other documentation">
</target> </target>
<target name="doc-top" depends="init"> <target name="doc-top" depends="init">
<mkdir dir="${dest}"/> <mkdir dir="${dest}"/>
<copy todir="${dest}" file="../LICENSE"/> <copy todir="${dest}" file="../LICENSE"/>
</target> </target>
<target name="doc-copy" depends="init" if="available-doc"> <target name="doc-copy" depends="init" if="available-doc">
<mkdir dir="${dest.doc}"/> <mkdir dir="${dest.doc}"/>
<copy todir="${dest.doc}"> <copy todir="${dest.doc}">
<fileset dir="${source.doc}"> <fileset dir="${source.doc}">
<patternset refid="patternset-doc"/> <patternset refid="patternset-doc"/>
</fileset> </fileset>
</copy> </copy>
</target> </target>
<target name="doc-javadoc" depends="init" if="available-src-java"> <target name="doc-javadoc" depends="init" if="available-src-java">
<!-- copy all the non-test sources out to the work directory and javadoc that --> <!-- copy all the non-test sources out to the work directory and javadoc that -->
<mkdir dir="${workdir}"/> <mkdir dir="${workdir}"/>
<copy todir="${workdir}"> <copy todir="${workdir}">
<fileset dir="${source.src.java}"> <fileset dir="${source.src.java}">
<patternset refid="patternset-javadocable-sources"/> <patternset refid="patternset-javadocable-sources"/>
</fileset> </fileset>
</copy> </copy>
<mkdir dir="${dest.doc.api}"/> <mkdir dir="${dest.doc.api}"/>
<javadoc packagenames="org.*" <javadoc packagenames="org.*"
sourcepath="${workdir}" sourcepath="${workdir}"
destdir="${dest.doc.api}" destdir="${dest.doc.api}"
windowtitle="${Name-Long}" windowtitle="${Name-Long}"
doctitle="${Name-Long}" doctitle="${Name-Long}"
bottom="&lt;small&gt;Copyright &amp;copy; 2001 Apache Software Foundation. Documenation generated ${TODAY}&lt;/small&gt;." bottom="&lt;small&gt;Copyright &amp;copy; 2001 Apache Software Foundation. Documenation generated ${TODAY}&lt;/small&gt;."
public="true" public="true"
version="true" version="true"
author="true" author="true"
splitindex="false" overview="${source.src.java}/org/apache/commons/collections/package.html"
nodeprecated="true" splitindex="false"
nodeprecatedlist="true" nodeprecated="true"
notree="true" nodeprecatedlist="true"
noindex="false" notree="true"
nohelp="true" noindex="false"
nonavbar="false" nohelp="true"
serialwarn="false"> nonavbar="false"
<link href="http://java.sun.com/products/jdk/1.3/docs/api"/> serialwarn="false">
</javadoc> <group title="Jakarta-commons Collections" packages="org.apache.commons.collections"/>
<delete dir="${workdir}"/> <link href="http://java.sun.com/products/jdk/1.3/docs/api"/>
</target> </javadoc>
<delete dir="${workdir}"/>
<!-- ######################################################### --> </target>
<target name="build" depends="init,build-java" description="compiles source files"/> <!-- ######################################################### -->
<target name="build-java" depends="init" if="available-src-java"> <target name="build" depends="init,build-java" description="compiles source files"/>
<mkdir dir="${dest.classes}"/>
<javac destdir="${dest.classes}" <target name="build-java" depends="init" if="available-src-java">
srcdir="${source.src.java}" <mkdir dir="${dest.classes}"/>
classpath="${classpath}" <javac destdir="${dest.classes}"
debug="false" srcdir="${source.src.java}"
deprecation="true" classpath="${classpath}"
optimize="true"/> debug="false"
</target> deprecation="true"
optimize="true"/>
<target name="build-test" depends="init,build-java" if="available-src-test"> </target>
<mkdir dir="${dest.classes}"/>
<javac destdir="${dest.classes}" <target name="build-test" depends="init,build-java" if="available-src-test">
srcdir="${source.src.test}" <mkdir dir="${dest.classes}"/>
classpath="${classpath}" <javac destdir="${dest.classes}"
debug="false" srcdir="${source.src.test}"
deprecation="true" classpath="${classpath}"
optimize="true"/> debug="false"
</target> deprecation="true"
optimize="true"/>
<!-- ######################################################### --> </target>
<target name="test" depends="build-test" if="test.entry" description="runs (junit) unit tests"> <!-- ######################################################### -->
<!--
<junit printsummary="yes" fork="on" haltonfailure="yes"> <target name="test" depends="build-test" if="test.entry" description="runs (junit) unit tests">
<formatter type="plain" usefile="false"/> <!--
<test name="${test.entry}"/> <junit printsummary="yes" fork="on" haltonfailure="yes">
<classpath> <formatter type="plain" usefile="false"/>
<pathelement location="${dest.classes}" /> <test name="${test.entry}"/>
<pathelement path="${classpath}" /> <classpath>
<pathelement path="${java.class.path}" /> <pathelement location="${dest.classes}" />
</classpath> <pathelement path="${classpath}" />
</junit> <pathelement path="${java.class.path}" />
--> </classpath>
</junit>
<java classname="${test.runner}" fork="yes" failonerror="${test.failonerror}"> -->
<arg value="${test.entry}"/>
<classpath> <java classname="${test.runner}" fork="yes" failonerror="${test.failonerror}">
<pathelement location="${dest.classes}" /> <arg value="${test.entry}"/>
<pathelement path="${classpath}" /> <classpath>
<pathelement path="${java.class.path}" /> <pathelement location="${dest.classes}" />
</classpath> <pathelement path="${classpath}" />
</java> <pathelement path="${java.class.path}" />
</target> </classpath>
</java>
<!-- ######################################################### --> </target>
<target name="dist" depends="dist-jar,doc" description="builds binary distribution"/> <!-- ######################################################### -->
<target name="dist-jar" depends="build"> <target name="dist" depends="dist-jar,doc" description="builds binary distribution"/>
<mkdir dir="${dest.jardir}"/>
<mkdir dir="${workdir}"/> <target name="dist-jar" depends="build">
<copy todir="${workdir}"> <mkdir dir="${dest.jardir}"/>
<fileset dir="${dest.classes}"> <mkdir dir="${workdir}"/>
<patternset refid="patternset-non-test-classes"/> <copy todir="${workdir}">
</fileset> <fileset dir="${dest.classes}">
</copy> <patternset refid="patternset-non-test-classes"/>
<jar jarfile="${dest.jardir.jar}" manifest="${source.src}/conf/MANIFEST.MF"> </fileset>
<fileset dir="${workdir}"/> </copy>
</jar> <jar jarfile="${dest.jardir.jar}" manifest="${source.src}/conf/MANIFEST.MF">
<delete dir="${workdir}"/> <fileset dir="${workdir}"/>
<delete dir="${dest.classes}"/> </jar>
</target> <delete dir="${workdir}"/>
<delete dir="${dest.classes}"/>
<!-- ######################################################### --> </target>
</project> <!-- ######################################################### -->
</project>

89
src/java/org/apache/commons/collections/package.html
View File

@ -1,4 +1,4 @@
<!-- $Id: package.html,v 1.2 2001/05/04 16:32:15 rwaldhoff Exp $ --> <!-- $Id: package.html,v 1.3 2001/08/17 23:00:26 rwaldhoff Exp $ -->
<html> <html>
<head> <head>
<title>Package Documentation for org.apache.commons.collections</title> <title>Package Documentation for org.apache.commons.collections</title>
@ -10,5 +10,92 @@
<p> <p>
See also the <tt>java.util</tt> package. See also the <tt>java.util</tt> package.
</p> </p>
<table border="1" cellspacing="0" cellpadding="3">
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<th>Category</th><th>Classes</th><th>Comments</th>
</tr>
<tr>
<td valign="top">List Implementations</td>
<td>
{@link org.apache.commons.collections.CursorableLinkedList}<br>
{@link org.apache.commons.collections.FastArrayList}
</td>
<td valign="top">
Special-purpose implementations of the {@link
java.util.List} interface.
</td>
</tr>
<tr>
<td valign="top">Map Implementations</td>
<td>
{@link org.apache.commons.collections.BeanMap}<br>
{@link org.apache.commons.collections.DefaultMapEntry}<br>
{@link org.apache.commons.collections.ExtendedProperties}<br>
{@link org.apache.commons.collections.FastHashMap}<br>
{@link org.apache.commons.collections.FastTreeMap}<br>
{@link org.apache.commons.collections.LRUMap}<br>
{@link org.apache.commons.collections.SoftRefHashMap}
</td>
<td valign="top">
Special-purpose implementations of the {@link
java.util.Map} interface.
</td>
</tr>
<tr>
<td valign="top">Stack and Queue Implementations</td>
<td>
{@link org.apache.commons.collections.ArrayStack}<br>
{@link org.apache.commons.collections.BinaryHeap}<br>
{@link org.apache.commons.collections.PriorityQueue}<br>
{@link org.apache.commons.collections.SynchronizedPriorityQueue}
</td>
<td valign="top">
Special-purpose implementations of the {@link
java.util.Stack} interface, as well as similar {@link
org.apache.commons.collections.PriorityQueue}
interface.
</td>
</tr>
<tr>
<td valign="top">Adapters</td>
<td>
{@link org.apache.commons.collections.ArrayEnumeration}<br>
{@link org.apache.commons.collections.ArrayIterator}<br>
{@link org.apache.commons.collections.EnumerationIterator}<br>
{@link org.apache.commons.collections.IteratorEnumeration}
</td>
<td valign="top">
Access Java1-style containers as though they were
Java2-style Collections and vice-versa.
</td>
</tr>
<tr>
<td valign="top">Utilities</td>
<td valign="top">
{@link org.apache.commons.collections.Closure}<br>
{@link org.apache.commons.collections.CollectionUtils}<br>
{@link org.apache.commons.collections.MapUtils}
</td>
<td valign="top">
Manipulate collection objects, determine set theoretic
properties, ensure type-safety, etc.
</td>
</tr>
<tr>
<td valign="top">Transformation Tools</td>
<td valign="top">
{@link org.apache.commons.collections.FilterIterator}<br>
{@link org.apache.commons.collections.Predicate}<br>
{@link org.apache.commons.collections.ProxyIterator}<br>
{@link org.apache.commons.collections.Transformer}<br>
{@link org.apache.commons.collections.TransformIterator}
</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>.
</td>
</tr>
</table>
</body> </body>
</html> </html>