Minor doc typos (patch from Ian Darwin)
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@130824 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne
parent
472cf4f569
commit
69fd9cfaf1
174
PROPOSAL.html
174
PROPOSAL.html
|
|
@ -1,87 +1,87 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<title>Proposal for Collections Package</title>
|
<title>Proposal for Collections Package</title>
|
||||||
</head>
|
</head>
|
||||||
<body bgcolor="white">
|
<body bgcolor="white">
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<h1>Proposal for <em>Collections</em> Package</h1>
|
<h1>Proposal for <em>Collections</em> Package</h1>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<h3>(0) Rationale</h3>
|
<h3>(0) Rationale</h3>
|
||||||
<p>
|
<p>
|
||||||
The Java Collections Framework provides a set of abstract data
|
The Java Collections Framework provides a set of abstract data
|
||||||
type interfaces and implementations that offer both a wealth
|
type interfaces and implementations that offer both a wealth
|
||||||
of useful functionality, and a solid foundation for extending
|
of useful functionality, and a solid foundation for extending
|
||||||
that functionality.
|
that functionality.
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
Many Jakarta projects have needs or design criteria that extend
|
Many Jakarta projects have needs or design criteria that extend
|
||||||
beyond the core Collections API, such as introducing new abstract
|
beyond the core Collections API, such as introducing new abstract
|
||||||
data types (e.g., Avalon's BinaryHeap) or changing the behaviour of
|
data types (e.g., Avalon's BinaryHeap) or changing the behaviour of
|
||||||
existing abstract data types (e.g., Struts' FastHashMap).
|
existing abstract data types (e.g., Struts' FastHashMap).
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
In keeping with the spirit of the Collections API and of abstract
|
In keeping with the spirit of the Collections API and of abstract
|
||||||
data types in general, these components can and should be shared
|
data types in general, these components can and should be shared
|
||||||
assets. A Commons package for abstract data types would provide
|
assets. A Commons package for abstract data types would
|
||||||
encourage the development and reuse of a robust set of collections
|
encourage the development and reuse of a robust set of collections
|
||||||
classes.
|
classes.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h3>(1) Scope of the Package</h3>
|
<h3>(1) Scope of the Package</h3>
|
||||||
<p>
|
<p>
|
||||||
The package will create and maintain a set of collections and
|
The package will create and maintain a set of collections and
|
||||||
related classes designed to be compatible with the Java Collections
|
related classes designed to be compatible with the Java Collections
|
||||||
Framework, and to be distributed under the ASF license.
|
Framework, and to be distributed under the ASF license.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h3>(1.5) Interaction With Other Packages</h3>
|
<h3>(1.5) Interaction With Other Packages</h3>
|
||||||
|
|
||||||
<p><em>Collections</em> relies only on standard JDK 1.2 (or later) APIs for
|
<p><em>Collections</em> relies only on standard JDK 1.2 (or later) APIs for
|
||||||
production deployment. It utilizes the JUnit unit testing framework for
|
production deployment. It utilizes the JUnit unit testing framework for
|
||||||
developing and executing unit tests, but this is of interest only to
|
developing and executing unit tests, but this is of interest only to
|
||||||
developers of the component. Collections will also be a dependency for
|
developers of the component. Collections will also be a dependency for
|
||||||
several future proposed components for the Jakarta Commons subproject.
|
several future proposed components for the Jakarta Commons subproject.
|
||||||
|
|
||||||
<p>No external configuration files are utilized.</p>
|
<p>No external configuration files are utilized.</p>
|
||||||
|
|
||||||
<h3>(2) Initial Source of the Package</h3>
|
<h3>(2) Initial Source of the Package</h3>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
The initial codebase was harvested from existing and purposed
|
The initial codebase was harvested from existing and proposed
|
||||||
Jakarta packages, including the Commons Database Connection Pool,
|
Jakarta packages, including the Commons Database Connection Pool,
|
||||||
Struts, and Avalon.
|
Struts, and Avalon.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p>The proposed package name for the new component is
|
<p>The proposed package name for the new component is
|
||||||
<code>org.apache.commons.collections</code>.</p>
|
<code>org.apache.commons.collections</code>.</p>
|
||||||
|
|
||||||
|
|
||||||
<h3>(3) Required Jakarta-Commons Resources</h3>
|
<h3>(3) Required Jakarta-Commons Resources</h3>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li>CVS Repository - New directory <code>collections</code> in the
|
<li>CVS Repository - New directory <code>collections</code> in the
|
||||||
<code>jakarta-commons</code> CVS repository. All initial committers
|
<code>jakarta-commons</code> CVS repository. All initial committers
|
||||||
are already committers on <code>jakarta-commons</code>, so no
|
are already committers on <code>jakarta-commons</code>, so no
|
||||||
additional user setups are required.</li>
|
additional user setups are required.</li>
|
||||||
<li>Mailing List - Discussions will take place on the general
|
<li>Mailing List - Discussions will take place on the general
|
||||||
<em>jakarta-commons@jakarta.apache.org</em> mailing list. To help
|
<em>jakarta-commons@jakarta.apache.org</em> mailing list. To help
|
||||||
list subscribers identify messages of interest, it is suggested that
|
list subscribers identify messages of interest, it is suggested that
|
||||||
the message subject of messages about this component be prefixed with
|
the message subject of messages about this component be prefixed with
|
||||||
[Collections].</li>
|
[Collections].</li>
|
||||||
<li>Bugzilla - New component "Collections" under the "Commons" product
|
<li>Bugzilla - New component "Collections" under the "Commons" product
|
||||||
category, with appropriate version identifiers as needed.</li>
|
category, with appropriate version identifiers as needed.</li>
|
||||||
<li>Jyve FAQ - New category "commons-collections" (when available).
|
<li>Jyve FAQ - New category "commons-collections" (when available).
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
<h3>(4) Initial Committers</h3>
|
<h3>(4) Initial Committers</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li>Peter Donald</li>
|
<li>Peter Donald</li>
|
||||||
<li>Craig McClanahan</li>
|
<li>Craig McClanahan</li>
|
||||||
<li>Rodney Waldhoff</li>
|
<li>Rodney Waldhoff</li>
|
||||||
<li>James Strachan</li>
|
<li>James Strachan</li>
|
||||||
</ul>
|
</ul>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue