-- 
dIon Gillard, Multitask Consulting
http://www.multitask.com.au/developers
<?xml version="1.0" encoding="UTF-8" ?>

<document>

    <properties>
        <title>The Jakarta Commons Pool Package</title>
        <author email="[EMAIL PROTECTED]">Commons Documentation Team</author>
    </properties>

    <body>
    
        <section name="Introduction">
            <p>The <em>Pool</em> package defines a generalized object pooling interfaces,
            and provides several general-purpose implementations.
            The following major classes are provided:
            </p>

            <ul>
                <li><strong>ObjectPool</strong> - the basic pooling interface, defining
                    borrowObject, returnObject and several optional methods.
                </li>
                <li><strong>KeyedObjectPool</strong> - a pooling interface that supports pooling
                    multiple <em>typed</em> objects.
                </li>
                <li><strong>PoolableObjectFactory</strong> - interface defining
                    lifecycle methods for object instances used within an ObjectPool.
                </li>
                <li><strong>KeyedPoolableObjectFactory</strong> - interface defining
                    lifecycle methods for object instances used within a KeyedObjectPool.
                </li>
                <li><strong>StackObjectPool/StackKeyedObjectPool</strong> - implementations
                    of ObjectPool and KeyedObjectPool backed by a simple Stack of
                    pooled instances
                </li>
                <li><strong>GenericObjectPool/GenericKeyedObjectPool</strong> - more
                    complex implementations of ObjectPool and KeyedObjectPool, supporting
                    asynchronous eviction of pooled instances, etc.
                </li>
            </ul>

        </section>

        <section name="Dependencies">
            <p>The <em>Pool</em> package is dependent upon the following external
            components for development and use:</p>
            <ul>
            <li><a href="http://java.sun.com/j2se";>Java Development Kit</a>
                (Version 1.2 or later)</li>
            <li>Jakarta-Commons Collections package (Version 1.0 or later)</li>
            <li><a href="http://www.junit.org";>JUnit Testing Framework</a>
                (Version 3.2 or later) - for unit tests only, not required
                for deployment</li>
            </ul>
        </section>

        <section name="Release Info">
            <p>Current Release:  <strong>Unreleased, CVS Repository Only</strong></p>

            <p>Planned Next Release:  TBD</p>
        </section>

        <section name="Committers">
            <p>The following individuals are the primary developers and maintainers of this
            component.  Developers who plan to use the <em>Pool</em> package in their own
            projects are encouraged to collaborate on the future development of this
            component to ensure that it continues to meet a variety of needs.</p>

            <ul>
               <li><a href="mailto:[EMAIL PROTECTED]";>Morgan Delagrange</a></li>
               <li><a href="mailto:[EMAIL PROTECTED]";>Geir Magnusson Jr.</a></li>
               <li><a href="mailto:[EMAIL PROTECTED]";>Craig McClanahan</a></li>
               <li><a href="mailto:[EMAIL PROTECTED]";>Rodney Waldhoff</a></li>
               <li><a href="mailto:[EMAIL PROTECTED]";>David Weinrich</a></li>
            </ul>
        </section>

        <section name="Action Items">
            <p>The following action items need to be completed prior to a Version 1.0
            release of this component:</p>

            <table border="1">
              <tr>
                <th width="80%">Action Item</th>
                <th width="20%">Volunteer</th>
              </tr>

              <tr>
                <td><strong>Weak-Reference Based Pools</strong> - pool implementations
                that keep weak references to the pooled instances, evicting objects
                when the VM needs memory</td>
                <td align="center">&amp;nbsp;</td>
              </tr>

              <tr>
                <td><strong>Install / Use Documentation</strong>.  Expanded examples and
                installation documentation. </td>
                <td align="center">&amp;nbsp;</td>
              </tr>

            </table>
        </section>
        
    </body>
 
</document>
--
To unsubscribe, e-mail:   <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>

Reply via email to