You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by ps...@apache.org on 2006/04/02 02:50:52 UTC
svn commit: r390768 - in
/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp: ./
datasources/
Author: psteitz
Date: Sat Apr 1 16:50:49 2006
New Revision: 390768
URL: http://svn.apache.org/viewcvs?rev=390768&view=rev
Log:
Javadoc fixes (only).
Modified:
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/AbandonedConfig.java
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/AbandonedObjectPool.java
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/AbandonedTrace.java
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/BasicDataSource.java
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/BasicDataSourceFactory.java
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DbcpException.java
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingCallableStatement.java
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingConnection.java
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingResultSet.java
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DriverManagerConnectionFactory.java
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/PoolingConnection.java
jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/datasources/InstanceKeyDataSource.java
Modified: jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/AbandonedConfig.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/AbandonedConfig.java?rev=390768&r1=390767&r2=390768&view=diff
==============================================================================
--- jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/AbandonedConfig.java (original)
+++ jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/AbandonedConfig.java Sat Apr 1 16:50:49 2006
@@ -37,7 +37,7 @@
* Setting this to true can recover db connections from poorly written
* applications which fail to close a connection.
*
- * @return boolean
+ * @return true if abandoned connections are to be removed
*/
public boolean getRemoveAbandoned() {
return (this.removeAbandoned);
@@ -53,7 +53,8 @@
* Setting this to true can recover db connections from poorly written
* applications which fail to close a connection.
*
- * @param boolean
+ * @param removeAbandoned true means abandoned connections will be
+ * removed
*/
public void setRemoveAbandoned(boolean removeAbandoned) {
this.removeAbandoned = removeAbandoned;
@@ -66,7 +67,7 @@
*
* Defaults to 300 seconds.
*
- * @return int remove abandoned timeout in seconds
+ * @return abandoned timeout in seconds
*/
public int getRemoveAbandonedTimeout() {
return (this.removeAbandonedTimeout);
@@ -77,7 +78,7 @@
*
* Defaults to 300 seconds.
*
- * @param int remove abandoned timeout in seconds
+ * @param removeAbandonedTimeout abandoned timeout in seconds
*/
public void setRemoveAbandonedTimeout(int removeAbandonedTimeout) {
this.removeAbandonedTimeout = removeAbandonedTimeout;
@@ -93,8 +94,10 @@
* Logging of abandoned Statements and Connections adds overhead
* for every Connection open or new Statement because a stack
* trace has to be generated.
+ *
+ * @return boolean true if stack trace logging is turned on for abandoned
+ * Statements or Connections
*
- * @return boolean
*/
public boolean getLogAbandoned() {
return (this.logAbandoned);
@@ -109,7 +112,6 @@
* for every Connection open or new Statement because a stack
* trace has to be generated.
*
- * @param boolean
*/
public void setLogAbandoned(boolean logAbandoned) {
this.logAbandoned = logAbandoned;
Modified: jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/AbandonedObjectPool.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/AbandonedObjectPool.java?rev=390768&r1=390767&r2=390768&view=diff
==============================================================================
--- jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/AbandonedObjectPool.java (original)
+++ jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/AbandonedObjectPool.java Sat Apr 1 16:50:49 2006
@@ -43,8 +43,8 @@
/**
* Create an ObjectPool which tracks db connections.
*
- * @param PoolableObjectFactory factory used to create this
- * @param AbandonedConfig configuration for abandoned db connections
+ * @param factory PoolableObjectFactory used to create this
+ * @param config configuration for abandoned db connections
*/
public AbandonedObjectPool(PoolableObjectFactory factory,
AbandonedConfig config) {
@@ -88,7 +88,7 @@
/**
* Return a db connection to the pool.
*
- * @param Object db Connection to return
+ * @param obj db Connection to return
*/
public void returnObject(Object obj) throws Exception {
if (config != null && config.getRemoveAbandoned()) {
Modified: jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/AbandonedTrace.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/AbandonedTrace.java?rev=390768&r1=390767&r2=390768&view=diff
==============================================================================
--- jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/AbandonedTrace.java (original)
+++ jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/AbandonedTrace.java Sat Apr 1 16:50:49 2006
@@ -62,7 +62,7 @@
/**
* Construct a new AbandonedTrace with no parent object.
*
- * @param AbandonedConfig
+ * @param config AbandonedConfig
*/
public AbandonedTrace(AbandonedConfig config) {
this.config = config;
@@ -72,7 +72,7 @@
/**
* Construct a new AbandonedTrace with a parent object.
*
- * @param AbandonedTrace parent object
+ * @param parent AbandonedTrace parent object
*/
public AbandonedTrace(AbandonedTrace parent) {
this.config = parent.getConfig();
@@ -82,7 +82,7 @@
/**
* Initialize abandoned tracing for this object.
*
- * @param AbandonedTrace parent object
+ * @param parent AbandonedTrace parent object
*/
private void init(AbandonedTrace parent) {
if (parent != null) {
@@ -134,7 +134,7 @@
/**
* Set the time in ms this object was last used.
*
- * @param long time in ms
+ * @param time time in ms
*/
protected void setLastUsed(long time) {
if (parent != null) {
@@ -166,7 +166,7 @@
* Add an object to the list of objects being
* traced.
*
- * @param AbandonedTrace object to add
+ * @param trace AbandonedTrace object to add
*/
protected void addTrace(AbandonedTrace trace) {
synchronized(this) {
@@ -215,7 +215,7 @@
/**
* Remove a child object this object is tracing.
*
- * @param AbandonedTrace object to remvoe
+ * @param trace AbandonedTrace object to remvoe
*/
protected synchronized void removeTrace(AbandonedTrace trace) {
if (this.trace != null) {
Modified: jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/BasicDataSource.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/BasicDataSource.java?rev=390768&r1=390767&r2=390768&view=diff
==============================================================================
--- 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 Apr 1 16:50:49 2006
@@ -232,7 +232,7 @@
/**
* Sets whether to pool statements or not.
- * @param poolPreparedStatements pooling on or off
+ * @param poolingStatements pooling on or off
*/
public synchronized void setPoolPreparedStatements(boolean poolingStatements) {
this.poolPreparedStatements = poolingStatements;
Modified: jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/BasicDataSourceFactory.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/BasicDataSourceFactory.java?rev=390768&r1=390767&r2=390768&view=diff
==============================================================================
--- jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/BasicDataSourceFactory.java (original)
+++ jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/BasicDataSourceFactory.java Sat Apr 1 16:50:49 2006
@@ -109,7 +109,7 @@
* @param obj The possibly null object containing location or
* reference information that can be used in creating an object
* @param name The name of this object relative to <code>nameCtx</code>
- * @param nameCts The context relative to which the <code>name</code>
+ * @param nameCtx The context relative to which the <code>name</code>
* parameter is specified, or <code>null</code> if <code>name</code>
* is relative to the default initial context
* @param environment The possibly null environment that is used in
Modified: jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DbcpException.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DbcpException.java?rev=390768&r1=390767&r2=390768&view=diff
==============================================================================
--- jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DbcpException.java (original)
+++ jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DbcpException.java Sat Apr 1 16:50:49 2006
@@ -74,7 +74,7 @@
/**
* Construct a new runtime exception with the specified cause and a
- * detail message of <code>(cause == null ? null : cause.toString())</code>.
+ * detail message of <code>(cause == null ? null : cause.toString())</code>.
*
* @param cause The root cause for this exception
*/
Modified: jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingCallableStatement.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingCallableStatement.java?rev=390768&r1=390767&r2=390768&view=diff
==============================================================================
--- jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingCallableStatement.java (original)
+++ jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingCallableStatement.java Sat Apr 1 16:50:49 2006
@@ -60,7 +60,8 @@
* Statement to the Connection which created it and the
* code which created it.
*
- * @param cs the {@link CallableStatement} to delegate all calls to.
+ * @param c the {@link DelegatingConnection} that created this statement
+ * @param s the {@link CallableStatement} to delegate all calls to
*/
public DelegatingCallableStatement(DelegatingConnection c,
CallableStatement s) {
Modified: jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingConnection.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingConnection.java?rev=390768&r1=390767&r2=390768&view=diff
==============================================================================
--- 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 Apr 1 16:50:49 2006
@@ -70,8 +70,8 @@
* the Statements created so that any unclosed Statements
* can be closed when this Connection is closed.
*
- * @param Connection the {@link Connection} to delegate all calls to.
- * @param AbandonedConfig the configuration for tracing abandoned objects
+ * @param c the {@link Connection} to delegate all calls to.
+ * @param config the configuration for tracing abandoned objects
* @deprecated AbandonedConfig is now deprecated.
*/
public DelegatingConnection(Connection c, AbandonedConfig config) {
Modified: jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingResultSet.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingResultSet.java?rev=390768&r1=390767&r2=390768&view=diff
==============================================================================
--- jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingResultSet.java (original)
+++ jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DelegatingResultSet.java Sat Apr 1 16:50:49 2006
@@ -64,8 +64,8 @@
* ResultSet to the Statement which created it and the
* code which created it.
*
- * @param Statement stmt which create this ResultSet
- * @param ResultSet to wrap
+ * @param stmt Statement which created this ResultSet
+ * @param res ResultSet to wrap
*/
public DelegatingResultSet(Statement stmt, ResultSet res) {
super((AbandonedTrace)stmt);
Modified: jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DriverManagerConnectionFactory.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DriverManagerConnectionFactory.java?rev=390768&r1=390767&r2=390768&view=diff
==============================================================================
--- jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DriverManagerConnectionFactory.java (original)
+++ jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/DriverManagerConnectionFactory.java Sat Apr 1 16:50:49 2006
@@ -45,10 +45,10 @@
/**
* Constructor for DriverManagerConnectionFactory.
- * @param url a database url of the form
+ * @param connectUri a database url of the form
* <code>jdbc:<em>subprotocol</em>:<em>subname</em></code>
- * @param user the database user
- * @param password the user's password
+ * @param uname the database user
+ * @param passwd the user's password
*/
public DriverManagerConnectionFactory(String connectUri, String uname, String passwd) {
_connectUri = connectUri;
Modified: jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/PoolingConnection.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/PoolingConnection.java?rev=390768&r1=390767&r2=390768&view=diff
==============================================================================
--- jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/PoolingConnection.java (original)
+++ jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/PoolingConnection.java Sat Apr 1 16:50:49 2006
@@ -53,7 +53,7 @@
/**
* Constructor.
* @param c the underlying {@link Connection}.
- * @param maxSleepingPerKey the maximum number of {@link PreparedStatement}s that may sit idle in my pool (per type)
+ * @param pool {@link KeyedObjectPool} of {@link PreparedStatement}s
*/
public PoolingConnection(Connection c, KeyedObjectPool pool) {
super(c);
Modified: jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/datasources/InstanceKeyDataSource.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/datasources/InstanceKeyDataSource.java?rev=390768&r1=390767&r2=390768&view=diff
==============================================================================
--- 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 Apr 1 16:50:49 2006
@@ -344,11 +344,12 @@
}
/**
- * Set the value of jndiEnvironment which is used when instantiating
- * a jndi InitialContext. This InitialContext is used to locate the
- * backend ConnectionPoolDataSource.
- *
- * @param v Value to assign to jndiEnvironment.
+ * Sets the value of the given JNDI environment property to be used when
+ * instantiating a JNDI InitialContext. This InitialContext is used to
+ * locate the backend ConnectionPoolDataSource.
+ *
+ * @param key the JNDI environment property to set.
+ * @param value the value assigned to specified JNDI environment property.
*/
public void setJndiEnvironment(String key, String value) {
if (jndiEnvironment == null) {
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org