Attached is a patch to fix a bunch of minor javadoc errors and a couple
missing bits of info that prompted me to look at the code.
-Mark
Index: src/java/org/apache/avalon/excalibur/component/PoolableComponentHandler.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/component/PoolableComponentHandler.java,v
retrieving revision 1.9
diff -u -r1.9 PoolableComponentHandler.java
--- src/java/org/apache/avalon/excalibur/component/PoolableComponentHandler.java
20 Feb 2002 06:26:42 -0000 1.9
+++ src/java/org/apache/avalon/excalibur/component/PoolableComponentHandler.java
+ 22 Feb 2002 08:00:13 -0000
@@ -65,15 +65,19 @@
* will be thrown. A value of "0" specifies that the block will never timeout.
* (Defaults to "0")</li>
*
- * <li>The <code>pool-trim-interval</code> attribute is used to specify how long idle
Poolables
- * will be maintained in the pool before being closed. For a complete explanation
on how this
- * works, see {@link org.apache.avalon.excalibur.pool.ResourceLimitingPool#trim()}
- * (Defaults to "0", trimming disabled)</li>
+ * <li>The <code>pool-trim-interval</code> attribute is used to
+ * specify, in milliseconds, how long idle Poolables will be
+ * maintained in the pool before being closed. For a complete
+ * explanation on how this works, see {@link
+ * org.apache.avalon.excalibur.pool.ResourceLimitingPool#trim()}
+ * (Defaults to "0", trimming disabled)</li>
*
- * <li>The <code>pool-min</code> and <code>pool-grow</code> attributes were
deprecated as the
- * underlying Pool ({@link org.apache.avalon.excalibur.pool.ResourceLimitingPool})
does not make
- * use of them. Configurations which still use these attributes will continue to
function
- * however, a minimum pool size is no longer applicable.
+ * <li>The <code>pool-min</code> and <code>pool-grow</code> attributes
+ * were deprecated as the underlying Pool ({@link
+ * org.apache.avalon.excalibur.pool.ResourceLimitingPool}) does not
+ * make use of them. Configurations which still use these attributes
+ * will continue to function however, a minimum pool size is no longer
+ * applicable.
*
* </ul>
*
Index: src/java/org/apache/avalon/excalibur/datasource/JdbcConnectionFactory.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/datasource/JdbcConnectionFactory.java,v
retrieving revision 1.10
diff -u -r1.10 JdbcConnectionFactory.java
--- src/java/org/apache/avalon/excalibur/datasource/JdbcConnectionFactory.java 26 Jan
2002 16:58:06 -0000 1.10
+++ src/java/org/apache/avalon/excalibur/datasource/JdbcConnectionFactory.java 22 Feb
+2002 08:00:13 -0000
@@ -47,8 +47,8 @@
}
/**
- * @ deprecated Use the new constructor with the keepalive and connectionClass
- * specified.
+ * @deprecated Use the new constructor with the keepalive and connectionClass
+ * specified.
*/
public JdbcConnectionFactory( final String url,
final String username,
Index: src/java/org/apache/avalon/excalibur/pool/ResourceLimitingPool.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/pool/ResourceLimitingPool.java,v
retrieving revision 1.1
diff -u -r1.1 ResourceLimitingPool.java
--- src/java/org/apache/avalon/excalibur/pool/ResourceLimitingPool.java 18 Feb 2002
06:16:06 -0000 1.1
+++ src/java/org/apache/avalon/excalibur/pool/ResourceLimitingPool.java 22 Feb 2002
+08:00:13 -0000
@@ -167,7 +167,7 @@
* created. Depending on the parameters to the constructor, the method may
block or throw
* an exception if a Poolable is not available on the pool.
*
- * @returns Always returns a Poolable. Contract requires that put must always be
called with
+ * @return Always returns a Poolable. Contract requires that put must always be
+called with
* the Poolable returned.
* @throws Exception An exception may be thrown as described above or if there is
an exception
* thrown by the ObjectFactory's newInstance() method.
@@ -523,7 +523,7 @@
* for long periods of time then if may be necessary to call this method
* manually.
* <p>
- * Trimming is done by maintaing two lists of objects. The first is a ready list
+ * Trimming is done by maintaining two lists of objects. The first is a ready
+list
* of new poolables. The second is a list of old poolables. Each time trim() is
* called, the contents of the old list are removed from the pool. Then the
* contents of the new list is moved into the old list.
@@ -542,7 +542,7 @@
* load will not have old poolables to be trimmed, and the benefits to system
* resources from not keeping around unused poolables makes up for any hit.
*
- * @returns the number of Poolables that were trimmed.
+ * @return the number of Poolables that were trimmed.
*/
public int trim()
{
Index: src/java/org/apache/avalon/excalibur/pool/Validatable.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/pool/Validatable.java,v
retrieving revision 1.1
diff -u -r1.1 Validatable.java
--- src/java/org/apache/avalon/excalibur/pool/Validatable.java 18 Feb 2002 06:16:06
-0000 1.1
+++ src/java/org/apache/avalon/excalibur/pool/Validatable.java 22 Feb 2002 08:00:13
+-0000
@@ -22,7 +22,7 @@
/**
* Called when an object is retrieved from a ValidatedResourceLimitingPool for
reuse.
*
- * @returns true if the object is ok. false will cause the object to be
discarded.
+ * @return true if the object is ok. false will cause the object to be discarded.
*/
boolean validate();
}
Index: src/java/org/apache/avalon/excalibur/pool/ValidatedResourceLimitingPool.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/pool/ValidatedResourceLimitingPool.java,v
retrieving revision 1.1
diff -u -r1.1 ValidatedResourceLimitingPool.java
--- src/java/org/apache/avalon/excalibur/pool/ValidatedResourceLimitingPool.java
18 Feb 2002 06:16:06 -0000 1.1
+++ src/java/org/apache/avalon/excalibur/pool/ValidatedResourceLimitingPool.java
+ 22 Feb 2002 08:00:13 -0000
@@ -68,7 +68,7 @@
* created. Depending on the parameters to the constructor, the method may
block or throw
* an exception if a Poolable is not available on the pool.
*
- * @returns Always returns a Poolable. Contract requires that put must always be
called with
+ * @return Always returns a Poolable. Contract requires that put must always be
+called with
* the Poolable returned.
* @throws Exception An exception may be thrown as described above or if there is
an exception
* thrown by the ObjectFactory's newInstance() method.
@@ -150,7 +150,7 @@
* This method is only called by threads that have m_semaphore locked.
*
* @param poolable The Poolable to be validated
- * @returns true if the Poolable is valid, false if it should be removed from the
pool.
+ * @return true if the Poolable is valid, false if it should be removed from the
+pool.
*/
protected boolean validatePoolable(Poolable poolable) throws Exception
{
Index: src/java/org/apache/avalon/excalibur/testcase/LatchedThreadGroup.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/testcase/LatchedThreadGroup.java,v
retrieving revision 1.2
diff -u -r1.2 LatchedThreadGroup.java
--- src/java/org/apache/avalon/excalibur/testcase/LatchedThreadGroup.java 20 Feb
2002 15:41:05 -0000 1.2
+++ src/java/org/apache/avalon/excalibur/testcase/LatchedThreadGroup.java 22 Feb
+2002 08:00:14 -0000
@@ -87,7 +87,7 @@
* Causes all of the Runnables to start at the same instance. This method will
return
* once all of the Runnables have completed.
*
- * @returns time, in milliseconds, that it took for all of the Runnables to
complete.
+ * @return time, in milliseconds, that it took for all of the Runnables to
+complete.
*/
public long go()
throws Exception
Index:
src/scratchpad/org/apache/avalon/excalibur/datasource/ResourceLimitingJdbcConnectionPool.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/ResourceLimitingJdbcConnectionPool.java,v
retrieving revision 1.2
diff -u -r1.2 ResourceLimitingJdbcConnectionPool.java
---
src/scratchpad/org/apache/avalon/excalibur/datasource/ResourceLimitingJdbcConnectionPool.java
25 Jan 2002 01:24:27 -0000 1.2
+++
+src/scratchpad/org/apache/avalon/excalibur/datasource/ResourceLimitingJdbcConnectionPool.java
+ 22 Feb 2002 08:00:14 -0000
@@ -96,7 +96,7 @@
* The pool is not locked by the current thread when this method is called.
*
* @param poolable The Poolable to be validated
- * @returns true if the Poolable is valid, false if it should be removed from the
pool.
+ * @return true if the Poolable is valid, false if it should be removed from the
+pool.
*/
protected boolean validatePoolable(Poolable poolable) {
JdbcConnection conn = (JdbcConnection)poolable;
Index:
src/scratchpad/org/apache/avalon/excalibur/datasource/cluster/AbstractDataSourceCluster.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/cluster/AbstractDataSourceCluster.java,v
retrieving revision 1.2
diff -u -r1.2 AbstractDataSourceCluster.java
---
src/scratchpad/org/apache/avalon/excalibur/datasource/cluster/AbstractDataSourceCluster.java
6 Feb 2002 08:37:05 -0000 1.2
+++
+src/scratchpad/org/apache/avalon/excalibur/datasource/cluster/AbstractDataSourceCluster.java
+ 22 Feb 2002 08:00:14 -0000
@@ -57,7 +57,7 @@
/**
* Returns the number of DataSources in the cluster.
*
- * @returns size of the cluster.
+ * @return size of the cluster.
*/
public int getClusterSize()
{
Index:
src/scratchpad/org/apache/avalon/excalibur/datasource/cluster/HashedDataSourceCluster.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/cluster/HashedDataSourceCluster.java,v
retrieving revision 1.1
diff -u -r1.1 HashedDataSourceCluster.java
---
src/scratchpad/org/apache/avalon/excalibur/datasource/cluster/HashedDataSourceCluster.java
4 Feb 2002 03:20:54 -0000 1.1
+++
+src/scratchpad/org/apache/avalon/excalibur/datasource/cluster/HashedDataSourceCluster.java
+ 22 Feb 2002 08:00:14 -0000
@@ -28,7 +28,7 @@
/**
* Returns the number of DataSources in the cluster.
*
- * @returns size of the cluster.
+ * @return size of the cluster.
*/
int getClusterSize();
Index:
src/scratchpad/org/apache/avalon/excalibur/datasource/cluster/IndexedDataSourceCluster.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/cluster/IndexedDataSourceCluster.java,v
retrieving revision 1.1
diff -u -r1.1 IndexedDataSourceCluster.java
---
src/scratchpad/org/apache/avalon/excalibur/datasource/cluster/IndexedDataSourceCluster.java
4 Feb 2002 03:20:54 -0000 1.1
+++
+src/scratchpad/org/apache/avalon/excalibur/datasource/cluster/IndexedDataSourceCluster.java
+ 22 Feb 2002 08:00:14 -0000
@@ -28,7 +28,7 @@
/**
* Returns the number of DataSources in the cluster.
*
- * @returns size of the cluster.
+ * @return size of the cluster.
*/
int getClusterSize();
Index:
src/scratchpad/org/apache/avalon/excalibur/datasource/ids/AbstractDataSourceBlockIdGenerator.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/ids/AbstractDataSourceBlockIdGenerator.java,v
retrieving revision 1.2
diff -u -r1.2 AbstractDataSourceBlockIdGenerator.java
---
src/scratchpad/org/apache/avalon/excalibur/datasource/ids/AbstractDataSourceBlockIdGenerator.java
8 Feb 2002 17:38:09 -0000 1.2
+++
+src/scratchpad/org/apache/avalon/excalibur/datasource/ids/AbstractDataSourceBlockIdGenerator.java
+ 22 Feb 2002 08:00:14 -0000
@@ -61,7 +61,7 @@
*
* @param blockSize number of Ids which are to be allocated.
*
- * @returns The first id in the allocated block.
+ * @return The first id in the allocated block.
*
* @throws IdException if there it was not possible to allocate a block of ids.
*/
@@ -73,7 +73,7 @@
*
* @param blockSize number of Ids which are to be allocated.
*
- * @returns The first id in the allocated block.
+ * @return The first id in the allocated block.
*
* @throws IdException if there it was not possible to allocate a block of ids.
*/
@@ -87,7 +87,7 @@
* Gets the next id as a Big Decimal. This method will only be called
* when synchronized and when the data type is configured to be BigDecimal.
*
- * @returns the next id as a BigDecimal.
+ * @return the next id as a BigDecimal.
*
* @throws IdException if an Id could not be allocated for any reason.
*/
@@ -124,7 +124,7 @@
* Gets the next id as a long. This method will only be called
* when synchronized and when the data type is configured to be long.
*
- * @returns the next id as a long.
+ * @return the next id as a long.
*
* @throws IdException if an Id could not be allocated for any reason.
*/
Index:
src/scratchpad/org/apache/avalon/excalibur/datasource/ids/AbstractIdGenerator.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/ids/AbstractIdGenerator.java,v
retrieving revision 1.1
diff -u -r1.1 AbstractIdGenerator.java
--- src/scratchpad/org/apache/avalon/excalibur/datasource/ids/AbstractIdGenerator.java
8 Feb 2002 12:27:32 -0000 1.1
+++ src/scratchpad/org/apache/avalon/excalibur/datasource/ids/AbstractIdGenerator.java
+ 22 Feb 2002 08:00:14 -0000
@@ -45,7 +45,7 @@
* Gets the next id as a Big Decimal. This method will only be called
* when synchronized and when the data type is configured to be BigDecimal.
*
- * @returns the next id as a BigDecimal.
+ * @return the next id as a BigDecimal.
*
* @throws IdException if an Id could not be allocated for any reason.
*/
@@ -56,7 +56,7 @@
* Gets the next id as a long. This method will only be called
* when synchronized and when the data type is configured to be long.
*
- * @returns the next id as a long.
+ * @return the next id as a long.
*
* @throws IdException if an Id could not be allocated for any reason.
*/
@@ -139,7 +139,7 @@
/**
* Returns the next Id from the pool.
*
- * @returns the next Id.
+ * @return the next Id.
*/
public final BigDecimal getNextBigDecimalId()
throws IdException
@@ -168,7 +168,7 @@
/**
* Returns the next Id from the pool.
*
- * @returns the next Id.
+ * @return the next Id.
*
* @throws IdException if the next id is outside of the range of valid longs.
*/
@@ -181,7 +181,7 @@
/**
* Returns the next Id from the pool.
*
- * @returns the next Id.
+ * @return the next Id.
*
* @throws IdException if the next id is outside of the range of valid integers.
*/
@@ -194,7 +194,7 @@
/**
* Returns the next Id from the pool.
*
- * @returns the next Id.
+ * @return the next Id.
*
* @throws IdException if the next id is outside of the range of valid shorts.
*/
@@ -207,7 +207,7 @@
/**
* Returns the next Id from the pool.
*
- * @returns the next Id.
+ * @return the next Id.
*
* @throws IdException if the next id is outside of the range of valid bytes.
*/
Index: src/scratchpad/org/apache/avalon/excalibur/datasource/ids/IdGenerator.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/ids/IdGenerator.java,v
retrieving revision 1.1
diff -u -r1.1 IdGenerator.java
--- src/scratchpad/org/apache/avalon/excalibur/datasource/ids/IdGenerator.java 8 Feb
2002 12:27:32 -0000 1.1
+++ src/scratchpad/org/apache/avalon/excalibur/datasource/ids/IdGenerator.java 22 Feb
+2002 08:00:14 -0000
@@ -27,7 +27,7 @@
/**
* Returns the next Id from the pool.
*
- * @returns the next Id.
+ * @return the next Id.
*/
BigDecimal getNextBigDecimalId()
throws IdException;
@@ -35,7 +35,7 @@
/**
* Returns the next Id from the pool.
*
- * @returns the next Id.
+ * @return the next Id.
*
* @throws IllegalStateException if the next id is outside of the range of valid
longs.
*/
@@ -45,7 +45,7 @@
/**
* Returns the next Id from the pool.
*
- * @returns the next Id.
+ * @return the next Id.
*
* @throws IllegalStateException if the next id is outside of the range of valid
integers.
*/
@@ -55,7 +55,7 @@
/**
* Returns the next Id from the pool.
*
- * @returns the next Id.
+ * @return the next Id.
*
* @throws IllegalStateException if the next id is outside of the range of valid
shorts.
*/
@@ -65,7 +65,7 @@
/**
* Returns the next Id from the pool.
*
- * @returns the next Id.
+ * @return the next Id.
*
* @throws IllegalStateException if the next id is outside of the range of valid
bytes.
*/
Index:
src/scratchpad/org/apache/avalon/excalibur/datasource/ids/SequenceIdGenerator.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/ids/SequenceIdGenerator.java,v
retrieving revision 1.1
diff -u -r1.1 SequenceIdGenerator.java
--- src/scratchpad/org/apache/avalon/excalibur/datasource/ids/SequenceIdGenerator.java
8 Feb 2002 12:27:32 -0000 1.1
+++ src/scratchpad/org/apache/avalon/excalibur/datasource/ids/SequenceIdGenerator.java
+ 22 Feb 2002 08:00:14 -0000
@@ -78,7 +78,7 @@
* Gets the next id as a Big Decimal. This method will only be called
* when synchronized and when the data type is configured to be BigDecimal.
*
- * @returns the next id as a BigDecimal.
+ * @return the next id as a BigDecimal.
*
* @throws IdException if an Id could not be allocated for any reason.
*/
@@ -123,7 +123,7 @@
* Gets the next id as a long. This method will only be called
* when synchronized and when the data type is configured to be long.
*
- * @returns the next id as a long.
+ * @return the next id as a long.
*
* @throws IdException if an Id could not be allocated for any reason.
*/
Index: src/scratchpad/org/apache/avalon/excalibur/datasource/ids/TableIdGenerator.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/ids/TableIdGenerator.java,v
retrieving revision 1.3
diff -u -r1.3 TableIdGenerator.java
--- src/scratchpad/org/apache/avalon/excalibur/datasource/ids/TableIdGenerator.java
14 Feb 2002 05:12:57 -0000 1.3
+++ src/scratchpad/org/apache/avalon/excalibur/datasource/ids/TableIdGenerator.java
+ 22 Feb 2002 08:00:15 -0000
@@ -98,7 +98,7 @@
* @param blockSize number of ids to allocate.
* @param useBigDecimals returns the first id as a BigDecimal if true, otherwise
as a Long.
*
- * @returns either a Long or a BigDecimal depending on the value of useBigDecimals
+ * @return either a Long or a BigDecimal depending on the value of useBigDecimals
*
* @throws IdException if a block of ids can not be allocated.
*/
@@ -254,7 +254,7 @@
* @param blockSize number of ids to allocate.
* @param useBigDecimals returns the first id as a BigDecimal if true, otherwise
as a Long.
*
- * @returns either a Long or a BigDecimal depending on the value of useBigDecimals
+ * @return either a Long or a BigDecimal depending on the value of useBigDecimals
*
* @throws IdException if a block of ids can not be allocated.
*/
@@ -353,7 +353,7 @@
*
* @param blockSize number of Ids which are to be allocated.
*
- * @returns The first id in the allocated block.
+ * @return The first id in the allocated block.
*
* @throws IdException if there it was not possible to allocate a block of ids.
*/
@@ -379,7 +379,7 @@
*
* @param blockSize number of Ids which are to be allocated.
*
- * @returns The first id in the allocated block.
+ * @return The first id in the allocated block.
*
* @throws IdException if there it was not possible to allocate a block of ids.
*/
Index: src/scratchpad/org/apache/avalon/excalibur/util/ComponentStateValidator.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/util/ComponentStateValidator.java,v
retrieving revision 1.9
diff -u -r1.9 ComponentStateValidator.java
--- src/scratchpad/org/apache/avalon/excalibur/util/ComponentStateValidator.java
8 Feb 2002 17:40:03 -0000 1.9
+++ src/scratchpad/org/apache/avalon/excalibur/util/ComponentStateValidator.java
+ 22 Feb 2002 08:00:17 -0000
@@ -854,7 +854,7 @@
/**
* Checks to see if the state is active, and returns true or false.
*
- * @returns <code>true</code> if active, <code>false</code> if not
+ * @return <code>true</code> if active, <code>false</code> if not
*/
public boolean isActive()
{
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
