You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ma...@apache.org on 2016/01/20 15:45:15 UTC

svn commit: r1725730 - in /commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2: LifetimeExceededException.java datasources/CPDSConnectionFactory.java datasources/KeyedCPDSConnectionFactory.java

Author: markt
Date: Wed Jan 20 14:45:15 2016
New Revision: 1725730

URL: http://svn.apache.org/viewvc?rev=1725730&view=rev
Log:
Minor Javadoc fixes

Modified:
    commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/LifetimeExceededException.java
    commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/CPDSConnectionFactory.java
    commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/KeyedCPDSConnectionFactory.java

Modified: commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/LifetimeExceededException.java
URL: http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/LifetimeExceededException.java?rev=1725730&r1=1725729&r2=1725730&view=diff
==============================================================================
--- commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/LifetimeExceededException.java (original)
+++ commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/LifetimeExceededException.java Wed Jan 20 14:45:15 2016
@@ -34,9 +34,10 @@ package org.apache.commons.dbcp2;
 
     /**
      * Create a LifetimeExceededException with the given message.
+     *
+     * @param message The message with which to create the exception
      */
     public LifetimeExceededException(String message) {
         super(message);
     }
-
 }

Modified: commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/CPDSConnectionFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/CPDSConnectionFactory.java?rev=1725730&r1=1725729&r2=1725730&view=diff
==============================================================================
--- commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/CPDSConnectionFactory.java (original)
+++ commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/CPDSConnectionFactory.java Wed Jan 20 14:45:15 2016
@@ -87,8 +87,8 @@ class CPDSConnectionFactory
      * @param validationQueryTimeout Timeout in seconds before validation fails
      * @param rollbackAfterValidation whether a rollback should be issued
      * after {@link #validateObject validating} {@link Connection}s.
-     * @param username
-     * @param password
+     * @param username The user name to use to create connections
+     * @param password The password to use to create connections
      */
     public CPDSConnectionFactory(ConnectionPoolDataSource cpds,
                                  String validationQuery,
@@ -186,7 +186,7 @@ class CPDSConnectionFactory
                 valid = false;
             } finally {
                 Utils.closeQuietly(conn);
-                validatingSet.remove(pconn); 
+                validatingSet.remove(pconn);
             }
         } else {
             Statement stmt = null;
@@ -332,9 +332,10 @@ class CPDSConnectionFactory
 
     /**
      * Sets the maximum lifetime in milliseconds of a connection after which the
-     * connection will always fail activation, passivation and validation. A
-     * value of zero or less indicates an infinite lifetime. The default value
-     * is -1.
+     * connection will always fail activation, passivation and validation.
+     *
+     * @param maxConnLifetimeMillis A value of zero or less indicates an
+     *        infinite lifetime. The default value is -1.
      */
     public void setMaxConnLifetimeMillis(long maxConnLifetimeMillis) {
         this.maxConnLifetimeMillis = maxConnLifetimeMillis;

Modified: commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/KeyedCPDSConnectionFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/KeyedCPDSConnectionFactory.java?rev=1725730&r1=1725729&r2=1725730&view=diff
==============================================================================
--- commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/KeyedCPDSConnectionFactory.java (original)
+++ commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/KeyedCPDSConnectionFactory.java Wed Jan 20 14:45:15 2016
@@ -82,6 +82,8 @@ class KeyedCPDSConnectionFactory
      * {@link Connection}s.  Should return at least one row. May be
      * {@code null} in which case3 {@link Connection#isValid(int)} will be used
      * to validate connections.
+     * @param validationQueryTimeout The time, in seconds, to allow for the
+     *        validation query to complete
      * @param rollbackAfterValidation whether a rollback should be issued after
      * {@link #validateObject validating} {@link Connection}s.
      */
@@ -186,7 +188,7 @@ class KeyedCPDSConnectionFactory
                 valid = false;
             } finally {
                 Utils.closeQuietly(conn);
-                validatingSet.remove(pconn); 
+                validatingSet.remove(pconn);
             }
         } else {
             Statement stmt = null;
@@ -331,9 +333,10 @@ class KeyedCPDSConnectionFactory
 
     /**
      * Sets the maximum lifetime in milliseconds of a connection after which the
-     * connection will always fail activation, passivation and validation. A
-     * value of zero or less indicates an infinite lifetime. The default value
-     * is -1.
+     * connection will always fail activation, passivation and validation.
+     *
+     * @param maxConnLifetimeMillis A value of zero or less indicates an
+     *        infinite lifetime. The default value is -1.
      */
     public void setMaxConnLifetimeMillis(long maxConnLifetimeMillis) {
         this.maxConnLifetimeMillis = maxConnLifetimeMillis;