You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by di...@apache.org on 2003/08/11 13:44:21 UTC
cvs commit: jakarta-commons/pool/xdocs index.xml
dirkv 2003/08/11 04:44:21
Modified: pool/xdocs index.xml
Log:
Use <source> and use jakarta.apache.org for javadoc links
Revision Changes Path
1.7 +32 -24 jakarta-commons/pool/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-commons/pool/xdocs/index.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- index.xml 9 May 2002 13:53:30 -0000 1.6
+++ index.xml 11 Aug 2003 11:44:21 -0000 1.7
@@ -31,53 +31,59 @@
<section name="Features">
<p>
The
- <a href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/package-summary.html">org.apache.commons.pool</a>
+ <a href="http://jakarta.apache.org/commons/pool/apidocs/org/apache/commons/pool/package-summary.html">org.apache.commons.pool</a>
package defines a handful of pooling interfaces and some base classes
that may be useful when creating new pool implementations.
</p>
<subsection name="ObjectPool">
<p>
- <a href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/ObjectPool.html"><code>ObjectPool</code></a>
+ <a href="http://jakarta.apache.org/commons/pool/apidocs/org/apache/commons/pool/ObjectPool.html"><code>ObjectPool</code></a>
defines a trivially simple pooling interface:
</p>
- <pre>public interface ObjectPool {
+<source>
+public interface ObjectPool {
Object borrowObject();
void returnObject(Object borrowed);
-}</pre>
+}
+</source>
<p>
Some client classes won't integrate with <i>Pool</i> any more than this.
Clients written to this interface can use arbitrary <code>ObjectPool</code>
implementations interchangeably.
</p>
<p>
- <a href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/BaseObjectPool.html"><code>BaseObjectPool</code></a>
+ <a href="http://jakarta.apache.org/commons/pool/apidocs/org/apache/commons/pool/BaseObjectPool.html"><code>BaseObjectPool</code></a>
provides an abstract base implementation of <code>ObjectPool</code>. Clients are
encouraged but not required to extend <code>BaseObjectPool</code> for new
<code>ObjectPool</code> implementations.
</p>
<p>
- <a href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/KeyedObjectPool.html"><code>KeyedObjectPool</code></a>
+ <a href="http://jakarta.apache.org/commons/pool/apidocs/org/apache/commons/pool/KeyedObjectPool.html"><code>KeyedObjectPool</code></a>
defines a similiar interface for pools composed of heterogenous objects:
</p>
- <pre>public interface KeyedObjectPool {
+<source>
+public interface KeyedObjectPool {
Object borrowObject(Object key);
void returnObject(Object key, Object borrowed);
-}</pre>
+}
+</source>
</subsection>
<subsection name="PoolableObjectFactory">
<p>
The <i>Pool</i> package makes it possible separate the way in which instances
are pooled from the way in which instances are created and destroyed.
- <a href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/PoolableObjectFactory.html"><code>PoolableObjectFactory</code></a>
+ <a href="http://jakarta.apache.org/commons/pool/apidocs/org/apache/commons/pool/PoolableObjectFactory.html"><code>PoolableObjectFactory</code></a>
supports this by providing a generic inteface for the lifecycle of a pooled object:
</p>
- <pre>public interface PoolableObjectFactory {
+<source>
+public interface PoolableObjectFactory {
Object makeObject();
void activateObject(Object obj);
void passivateObject(Object obj);
boolean validateObject(Object obj);
void destroyObject(Object obj);
-}</pre>
+}
+</source>
<p>
<code>ObjectPool</code> implementations may be written to accept arbitrary
<code>PoolableObjectFactory</code>s.
@@ -85,60 +91,62 @@
from the kinds of objects that are pooled.
</p>
<p>
- <a href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/BasePoolableObjectFactory.html"><code>BasePoolableObjectFactory</code></a>
+ <a href="http://jakarta.apache.org/commons/pool/apidocs/org/apache/commons/pool/BasePoolableObjectFactory.html"><code>BasePoolableObjectFactory</code></a>
provides an abstract base implementation of <code>PoolableObjectFactory</code> that
makes implementations a snap.
</p>
<p>
- <a href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/KeyedPoolableObjectFactory.html"><code>KeyedPoolableObjectFactory</code></a>
+ <a href="http://jakarta.apache.org/commons/pool/apidocs/org/apache/commons/pool/KeyedPoolableObjectFactory.html"><code>KeyedPoolableObjectFactory</code></a>
defines a similiar interface for <code>KeyedObjectPool</code>s:
</p>
- <pre>public interface KeyedPoolableObjectFactory {
+<source>
+public interface KeyedPoolableObjectFactory {
Object makeObject(Object key);
void activateObject(Object key, Object obj);
void passivateObject(Object key, Object obj);
boolean validateObject(Object key, Object obj);
void destroyObject(Object key, Object obj);
-}</pre>
+}
+</source>
<p>
- <a href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html"><code>BaseKeyedPoolableObjectFactory</code></a>
+ <a href="http://jakarta.apache.org/commons/pool/apidocs/org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html"><code>BaseKeyedPoolableObjectFactory</code></a>
provides an abstract base implementation of <code>KeyedPoolableObjectFactory</code> that
makes implementations a snap.
</p>
</subsection>
<p>
The
- <a href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/impl/package-summary.html">org.apache.commons.pool.impl</a>
+ <a href="http://jakarta.apache.org/commons/pool/apidocs/org/apache/commons/pool/impl/package-summary.html">org.apache.commons.pool.impl</a>
package provides some <i>Pool</i> implementations.
</p>
<subsection name="StackObjectPool">
<p>
- <a href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/impl/StackObjectPool.html"><code>StackObjectPool</code></a>
+ <a href="http://jakarta.apache.org/commons/pool/apidocs/org/apache/commons/pool/impl/StackObjectPool.html"><code>StackObjectPool</code></a>
will pool a finite number of "idle" instances, but will create new instances a needed in
order to support high demand.
</p>
<p>
- <a href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/impl/StackKeyedObjectPool.html"><code>StackKeyedObjectPool</code></a>
+ <a href="http://jakarta.apache.org/commons/pool/apidocs/org/apache/commons/pool/impl/StackKeyedObjectPool.html"><code>StackKeyedObjectPool</code></a>
offers the same behavior for keyed pools.
</p>
</subsection>
<subsection name="GenericObjectPool">
<p>
- <a href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/impl/GenericObjectPool.html"><code>GenericObjectPool</code></a>
+ <a href="http://jakarta.apache.org/commons/pool/apidocs/org/apache/commons/pool/impl/GenericObjectPool.html"><code>GenericObjectPool</code></a>
provides a wide variety of configuration options, including the ablity to cap the number of idle or
active instances, to evict instances as they sit idle in the pool, etc.
</p>
<p>
- <a href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/impl/GenericKeyedObjectPool.html"><code>GenericKeyedObjectPool</code></a>
+ <a href="http://jakarta.apache.org/commons/pool/apidocs/org/apache/commons/pool/impl/GenericKeyedObjectPool.html"><code>GenericKeyedObjectPool</code></a>
offers the same behavior for keyed pools.
</p>
</subsection>
<subsection name="SoftReferenceObjectPool">
<p>
- <a href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/impl/SoftReferenceObjectPool.html"><code>SoftReferenceObjectPool</code></a>
+ <a href="http://jakarta.apache.org/commons/pool/apidocs/org/apache/commons/pool/impl/SoftReferenceObjectPool.html"><code>SoftReferenceObjectPool</code></a>
can grow as needed, but allows the garbage collector to evict idle instances from the pool as needed.
</p>
</subsection>
</section>
</body>
-</document>
\ No newline at end of file
+</document>