donaldp 02/02/25 23:49:58
Modified: src/java/org/apache/avalon/excalibur/component
ComponentHandler.java PoolableComponentHandler.java
src/java/org/apache/avalon/excalibur/concurrent
DijkstraSemaphore.java DjikstraSemaphore.java
src/java/org/apache/avalon/excalibur/datasource
JdbcConnectionFactory.java
src/java/org/apache/avalon/excalibur/io FileUtil.java
src/java/org/apache/avalon/excalibur/logger/factory
DatagramTargetFactory.java SocketTargetFactory.java
StreamTargetFactory.java
src/java/org/apache/avalon/excalibur/pool
ResourceLimitingPool.java Validatable.java
ValidatedResourceLimitingPool.java
src/java/org/apache/avalon/excalibur/testcase
ExcaliburTestCase.java LatchedThreadGroup.java
src/java/org/apache/avalon/excalibur/xml XMLizable.java
src/scratchpad/org/apache/avalon/excalibur/datasource
ResourceLimitingJdbcConnectionPool.java
src/scratchpad/org/apache/avalon/excalibur/datasource/cluster
AbstractDataSourceCluster.java
HashedDataSourceCluster.java
IndexedDataSourceCluster.java
src/scratchpad/org/apache/avalon/excalibur/datasource/ids
AbstractDataSourceBlockIdGenerator.java
AbstractIdGenerator.java IdGenerator.java
SequenceIdGenerator.java TableIdGenerator.java
src/scratchpad/org/apache/avalon/excalibur/source
SourceParameters.java
src/scratchpad/org/apache/avalon/excalibur/util
ComponentStateValidator.java DeweyDecimal.java
Log:
A Bajillion javadoc fixes - either with tagnames or grammar/spelling ;)
Submitted By: Mark Woon <[EMAIL PROTECTED]>
Revision Changes Path
1.7 +3 -3
jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/component/ComponentHandler.java
Index: ComponentHandler.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/component/ComponentHandler.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ComponentHandler.java 20 Feb 2002 09:44:25 -0000 1.6
+++ ComponentHandler.java 26 Feb 2002 07:49:56 -0000 1.7
@@ -26,7 +26,7 @@
* @author <a href="mailto:[EMAIL PROTECTED]">Berin Loritsch</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Ryan Shaw</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Leif Mortenson</a>
- * @version CVS $Revision: 1.6 $ $Date: 2002/02/20 09:44:25 $
+ * @version CVS $Revision: 1.7 $ $Date: 2002/02/26 07:49:56 $
* @since 4.0
*/
public abstract class ComponentHandler extends AbstractLoggable
@@ -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
1.10 +13 -9
jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/component/PoolableComponentHandler.java
Index: PoolableComponentHandler.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/component/PoolableComponentHandler.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- PoolableComponentHandler.java 20 Feb 2002 06:26:42 -0000 1.9
+++ PoolableComponentHandler.java 26 Feb 2002 07:49:56 -0000 1.10
@@ -65,22 +65,26 @@
* 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 [EMAIL PROTECTED]
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 [EMAIL PROTECTED]
+ * 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 ([EMAIL PROTECTED]
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 ([EMAIL PROTECTED]
+ * 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>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Berin Loritsch</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Leif Mortenson</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Ryan Shaw</a>
- * @version CVS $Revision: 1.9 $ $Date: 2002/02/20 06:26:42 $
+ * @version CVS $Revision: 1.10 $ $Date: 2002/02/26 07:49:56 $
* @since 4.0
*/
public class PoolableComponentHandler extends ComponentHandler {
1.3 +4 -4
jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/concurrent/DijkstraSemaphore.java
Index: DijkstraSemaphore.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/concurrent/DijkstraSemaphore.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DijkstraSemaphore.java 11 Dec 2001 09:53:27 -0000 1.2
+++ DijkstraSemaphore.java 26 Feb 2002 07:49:56 -0000 1.3
@@ -15,7 +15,7 @@
* calls release() thus increasing the count.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Karthik Rangaraju</a>
- * @version CVS $Revision: 1.2 $ $Date: 2001/12/11 09:53:27 $
+ * @version CVS $Revision: 1.3 $ $Date: 2002/02/26 07:49:56 $
* @since 4.0
*/
public class DijkstraSemaphore
@@ -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 )
{
1.5 +4 -4
jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/concurrent/DjikstraSemaphore.java
Index: DjikstraSemaphore.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/concurrent/DjikstraSemaphore.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- DjikstraSemaphore.java 11 Dec 2001 09:53:27 -0000 1.4
+++ DjikstraSemaphore.java 26 Feb 2002 07:49:56 -0000 1.5
@@ -15,7 +15,7 @@
* calls release() thus increasing the count.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Karthik Rangaraju</a>
- * @version CVS $Revision: 1.4 $ $Date: 2001/12/11 09:53:27 $
+ * @version CVS $Revision: 1.5 $ $Date: 2002/02/26 07:49:56 $
* @since 4.0
* @deprecated Replaced by by [EMAIL PROTECTED] DijkstraSemaphore}.
*/
@@ -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 )
{
1.11 +3 -3
jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/datasource/JdbcConnectionFactory.java
Index: JdbcConnectionFactory.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/datasource/JdbcConnectionFactory.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- JdbcConnectionFactory.java 26 Jan 2002 16:58:06 -0000 1.10
+++ JdbcConnectionFactory.java 26 Feb 2002 07:49:56 -0000 1.11
@@ -18,7 +18,7 @@
* The Factory implementation for JdbcConnections.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Berin Loritsch</a>
- * @version CVS $Revision: 1.10 $ $Date: 2002/01/26 16:58:06 $
+ * @version CVS $Revision: 1.11 $ $Date: 2002/02/26 07:49:56 $
* @since 4.0
*/
public class JdbcConnectionFactory extends AbstractLogEnabled implements
ObjectFactory
@@ -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,
1.22 +3 -2
jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/io/FileUtil.java
Index: FileUtil.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/io/FileUtil.java,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -r1.21 -r1.22
--- FileUtil.java 24 Feb 2002 04:18:20 -0000 1.21
+++ FileUtil.java 26 Feb 2002 07:49:57 -0000 1.22
@@ -45,7 +45,7 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]">Peter Donald</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Jeff Turner</a>
- * @version CVS $Revision: 1.21 $ $Date: 2002/02/24 04:18:20 $
+ * @version CVS $Revision: 1.22 $ $Date: 2002/02/26 07:49:57 $
* @since 4.0
*/
public final class FileUtil
@@ -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 />
1.7 +5 -7
jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/logger/factory/DatagramTargetFactory.java
Index: DatagramTargetFactory.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/logger/factory/DatagramTargetFactory.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- DatagramTargetFactory.java 9 Feb 2002 00:17:50 -0000 1.6
+++ DatagramTargetFactory.java 26 Feb 2002 07:49:57 -0000 1.7
@@ -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
1.3 +4 -7
jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/logger/factory/SocketTargetFactory.java
Index: SocketTargetFactory.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/logger/factory/SocketTargetFactory.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SocketTargetFactory.java 9 Feb 2002 00:17:50 -0000 1.2
+++ SocketTargetFactory.java 26 Feb 2002 07:49:57 -0000 1.3
@@ -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>
*
*
1.4 +3 -3
jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/logger/factory/StreamTargetFactory.java
Index: StreamTargetFactory.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/logger/factory/StreamTargetFactory.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- StreamTargetFactory.java 19 Dec 2001 23:34:50 -0000 1.3
+++ StreamTargetFactory.java 26 Feb 2002 07:49:57 -0000 1.4
@@ -23,10 +23,10 @@
import org.apache.log.output.io.StreamTarget;
/**
- * TargetFactory for <code>org.apache.log.output.io.StreamTarget</code>
+ * TargetFactory for [EMAIL PROTECTED]
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>
@@ -43,7 +43,7 @@
* <p>The syntax of "format" is the same as in
<code>FileTargetFactory</code>.</p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Sylvain Wallez</a>
- * @version CVS $Revision: 1.3 $ $Date: 2001/12/19 23:34:50 $
+ * @version CVS $Revision: 1.4 $ $Date: 2002/02/26 07:49:57 $
*/
public class StreamTargetFactory
extends AbstractTargetFactory
1.2 +4 -4
jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/pool/ResourceLimitingPool.java
Index: ResourceLimitingPool.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/pool/ResourceLimitingPool.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ResourceLimitingPool.java 18 Feb 2002 06:16:06 -0000 1.1
+++ ResourceLimitingPool.java 26 Feb 2002 07:49:57 -0000 1.2
@@ -33,7 +33,7 @@
* trimmed. See the [EMAIL PROTECTED] #trim()} method for details of how
trimming works.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Leif Mortenson</a>
- * @version CVS $Revision: 1.1 $ $Date: 2002/02/18 06:16:06 $
+ * @version CVS $Revision: 1.2 $ $Date: 2002/02/26 07:49:57 $
* @since 4.1
*/
public class ResourceLimitingPool
@@ -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()
{
1.2 +2 -2
jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/pool/Validatable.java
Index: Validatable.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/pool/Validatable.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Validatable.java 18 Feb 2002 06:16:06 -0000 1.1
+++ Validatable.java 26 Feb 2002 07:49:57 -0000 1.2
@@ -13,7 +13,7 @@
* Used to define an object which can be validated by a
ValidatedResourceLimitingPool.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Leif Mortenson</a>
- * @version CVS $Revision: 1.1 $ $Date: 2002/02/18 06:16:06 $
+ * @version CVS $Revision: 1.2 $ $Date: 2002/02/26 07:49:57 $
* @since 4.1
*/
public interface Validatable
@@ -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();
}
1.2 +3 -3
jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/pool/ValidatedResourceLimitingPool.java
Index: ValidatedResourceLimitingPool.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/pool/ValidatedResourceLimitingPool.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ValidatedResourceLimitingPool.java 18 Feb 2002 06:16:06 -0000
1.1
+++ ValidatedResourceLimitingPool.java 26 Feb 2002 07:49:57 -0000
1.2
@@ -15,7 +15,7 @@
* returned with a call get().
*
* @author <a href="mailto:[EMAIL PROTECTED]">Leif Mortenson</a>
- * @version CVS $Revision: 1.1 $ $Date: 2002/02/18 06:16:06 $
+ * @version CVS $Revision: 1.2 $ $Date: 2002/02/26 07:49:57 $
* @since 4.1
*/
public class ValidatedResourceLimitingPool
@@ -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
{
1.22 +2 -2
jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/testcase/ExcaliburTestCase.java
Index: ExcaliburTestCase.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/testcase/ExcaliburTestCase.java,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -r1.21 -r1.22
--- ExcaliburTestCase.java 25 Feb 2002 11:18:14 -0000 1.21
+++ ExcaliburTestCase.java 26 Feb 2002 07:49:57 -0000 1.22
@@ -44,7 +44,7 @@
import java.net.URL;
/**
- * JUnit TestCase for Avalon Components
+ * JUnit TestCase for Avalon Components.
* <p>
* This class extends the JUnit TestCase class to setup an environment
which
* makes it possible to easily test Avalon Components. The following
methods
@@ -219,7 +219,7 @@
* </dl>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Giacomo Pati</a>
- * @version $Id: ExcaliburTestCase.java,v 1.21 2002/02/25 11:18:14 leif Exp $
+ * @version $Id: ExcaliburTestCase.java,v 1.22 2002/02/26 07:49:57 donaldp
Exp $
*/
public class ExcaliburTestCase
extends TestCase
1.3 +2 -2
jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/testcase/LatchedThreadGroup.java
Index: LatchedThreadGroup.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/testcase/LatchedThreadGroup.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- LatchedThreadGroup.java 20 Feb 2002 15:41:05 -0000 1.2
+++ LatchedThreadGroup.java 26 Feb 2002 07:49:57 -0000 1.3
@@ -24,7 +24,7 @@
* Runnables have completed.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Leif Mortenson</a>
- * @version $Id: LatchedThreadGroup.java,v 1.2 2002/02/20 15:41:05 leif Exp $
+ * @version $Id: LatchedThreadGroup.java,v 1.3 2002/02/26 07:49:57 donaldp
Exp $
*/
public class LatchedThreadGroup
extends AbstractLogEnabled
@@ -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
1.2 +2 -2
jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/xml/XMLizable.java
Index: XMLizable.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/xml/XMLizable.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XMLizable.java 15 Feb 2002 10:57:39 -0000 1.1
+++ XMLizable.java 26 Feb 2002 07:49:57 -0000 1.2
@@ -15,12 +15,12 @@
* of their current state as SAX events.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Sylvain Wallez</a>
- * @version CVS $Revision: 1.1 $ $Date: 2002/02/15 10:57:39 $
+ * @version CVS $Revision: 1.2 $ $Date: 2002/02/26 07:49:57 $
*/
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 [EMAIL PROTECTED]
XMLConsumer} that accepts such
* events or directly implements the LexicalHandler interface!
1.3 +2 -2
jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/ResourceLimitingJdbcConnectionPool.java
Index: ResourceLimitingJdbcConnectionPool.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/ResourceLimitingJdbcConnectionPool.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ResourceLimitingJdbcConnectionPool.java 25 Jan 2002 01:24:27 -0000
1.2
+++ ResourceLimitingJdbcConnectionPool.java 26 Feb 2002 07:49:57 -0000
1.3
@@ -24,7 +24,7 @@
* connections.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Leif Mortenson</a>
- * @version CVS $Revision: 1.2 $ $Date: 2002/01/25 01:24:27 $
+ * @version CVS $Revision: 1.3 $ $Date: 2002/02/26 07:49:57 $
* @since 4.1
*/
public class ResourceLimitingJdbcConnectionPool
@@ -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;
1.3 +2 -2
jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/cluster/AbstractDataSourceCluster.java
Index: AbstractDataSourceCluster.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/cluster/AbstractDataSourceCluster.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AbstractDataSourceCluster.java 6 Feb 2002 08:37:05 -0000 1.2
+++ AbstractDataSourceCluster.java 26 Feb 2002 07:49:57 -0000 1.3
@@ -28,7 +28,7 @@
/**
* @author <a href="mailto:[EMAIL PROTECTED]">Leif Mortenson</a>
- * @version CVS $Revision: 1.2 $ $Date: 2002/02/06 08:37:05 $
+ * @version CVS $Revision: 1.3 $ $Date: 2002/02/26 07:49:57 $
* @since 4.1
*/
public abstract class AbstractDataSourceCluster
@@ -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()
{
1.2 +2 -2
jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/cluster/HashedDataSourceCluster.java
Index: HashedDataSourceCluster.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/cluster/HashedDataSourceCluster.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- HashedDataSourceCluster.java 4 Feb 2002 03:20:54 -0000 1.1
+++ HashedDataSourceCluster.java 26 Feb 2002 07:49:57 -0000 1.2
@@ -14,7 +14,7 @@
/**
* @author <a href="mailto:[EMAIL PROTECTED]">Leif Mortenson</a>
- * @version CVS $Revision: 1.1 $ $Date: 2002/02/04 03:20:54 $
+ * @version CVS $Revision: 1.2 $ $Date: 2002/02/26 07:49:57 $
* @since 4.1
*/
public interface HashedDataSourceCluster
@@ -28,7 +28,7 @@
/**
* Returns the number of DataSources in the cluster.
*
- * @returns size of the cluster.
+ * @return size of the cluster.
*/
int getClusterSize();
1.2 +2 -2
jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/cluster/IndexedDataSourceCluster.java
Index: IndexedDataSourceCluster.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/cluster/IndexedDataSourceCluster.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- IndexedDataSourceCluster.java 4 Feb 2002 03:20:54 -0000 1.1
+++ IndexedDataSourceCluster.java 26 Feb 2002 07:49:57 -0000 1.2
@@ -14,7 +14,7 @@
/**
* @author <a href="mailto:[EMAIL PROTECTED]">Leif Mortenson</a>
- * @version CVS $Revision: 1.1 $ $Date: 2002/02/04 03:20:54 $
+ * @version CVS $Revision: 1.2 $ $Date: 2002/02/26 07:49:57 $
* @since 4.1
*/
public interface IndexedDataSourceCluster
@@ -28,7 +28,7 @@
/**
* Returns the number of DataSources in the cluster.
*
- * @returns size of the cluster.
+ * @return size of the cluster.
*/
int getClusterSize();
1.3 +5 -5
jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/ids/AbstractDataSourceBlockIdGenerator.java
Index: AbstractDataSourceBlockIdGenerator.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/ids/AbstractDataSourceBlockIdGenerator.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AbstractDataSourceBlockIdGenerator.java 8 Feb 2002 17:38:09 -0000
1.2
+++ AbstractDataSourceBlockIdGenerator.java 26 Feb 2002 07:49:57 -0000
1.3
@@ -22,7 +22,7 @@
* the DataSource.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Leif Mortenson</a>
- * @version CVS $Revision: 1.2 $ $Date: 2002/02/08 17:38:09 $
+ * @version CVS $Revision: 1.3 $ $Date: 2002/02/26 07:49:57 $
* @since 4.1
*/
public abstract class AbstractDataSourceBlockIdGenerator
@@ -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.
*/
1.2 +8 -8
jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/ids/AbstractIdGenerator.java
Index: AbstractIdGenerator.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/ids/AbstractIdGenerator.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- AbstractIdGenerator.java 8 Feb 2002 12:27:32 -0000 1.1
+++ AbstractIdGenerator.java 26 Feb 2002 07:49:57 -0000 1.2
@@ -14,7 +14,7 @@
/**
* @author <a href="mailto:[EMAIL PROTECTED]">Leif Mortenson</a>
- * @version CVS $Revision: 1.1 $ $Date: 2002/02/08 12:27:32 $
+ * @version CVS $Revision: 1.2 $ $Date: 2002/02/26 07:49:57 $
* @since 4.1
*/
public abstract class AbstractIdGenerator
@@ -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.
*/
1.2 +6 -6
jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/ids/IdGenerator.java
Index: IdGenerator.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/ids/IdGenerator.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- IdGenerator.java 8 Feb 2002 12:27:32 -0000 1.1
+++ IdGenerator.java 26 Feb 2002 07:49:57 -0000 1.2
@@ -13,7 +13,7 @@
/**
* @author <a href="mailto:[EMAIL PROTECTED]">Leif Mortenson</a>
- * @version CVS $Revision: 1.1 $ $Date: 2002/02/08 12:27:32 $
+ * @version CVS $Revision: 1.2 $ $Date: 2002/02/26 07:49:57 $
* @since 4.1
*/
public interface IdGenerator
@@ -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.
*/
1.2 +3 -3
jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/ids/SequenceIdGenerator.java
Index: SequenceIdGenerator.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/ids/SequenceIdGenerator.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SequenceIdGenerator.java 8 Feb 2002 12:27:32 -0000 1.1
+++ SequenceIdGenerator.java 26 Feb 2002 07:49:57 -0000 1.2
@@ -58,7 +58,7 @@
* DataSource, by making use of a ComponentSelector.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Leif Mortenson</a>
- * @version CVS $Revision: 1.1 $ $Date: 2002/02/08 12:27:32 $
+ * @version CVS $Revision: 1.2 $ $Date: 2002/02/26 07:49:57 $
* @since 4.1
*/
public class SequenceIdGenerator
@@ -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.
*/
1.4 +5 -5
jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/ids/TableIdGenerator.java
Index: TableIdGenerator.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/datasource/ids/TableIdGenerator.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- TableIdGenerator.java 14 Feb 2002 05:12:57 -0000 1.3
+++ TableIdGenerator.java 26 Feb 2002 07:49:57 -0000 1.4
@@ -68,7 +68,7 @@
* </pre>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Leif Mortenson</a>
- * @version CVS $Revision: 1.3 $ $Date: 2002/02/14 05:12:57 $
+ * @version CVS $Revision: 1.4 $ $Date: 2002/02/26 07:49:57 $
* @since 4.1
*/
public class TableIdGenerator
@@ -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.
*/
1.8 +2 -2
jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/source/SourceParameters.java
Index: SourceParameters.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/source/SourceParameters.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- SourceParameters.java 18 Feb 2002 12:26:02 -0000 1.7
+++ SourceParameters.java 26 Feb 2002 07:49:58 -0000 1.8
@@ -19,7 +19,7 @@
* more than one value for a parameter.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
- * @version $Id: SourceParameters.java,v 1.7 2002/02/18 12:26:02 cziegeler
Exp $
+ * @version $Id: SourceParameters.java,v 1.8 2002/02/26 07:49:58 donaldp Exp
$
*/
public final class SourceParameters
implements Serializable, Cloneable {
@@ -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 "&".
1.10 +2 -2
jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/util/ComponentStateValidator.java
Index: ComponentStateValidator.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/util/ComponentStateValidator.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- ComponentStateValidator.java 8 Feb 2002 17:40:03 -0000 1.9
+++ ComponentStateValidator.java 26 Feb 2002 07:49:58 -0000 1.10
@@ -30,7 +30,7 @@
* @author <a href="mailto:[EMAIL PROTECTED]">Berin Loritsch</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Michael McKibben</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Leif Mortenson</a>
- * @version CVS $Revision: 1.9 $ $Date: 2002/02/08 17:40:03 $
+ * @version CVS $Revision: 1.10 $ $Date: 2002/02/26 07:49:58 $
*/
public final class ComponentStateValidator
{
@@ -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()
{
1.4 +7 -6
jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/util/DeweyDecimal.java
Index: DeweyDecimal.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/util/DeweyDecimal.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- DeweyDecimal.java 11 Dec 2001 09:53:37 -0000 1.3
+++ DeweyDecimal.java 26 Feb 2002 07:49:58 -0000 1.4
@@ -10,14 +10,15 @@
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 $
+ * @version $Revision: 1.4 $ $Date: 2002/02/26 07:49:58 $
*/
public final class DeweyDecimal
{
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
