dirkv 2004/05/12 11:28:59
Modified: dbcp/src/java/org/apache/commons/dbcp
PoolableConnectionFactory.java
Log:
Bugzilla Bug 28893: PoolableConnectionFactory has incomplete javadoc on
validationQuery
- update javadoc
(reported by Hontvari Jozsef)
Revision Changes Path
1.21 +8 -8
jakarta-commons/dbcp/src/java/org/apache/commons/dbcp/PoolableConnectionFactory.java
Index: PoolableConnectionFactory.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/dbcp/src/java/org/apache/commons/dbcp/PoolableConnectionFactory.java,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
--- PoolableConnectionFactory.java 29 Feb 2004 20:18:25 -0000 1.20
+++ PoolableConnectionFactory.java 12 May 2004 18:28:58 -0000 1.21
@@ -38,7 +38,7 @@
* @param connFactory the [EMAIL PROTECTED] ConnectionFactory} from which to
obtain base [EMAIL PROTECTED] Connection}s
* @param pool the [EMAIL PROTECTED] ObjectPool} in which to pool those [EMAIL
PROTECTED] Connection}s
* @param stmtPoolFactory the [EMAIL PROTECTED] KeyedObjectPoolFactory} to use
to create [EMAIL PROTECTED] KeyedObjectPool}s for pooling [EMAIL PROTECTED]
java.sql.PreparedStatement}s, or <tt>null</tt> to disable [EMAIL PROTECTED]
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to [EMAIL PROTECTED] #validateObject
validate} [EMAIL PROTECTED] Connection}s. Should return at least one row. May be
<tt>null</tt>
+ * @param validationQuery a query to use to [EMAIL PROTECTED] #validateObject
validate} [EMAIL PROTECTED] Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
* @param defaultReadOnly the default "read only" setting for borrowed [EMAIL
PROTECTED] Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
[EMAIL PROTECTED] Connection}s
*/
@@ -57,7 +57,7 @@
* @param connFactory the [EMAIL PROTECTED] ConnectionFactory} from which to
obtain base [EMAIL PROTECTED] Connection}s
* @param pool the [EMAIL PROTECTED] ObjectPool} in which to pool those [EMAIL
PROTECTED] Connection}s
* @param stmtPoolFactory the [EMAIL PROTECTED] KeyedObjectPoolFactory} to use
to create [EMAIL PROTECTED] KeyedObjectPool}s for pooling [EMAIL PROTECTED]
java.sql.PreparedStatement}s, or <tt>null</tt> to disable [EMAIL PROTECTED]
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to [EMAIL PROTECTED] #validateObject
validate} [EMAIL PROTECTED] Connection}s. Should return at least one row. May be
<tt>null</tt>
+ * @param validationQuery a query to use to [EMAIL PROTECTED] #validateObject
validate} [EMAIL PROTECTED] Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
* @param defaultReadOnly the default "read only" setting for borrowed [EMAIL
PROTECTED] Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
[EMAIL PROTECTED] Connection}s
* @param defaultTransactionIsolation the default "Transaction Isolation"
setting for returned [EMAIL PROTECTED] Connection}s
@@ -78,7 +78,7 @@
* @param connFactory the [EMAIL PROTECTED] ConnectionFactory} from which to
obtain base [EMAIL PROTECTED] Connection}s
* @param pool the [EMAIL PROTECTED] ObjectPool} in which to pool those [EMAIL
PROTECTED] Connection}s
* @param stmtPoolFactory the [EMAIL PROTECTED] KeyedObjectPoolFactory} to use
to create [EMAIL PROTECTED] KeyedObjectPool}s for pooling [EMAIL PROTECTED]
java.sql.PreparedStatement}s, or <tt>null</tt> to disable [EMAIL PROTECTED]
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to [EMAIL PROTECTED] #validateObject
validate} [EMAIL PROTECTED] Connection}s. Should return at least one row. May be
<tt>null</tt>
+ * @param validationQuery a query to use to [EMAIL PROTECTED] #validateObject
validate} [EMAIL PROTECTED] Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
* @param defaultReadOnly the default "read only" setting for borrowed [EMAIL
PROTECTED] Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
[EMAIL PROTECTED] Connection}s
* @param config the AbandonedConfig if tracing SQL objects
@@ -108,7 +108,7 @@
* @param connFactory the [EMAIL PROTECTED] ConnectionFactory} from which to
obtain base [EMAIL PROTECTED] Connection}s
* @param pool the [EMAIL PROTECTED] ObjectPool} in which to pool those [EMAIL
PROTECTED] Connection}s
* @param stmtPoolFactory the [EMAIL PROTECTED] KeyedObjectPoolFactory} to use
to create [EMAIL PROTECTED] KeyedObjectPool}s for pooling [EMAIL PROTECTED]
java.sql.PreparedStatement}s, or <tt>null</tt> to disable [EMAIL PROTECTED]
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to [EMAIL PROTECTED] #validateObject
validate} [EMAIL PROTECTED] Connection}s. Should return at least one row. May be
<tt>null</tt>
+ * @param validationQuery a query to use to [EMAIL PROTECTED] #validateObject
validate} [EMAIL PROTECTED] Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
* @param defaultReadOnly the default "read only" setting for borrowed [EMAIL
PROTECTED] Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
[EMAIL PROTECTED] Connection}s
* @param defaultTransactionIsolation the default "Transaction Isolation"
setting for returned [EMAIL PROTECTED] Connection}s
@@ -141,7 +141,7 @@
* @param connFactory the [EMAIL PROTECTED] ConnectionFactory} from which to
obtain base [EMAIL PROTECTED] Connection}s
* @param pool the [EMAIL PROTECTED] ObjectPool} in which to pool those [EMAIL
PROTECTED] Connection}s
* @param stmtPoolFactory the [EMAIL PROTECTED] KeyedObjectPoolFactory} to use
to create [EMAIL PROTECTED] KeyedObjectPool}s for pooling [EMAIL PROTECTED]
java.sql.PreparedStatement}s, or <tt>null</tt> to disable [EMAIL PROTECTED]
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to [EMAIL PROTECTED] #validateObject
validate} [EMAIL PROTECTED] Connection}s. Should return at least one row. May be
<tt>null</tt>
+ * @param validationQuery a query to use to [EMAIL PROTECTED] #validateObject
validate} [EMAIL PROTECTED] Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
* @param defaultReadOnly the default "read only" setting for borrowed [EMAIL
PROTECTED] Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
[EMAIL PROTECTED] Connection}s
* @param defaultTransactionIsolation the default "Transaction Isolation"
setting for returned [EMAIL PROTECTED] Connection}s
@@ -177,7 +177,7 @@
* @param connFactory the [EMAIL PROTECTED] ConnectionFactory} from which to
obtain base [EMAIL PROTECTED] Connection}s
* @param pool the [EMAIL PROTECTED] ObjectPool} in which to pool those [EMAIL
PROTECTED] Connection}s
* @param stmtPoolFactory the [EMAIL PROTECTED] KeyedObjectPoolFactory} to use
to create [EMAIL PROTECTED] KeyedObjectPool}s for pooling [EMAIL PROTECTED]
java.sql.PreparedStatement}s, or <tt>null</tt> to disable [EMAIL PROTECTED]
java.sql.PreparedStatement} pooling
- * @param validationQuery a query to use to [EMAIL PROTECTED] #validateObject
validate} [EMAIL PROTECTED] Connection}s. Should return at least one row. May be
<tt>null</tt>
+ * @param validationQuery a query to use to [EMAIL PROTECTED] #validateObject
validate} [EMAIL PROTECTED] Connection}s. Should return at least one row. Using
<tt>null</tt> turns off validation.
* @param defaultReadOnly the default "read only" setting for borrowed [EMAIL
PROTECTED] Connection}s
* @param defaultAutoCommit the default "auto commit" setting for returned
[EMAIL PROTECTED] Connection}s
* @param defaultTransactionIsolation the default "Transaction Isolation"
setting for returned [EMAIL PROTECTED] Connection}s
@@ -218,7 +218,7 @@
/**
* Sets the query I use to [EMAIL PROTECTED] #validateObject validate} [EMAIL
PROTECTED] Connection}s.
* Should return at least one row.
- * May be <tt>null</tt>
+ * Using <tt>null</tt> turns off validation.
* @param validationQuery a query to use to [EMAIL PROTECTED] #validateObject
validate} [EMAIL PROTECTED] Connection}s.
*/
synchronized public void setValidationQuery(String validationQuery) {
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]