Attached is a patch to fix a bunch of minor javadoc errors/stop javadoc
1.4 from complaining about -breakiterator, as well as adding a couple
missing bits of info that prompted me to look at the code. This patch
supercedes the previous patch I submitted.
BTW, it looks like a typo got commited: there's a
DjikstraSemaphore.java and a DijkstraSemaphore.java in
org.apache.avalon.excalibur.concurrent (dJI vs. dIJ).
The thought just occurred to me that it's still there because of
backwards compatibility and someone is actually using
DijkstraSemaphore... ;)
-Mark
Index: src/java/org/apache/avalon/excalibur/component/ComponentHandler.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/component/ComponentHandler.java,v
retrieving revision 1.6
diff -u -r1.6 ComponentHandler.java
--- src/java/org/apache/avalon/excalibur/component/ComponentHandler.java 20 Feb
2002 09:44:25 -0000 1.6
+++ src/java/org/apache/avalon/excalibur/component/ComponentHandler.java 23 Feb
+2002 12:03:59 -0000
@@ -203,8 +203,8 @@
/**
* Returns <code>true</code> if this component handler can safely be
- * disposed; i.e. none of the components it is handling are still
- * being used.
+ * disposed (i.e. none of the components it is handling are still
+ * being used).
*
* @return <code>true</code> if this component handler can safely be
* disposed; <code>false</code> otherwise
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
+ 23 Feb 2002 12:03:59 -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/concurrent/DijkstraSemaphore.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/concurrent/DijkstraSemaphore.java,v
retrieving revision 1.2
diff -u -r1.2 DijkstraSemaphore.java
--- src/java/org/apache/avalon/excalibur/concurrent/DijkstraSemaphore.java 11 Dec
2001 09:53:27 -0000 1.2
+++ src/java/org/apache/avalon/excalibur/concurrent/DijkstraSemaphore.java 23 Feb
+2002 12:03:59 -0000
@@ -38,9 +38,9 @@
* Creates a Djikstra semaphore with the specified max count and an initial
* count of acquire() operations that are assumed to have already been
* performed.
- * @param pMaxCount is the max semaphores that can be acquired
- * @pInitialCount is the current count (setting it to zero means all
- * semaphores have already been acquired). 0 <= pInitialCount <= pMaxCount
+ * @param maxCount is the max semaphores that can be acquired
+ * @param initialCount is the current count (setting it to zero means all
+ * semaphores have already been acquired). 0 <= initialCount <= maxCount
*/
public DijkstraSemaphore( int maxCount, int initialCount )
{
Index: src/java/org/apache/avalon/excalibur/concurrent/DjikstraSemaphore.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/concurrent/DjikstraSemaphore.java,v
retrieving revision 1.4
diff -u -r1.4 DjikstraSemaphore.java
--- src/java/org/apache/avalon/excalibur/concurrent/DjikstraSemaphore.java 11 Dec
2001 09:53:27 -0000 1.4
+++ src/java/org/apache/avalon/excalibur/concurrent/DjikstraSemaphore.java 23 Feb
+2002 12:03:59 -0000
@@ -36,9 +36,9 @@
* Creates a Djikstra semaphore with the specified max count and an initial
* count of acquire() operations that are assumed to have already been
* performed.
- * @param pMaxCount is the max semaphores that can be acquired
- * @pInitialCount is the current count (setting it to zero means all
- * semaphores have already been acquired). 0 <= pInitialCount <= pMaxCount
+ * @param maxCount is the max semaphores that can be acquired
+ * @param initialCount is the current count (setting it to zero means all
+ * semaphores have already been acquired). 0 <= initialCount <= maxCount
*/
public DjikstraSemaphore( int maxCount, int initialCount )
{
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 23 Feb
+2002 12:03:59 -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/io/FileUtil.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/io/FileUtil.java,v
retrieving revision 1.20
diff -u -r1.20 FileUtil.java
--- src/java/org/apache/avalon/excalibur/io/FileUtil.java 17 Feb 2002 09:12:48
-0000 1.20
+++ src/java/org/apache/avalon/excalibur/io/FileUtil.java 23 Feb 2002 12:03:59
+-0000
@@ -493,7 +493,8 @@
}
/**
- * Will concatenate 2 paths, dealing with <code>..</code>
+ * Will concatenate 2 paths. Paths with <code>..</code> will be
+ * properly handled.
* <p>Eg.,<br />
* <code>/a/b/c</code> + <code>d</code> = <code>/a/b/d</code><br />
* <code>/a/b/c</code> + <code>../d</code> = <code>/a/d</code><br />
Index: src/java/org/apache/avalon/excalibur/logger/factory/DatagramTargetFactory.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/logger/factory/DatagramTargetFactory.java,v
retrieving revision 1.6
diff -u -r1.6 DatagramTargetFactory.java
--- src/java/org/apache/avalon/excalibur/logger/factory/DatagramTargetFactory.java
9 Feb 2002 00:17:50 -0000 1.6
+++ src/java/org/apache/avalon/excalibur/logger/factory/DatagramTargetFactory.java
+ 23 Feb 2002 12:03:59 -0000
@@ -23,20 +23,18 @@
import java.net.UnknownHostException;
/**
- * DatagramTargetFactory
- *
- * This factory creates LogTargets with a wrapped DatagramOutputTarget around it:
- *
+ * This factory creates LogTargets with a wrapped DatagramOutputTarget around it.
+ * <p>
+ * Configuration syntax:
* <pre>
- *
* <datagram-target id="target-id">
* <address hostname="hostname" port="4455" />
* <format type="extended">
- * %7.7{priority} %23.23{time:yyyy-MM-dd HH:mm:ss:SSS}
[%25.25{category}] : %{message}\n%{throwable}
+ * %7.7{priority} %23.23{time:yyyy-MM-dd HH:mm:ss:SSS}
+[%25.25{category}] : %{message}\n%{throwable}
* </format>
* </datagram-target>
* </pre>
- *
+ * </p>
* <p>
* This factory creates a DatagramOutputTarget object which will
* sends datagrams to the specified address. The name of the target is specified by
the hostname attribute
Index: src/java/org/apache/avalon/excalibur/logger/factory/SocketTargetFactory.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/logger/factory/SocketTargetFactory.java,v
retrieving revision 1.2
diff -u -r1.2 SocketTargetFactory.java
--- src/java/org/apache/avalon/excalibur/logger/factory/SocketTargetFactory.java
9 Feb 2002 00:17:50 -0000 1.2
+++ src/java/org/apache/avalon/excalibur/logger/factory/SocketTargetFactory.java
+ 23 Feb 2002 12:03:59 -0000
@@ -10,24 +10,21 @@
import org.apache.avalon.framework.configuration.ConfigurationException;
/**
- * SocketTargetFactory
- *
- * This factory creates LogTargets with a wrapped SocketOutputTarget around it:
- *
+ * This factory creates LogTargets with a wrapped SocketOutputTarget around it.
+ * <p>
+ * Configuration syntax:
* <pre>
* <socket-target id="target-id">
* <address hostname="hostname" port="4455" />
* </socket-target>
* </pre>
- *
+ * </p>
* <p>
- *
* This factory creates a SocketOutputTarget object which will
* TCP/IP socket to communicate with the server. The name of the target is specified
by the
* hostname attribute of the <address> element and the port by the port
attribute.
* In the config file above the formatting for the log messages is not embedded as
it should
* be specified on the server side
- *
* </p>
*
*
Index: src/java/org/apache/avalon/excalibur/logger/factory/StreamTargetFactory.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/logger/factory/StreamTargetFactory.java,v
retrieving revision 1.3
diff -u -r1.3 StreamTargetFactory.java
--- src/java/org/apache/avalon/excalibur/logger/factory/StreamTargetFactory.java
19 Dec 2001 23:34:50 -0000 1.3
+++ src/java/org/apache/avalon/excalibur/logger/factory/StreamTargetFactory.java
+ 23 Feb 2002 12:03:59 -0000
@@ -23,10 +23,10 @@
import org.apache.log.output.io.StreamTarget;
/**
- * TargetFactory for <code>org.apache.log.output.io.StreamTarget</code>
+ * TargetFactory for {@link org.apache.log.output.io.StreamTarget}.
*
* This factory is able to create different StreamTargets according to the following
- * configuration syntax :
+ * configuration syntax:
* <pre>
* <stream id="foo">
* <stream><i>stream-context-name</i></stream>
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 23 Feb 2002
+12:03:59 -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 23 Feb 2002 12:03:59
+-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
+ 23 Feb 2002 12:03:59 -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/ExcaliburTestCase.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/testcase/ExcaliburTestCase.java,v
retrieving revision 1.19
diff -u -r1.19 ExcaliburTestCase.java
--- src/java/org/apache/avalon/excalibur/testcase/ExcaliburTestCase.java 20 Feb
2002 10:41:10 -0000 1.19
+++ src/java/org/apache/avalon/excalibur/testcase/ExcaliburTestCase.java 23 Feb
+2002 12:03:59 -0000
@@ -44,7 +44,7 @@
import java.net.URL;
/**
- * JUnit TestCase for Avalon Components
+ * JUnit TestCase for Avalon Components.
* <p>
* This class will extends the JUnit TestCase class to setup an environment
* to easily test Avalon Components. The following methods and instance variables
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 23 Feb
+2002 12:04:00 -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/java/org/apache/avalon/excalibur/xml/XMLizable.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/xml/XMLizable.java,v
retrieving revision 1.1
diff -u -r1.1 XMLizable.java
--- src/java/org/apache/avalon/excalibur/xml/XMLizable.java 15 Feb 2002 10:57:39
-0000 1.1
+++ src/java/org/apache/avalon/excalibur/xml/XMLizable.java 23 Feb 2002 12:04:00
+-0000
@@ -20,7 +20,7 @@
public interface XMLizable {
/**
- * Generates SAX events representing the object's state.<br/>
+ * Generates SAX events representing the object's state.
* <b>NOTE</b> : if the implementation can produce lexical events, care should be
taken
* that <code>handler</code> can actually be a {@link XMLConsumer} that accepts
such
* events or directly implements the LexicalHandler interface!
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
+ 23 Feb 2002 12:04:00 -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
+ 23 Feb 2002 12:04:00 -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
+ 23 Feb 2002 12:04:00 -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
+ 23 Feb 2002 12:04:00 -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
+ 23 Feb 2002 12:04:00 -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
+ 23 Feb 2002 12:04:00 -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 23 Feb
+2002 12:04:00 -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
+ 23 Feb 2002 12:04:00 -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
+ 23 Feb 2002 12:04:01 -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/source/SourceParameters.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/source/SourceParameters.java,v
retrieving revision 1.7
diff -u -r1.7 SourceParameters.java
--- src/scratchpad/org/apache/avalon/excalibur/source/SourceParameters.java 18 Feb
2002 12:26:02 -0000 1.7
+++ src/scratchpad/org/apache/avalon/excalibur/source/SourceParameters.java 23 Feb
+2002 12:04:01 -0000
@@ -268,7 +268,7 @@
}
/**
- * Build a query string and encode each parameter value
+ * Build a query string and encode each parameter value.
* The query string can e.g. be used for http connections.
* @return A query string which contains for each parameter/value pair
* a part, like "parameter=value" separated by "&".
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
+ 23 Feb 2002 12:04:02 -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()
{
Index: src/scratchpad/org/apache/avalon/excalibur/util/DeweyDecimal.java
===================================================================
RCS file:
/home/cvspublic/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/util/DeweyDecimal.java,v
retrieving revision 1.3
diff -u -r1.3 DeweyDecimal.java
--- src/scratchpad/org/apache/avalon/excalibur/util/DeweyDecimal.java 11 Dec 2001
09:53:37 -0000 1.3
+++ src/scratchpad/org/apache/avalon/excalibur/util/DeweyDecimal.java 23 Feb 2002
+12:04:03 -0000
@@ -10,11 +10,12 @@
import java.util.StringTokenizer;
/**
- * <p>Utility class to contain version numbers in "Dewey Decimal" syntax
- * that consists of positive decimal integers separated by periods ".",
- * for example, "2.0" or "1.2.3.4.5.6.7". This allows an extensible number
- * to be used to represent major, minor, micro, etc versions. The version
- * number must begin with a number.</p>
+ * Utility class to contain version numbers in "Dewey Decimal"
+ * syntax. Numbers in the "Dewey Decimal" syntax consist of positive
+ * decimal integers separated by periods ".". For example, "2.0" or
+ * "1.2.3.4.5.6.7". This allows an extensible number to be used to
+ * represent major, minor, micro, etc versions. The version number
+ * must begin with a number.
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Peter Donald</a>
* @version $Revision: 1.3 $ $Date: 2001/12/11 09:53:37 $
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
