Author: psteitz
Date: Sat Jul 21 16:46:27 2007
New Revision: 558394
URL: http://svn.apache.org/viewvc?view=rev&rev=558394
Log:
Fixed javadoc to match behavior when BasicDataSource maxWait is 0
(blocks indefinitely).
JIRA: POOL-232
Modified:
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/BasicDataSource.java
Modified:
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/BasicDataSource.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/BasicDataSource.java?view=diff&rev=558394&r1=558393&r2=558394
==============================================================================
---
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/BasicDataSource.java
(original)
+++
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/BasicDataSource.java
Sat Jul 21 16:46:27 2007
@@ -341,7 +341,7 @@
/**
* The maximum number of milliseconds that the pool will wait (when there
* are no available connections) for a connection to be returned before
- * throwing an exception, or -1 to wait indefinitely.
+ * throwing an exception, or <= 0 to wait indefinitely.
*/
protected long maxWait = GenericObjectPool.DEFAULT_MAX_WAIT;
@@ -349,7 +349,8 @@
* <p>Returns the maximum number of milliseconds that the pool will wait
* for a connection to be returned before throwing an exception.
* </p>
- * <p>Returns -1 if the pool is set to wait indefinitely.</p>
+ * <p>A value less than or equal to zero means the pool is set to wait
+ * indefinitely.</p>
*
* @return the maxWait property value
*/
@@ -358,7 +359,10 @@
}
/**
- * Sets the maxWait property.
+ * <p>Sets the maxWait property.
+ * </p>
+ * <p>Use -1 to make the pool wait indefinitely.
+ * </p>
*
* @param maxWait the new value for maxWait
* @see #getMaxWait()
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
