Author: psteitz
Date: Sat Jan 27 15:33:47 2007
New Revision: 500687
URL: http://svn.apache.org/viewvc?view=rev&rev=500687
Log:
Javadoc. Added @since tags for methods added in 1.2.2.
Modified:
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingConnection.java
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingPreparedStatement.java
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingStatement.java
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/PoolingDriver.java
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/cpdsadapter/DriverAdapterCPDS.java
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/datasources/InstanceKeyDataSource.java
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/datasources/PerUserPoolDataSource.java
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/datasources/SharedPoolDataSource.java
Modified:
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingConnection.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingConnection.java?view=diff&rev=500687&r1=500686&r2=500687
==============================================================================
---
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingConnection.java
(original)
+++
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingConnection.java
Sat Jan 27 15:33:47 2007
@@ -80,6 +80,12 @@
_conn = c;
}
+ /**
+ * Returns a string representation of the metadata associated with
+ * the innnermost delegate connection.
+ *
+ * @since 1.2.2
+ */
public String toString() {
String s = null;
@@ -122,6 +128,13 @@
return _conn;
}
+ /**
+ * Compares innermost delegate to the given connection.
+ *
+ * @param c connection to compare innermost delegate with
+ * @return true if innermost delegate equals <code>c</code>
+ * @since 1.2.2
+ */
public boolean innermostDelegateEquals(Connection c) {
Connection innerCon = getInnermostDelegate();
if (innerCon == null) {
Modified:
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingPreparedStatement.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingPreparedStatement.java?view=diff&rev=500687&r1=500686&r2=500687
==============================================================================
---
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingPreparedStatement.java
(original)
+++
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingPreparedStatement.java
Sat Jan 27 15:33:47 2007
@@ -204,7 +204,8 @@
/**
* Returns a String representation of this object.
*
- * @return String
+ * @return String
+ * @since 1.2.2
*/
public String toString() {
return _stmt.toString();
Modified:
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingStatement.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingStatement.java?view=diff&rev=500687&r1=500686&r2=500687
==============================================================================
---
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingStatement.java
(original)
+++
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingStatement.java
Sat Jan 27 15:33:47 2007
@@ -300,6 +300,7 @@
* Returns a String representation of this object.
*
* @return String
+ * @since 1.2.2
*/
public String toString() {
return _stmt.toString();
Modified:
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/PoolingDriver.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/PoolingDriver.java?view=diff&rev=500687&r1=500686&r2=500687
==============================================================================
---
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/PoolingDriver.java
(original)
+++
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/PoolingDriver.java
Sat Jan 27 15:33:47 2007
@@ -193,6 +193,15 @@
}
}
+ /**
+ * Invalidates the given connection.
+ *
+ * @param conn connection to invalidate
+ * @throws SQLException if the connection is not a
+ * <code>PoolGuardConnectionWrapper</code> or an error occurs invalidating
+ * the connection
+ * @since 1.2.2
+ */
public void invalidateConnection(Connection conn) throws SQLException {
if (conn instanceof PoolGuardConnectionWrapper) { // normal case
PoolGuardConnectionWrapper pgconn = (PoolGuardConnectionWrapper)
conn;
Modified:
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/cpdsadapter/DriverAdapterCPDS.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/cpdsadapter/DriverAdapterCPDS.java?view=diff&rev=500687&r1=500686&r2=500687
==============================================================================
---
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/cpdsadapter/DriverAdapterCPDS.java
(original)
+++
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/cpdsadapter/DriverAdapterCPDS.java
Sat Jan 27 15:33:47 2007
@@ -577,11 +577,25 @@
assertInitializationAllowed();
_minEvictableIdleTimeMillis = minEvictableIdleTimeMillis;
}
+
+ /**
+ * Returns the maximun number of prepared statements.
+ *
+ * @return maxPrepartedStatements value
+ * @since 1.2.2
+ */
public int getMaxPreparedStatements()
{
return _maxPreparedStatements;
}
+ /**
+ * Sets the maximum number of prepared statements.
+ * @param maxPreparedStatements the new maximum number of prepared
+ * statements
+ *
+ * @since 1.2.2
+ */
public void setMaxPreparedStatements(int maxPreparedStatements)
{
_maxPreparedStatements = maxPreparedStatements;
Modified:
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/datasources/InstanceKeyDataSource.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/datasources/InstanceKeyDataSource.java?view=diff&rev=500687&r1=500686&r2=500687
==============================================================================
---
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/datasources/InstanceKeyDataSource.java
(original)
+++
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/datasources/InstanceKeyDataSource.java
Sat Jan 27 15:33:47 2007
@@ -616,6 +616,10 @@
* Whether a rollback will be issued after executing the SQL query
* that will be used to validate connections from this pool
* before returning them to the caller.
+ *
+ * @return true if a rollback will be issued after executing the
+ * validation query
+ * @since 1.2.2
*/
public boolean isRollbackAfterValidation() {
return (this.rollbackAfterValidation);
@@ -626,7 +630,10 @@
* that will be used to validate connections from this pool
* before returning them to the caller. Default behavior is NOT
* to issue a rollback. The setting will only have an effect
- * if a validation query is set.
+ * if a validation query is set
+ *
+ * @param rollbackAfterValidation new property value
+ * @since 1.2.2
*/
public void setRollbackAfterValidation(boolean rollbackAfterValidation) {
assertInitializationAllowed();
Modified:
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/datasources/PerUserPoolDataSource.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/datasources/PerUserPoolDataSource.java?view=diff&rev=500687&r1=500686&r2=500687
==============================================================================
---
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/datasources/PerUserPoolDataSource.java
(original)
+++
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/datasources/PerUserPoolDataSource.java
Sat Jan 27 15:33:47 2007
@@ -422,6 +422,11 @@
con.setReadOnly(defaultReadOnly);
}
+ /**
+ * Returns a <code>PerUserPoolDataSource</code> [EMAIL PROTECTED]
Reference}.
+ *
+ * @since 1.2.2
+ */
public Reference getReference() throws NamingException {
Reference ref = new Reference(getClass().getName(),
PerUserPoolDataSourceFactory.class.getName(), null);
Modified:
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/datasources/SharedPoolDataSource.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/datasources/SharedPoolDataSource.java?view=diff&rev=500687&r1=500686&r2=500687
==============================================================================
---
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/datasources/SharedPoolDataSource.java
(original)
+++
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/datasources/SharedPoolDataSource.java
Sat Jan 27 15:33:47 2007
@@ -174,6 +174,11 @@
return info;
}
+ /**
+ * Returns a <code>SharedPoolDataSource</code> [EMAIL PROTECTED]
Reference}.
+ *
+ * @since 1.2.2
+ */
public Reference getReference() throws NamingException {
Reference ref = new Reference(getClass().getName(),
SharedPoolDataSourceFactory.class.getName(), null);
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
