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 2013/12/11 12:17:41 UTC
svn commit: r1550106 - in
/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp2:
BasicDataSourceMXBean.java package.html
Author: markt
Date: Wed Dec 11 11:17:40 2013
New Revision: 1550106
URL: http://svn.apache.org/r1550106
Log:
Javadoc fixes
Modified:
commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp2/BasicDataSourceMXBean.java
commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp2/package.html
Modified: commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp2/BasicDataSourceMXBean.java
URL: http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp2/BasicDataSourceMXBean.java?rev=1550106&r1=1550105&r2=1550106&view=diff
==============================================================================
--- commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp2/BasicDataSourceMXBean.java (original)
+++ commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp2/BasicDataSourceMXBean.java Wed Dec 11 11:17:40 2013
@@ -24,217 +24,217 @@ package org.apache.commons.dbcp2;
public interface BasicDataSourceMXBean {
/**
- * @See {@link BasicDataSource#getAbandonedUsageTracking()}
+ * @see {@link BasicDataSource#getAbandonedUsageTracking()}
* @return {@link BasicDataSource#getAbandonedUsageTracking()}
*/
boolean getAbandonedUsageTracking();
/**
- * @See {@link BasicDataSource#getDefaultAutoCommit()}
+ * @see {@link BasicDataSource#getDefaultAutoCommit()}
* @return {@link BasicDataSource#getDefaultAutoCommit()}
*/
boolean getDefaultAutoCommit();
/**
- * @See {@link BasicDataSource#getDefaultReadOnly()}
+ * @see {@link BasicDataSource#getDefaultReadOnly()}
* @return {@link BasicDataSource#getDefaultReadOnly()}
*/
boolean getDefaultReadOnly();
/**
- * @See {@link BasicDataSource#getDefaultTransactionIsolation()}
+ * @see {@link BasicDataSource#getDefaultTransactionIsolation()}
* @return {@link BasicDataSource#getDefaultTransactionIsolation()}
*/
int getDefaultTransactionIsolation();
/**
- * @See {@link BasicDataSource#getDefaultCatalog()}
+ * @see {@link BasicDataSource#getDefaultCatalog()}
* @return {@link BasicDataSource#getDefaultCatalog()}
*/
String getDefaultCatalog();
/**
- * @See {@link BasicDataSource#getCacheState()}
+ * @see {@link BasicDataSource#getCacheState()}
* @return {@link BasicDataSource#getCacheState()}
*/
boolean getCacheState();
/**
- * @See {@link BasicDataSource#getDriverClassName()}
+ * @see {@link BasicDataSource#getDriverClassName()}
* @return {@link BasicDataSource#getDriverClassName()}
*/
String getDriverClassName();
/**
- * @See {@link BasicDataSource#getLifo()}
+ * @see {@link BasicDataSource#getLifo()}
* @return {@link BasicDataSource#getLifo()}
*/
boolean getLifo();
/**
- * @See {@link BasicDataSource#getMaxTotal()}
+ * @see {@link BasicDataSource#getMaxTotal()}
* @return {@link BasicDataSource#getMaxTotal()}
*/
int getMaxTotal();
/**
- * @See {@link BasicDataSource#getMaxIdle()}
+ * @see {@link BasicDataSource#getMaxIdle()}
* @return {@link BasicDataSource#getMaxIdle()}
*/
int getMaxIdle();
/**
- * @See {@link BasicDataSource#getMinIdle()}
+ * @see {@link BasicDataSource#getMinIdle()}
* @return {@link BasicDataSource#getMinIdle()}
*/
int getMinIdle();
/**
- * @See {@link BasicDataSource#getInitialSize()}
+ * @see {@link BasicDataSource#getInitialSize()}
* @return {@link BasicDataSource#getInitialSize()}
*/
int getInitialSize();
/**
- * @See {@link BasicDataSource#getMaxWaitMillis()}
+ * @see {@link BasicDataSource#getMaxWaitMillis()}
* @return {@link BasicDataSource#getMaxWaitMillis()}
*/
long getMaxWaitMillis();
/**
- * @See {@link BasicDataSource#isPoolPreparedStatements()}
+ * @see {@link BasicDataSource#isPoolPreparedStatements()}
* @return {@link BasicDataSource#isPoolPreparedStatements()}
*/
boolean isPoolPreparedStatements();
/**
- * @See {@link BasicDataSource#getMaxOpenPreparedStatements()}
+ * @see {@link BasicDataSource#getMaxOpenPreparedStatements()}
* @return {@link BasicDataSource#getMaxOpenPreparedStatements()}
*/
int getMaxOpenPreparedStatements();
/**
- * @See {@link BasicDataSource#getTestOnBorrow()}
+ * @see {@link BasicDataSource#getTestOnBorrow()}
* @return {@link BasicDataSource#getTestOnBorrow()}
*/
boolean getTestOnBorrow();
/**
- * @See {@link BasicDataSource#getTimeBetweenEvictionRunsMillis()}
+ * @see {@link BasicDataSource#getTimeBetweenEvictionRunsMillis()}
* @return {@link BasicDataSource#getTimeBetweenEvictionRunsMillis()}
*/
long getTimeBetweenEvictionRunsMillis();
/**
- * @See {@link BasicDataSource#getNumTestsPerEvictionRun()}
+ * @see {@link BasicDataSource#getNumTestsPerEvictionRun()}
* @return {@link BasicDataSource#getNumTestsPerEvictionRun()}
*/
int getNumTestsPerEvictionRun();
/**
- * @See {@link BasicDataSource#getMinEvictableIdleTimeMillis()}
+ * @see {@link BasicDataSource#getMinEvictableIdleTimeMillis()}
* @return {@link BasicDataSource#getMinEvictableIdleTimeMillis()}
*/
long getMinEvictableIdleTimeMillis();
/**
- * @See {@link BasicDataSource#getSoftMinEvictableIdleTimeMillis()}
+ * @see {@link BasicDataSource#getSoftMinEvictableIdleTimeMillis()}
* @return {@link BasicDataSource#getSoftMinEvictableIdleTimeMillis()}
*/
long getSoftMinEvictableIdleTimeMillis();
/**
- * @See {@link BasicDataSource#getTestWhileIdle()}
+ * @see {@link BasicDataSource#getTestWhileIdle()}
* @return {@link BasicDataSource#getTestWhileIdle()}
*/
boolean getTestWhileIdle();
/**
- * @See {@link BasicDataSource#getNumActive()}
+ * @see {@link BasicDataSource#getNumActive()}
* @return {@link BasicDataSource#getNumActive()}
*/
int getNumActive();
/**
- * @See {@link BasicDataSource#getNumIdle()}
+ * @see {@link BasicDataSource#getNumIdle()}
* @return {@link BasicDataSource#getNumIdle()}
*/
int getNumIdle();
/**
- * @See {@link BasicDataSource#getPassword()}
+ * @see {@link BasicDataSource#getPassword()}
* @return {@link BasicDataSource#getPassword()}
*/
String getPassword();
/**
- * @See {@link BasicDataSource#getUrl()}
+ * @see {@link BasicDataSource#getUrl()}
* @return {@link BasicDataSource#getUrl()}
*/
String getUrl();
/**
- * @See {@link BasicDataSource#getUsername()}
+ * @see {@link BasicDataSource#getUsername()}
* @return {@link BasicDataSource#getUsername()}
*/
String getUsername();
/**
- * @See {@link BasicDataSource#getValidationQuery()}
+ * @see {@link BasicDataSource#getValidationQuery()}
* @return {@link BasicDataSource#getValidationQuery()}
*/
String getValidationQuery();
/**
- * @See {@link BasicDataSource#getValidationQueryTimeout()}
+ * @see {@link BasicDataSource#getValidationQueryTimeout()}
* @return {@link BasicDataSource#getValidationQueryTimeout()}
*/
int getValidationQueryTimeout();
/**
- * @See {@link BasicDataSource#getConnectionInitSqlsAsArray()}
+ * @see {@link BasicDataSource#getConnectionInitSqlsAsArray()}
* @return {@link BasicDataSource#getConnectionInitSqlsAsArray()}
*/
String[] getConnectionInitSqlsAsArray();
/**
- * @See {@link BasicDataSource#isAccessToUnderlyingConnectionAllowed()}
+ * @see {@link BasicDataSource#isAccessToUnderlyingConnectionAllowed()}
* @return {@link BasicDataSource#isAccessToUnderlyingConnectionAllowed()}
*/
boolean isAccessToUnderlyingConnectionAllowed();
/**
- * @See {@link BasicDataSource#getMaxConnLifetimeMillis()}
+ * @see {@link BasicDataSource#getMaxConnLifetimeMillis()}
* @return {@link BasicDataSource#getMaxConnLifetimeMillis()}
*/
long getMaxConnLifetimeMillis();
/**
- * @See {@link BasicDataSource#getRemoveAbandonedOnBorrow()}
+ * @see {@link BasicDataSource#getRemoveAbandonedOnBorrow()}
* @return {@link BasicDataSource#getRemoveAbandonedOnBorrow()}
*/
boolean getRemoveAbandonedOnBorrow();
/**
- * @See {@link BasicDataSource#getRemoveAbandonedOnMaintenance()}
+ * @see {@link BasicDataSource#getRemoveAbandonedOnMaintenance()}
* @return {@link BasicDataSource#getRemoveAbandonedOnMaintenance()}
*/
boolean getRemoveAbandonedOnMaintenance();
/**
- * @See {@link BasicDataSource#getRemoveAbandonedTimeout()}
+ * @see {@link BasicDataSource#getRemoveAbandonedTimeout()}
* @return {@link BasicDataSource#getRemoveAbandonedTimeout()}
*/
int getRemoveAbandonedTimeout();
/**
- * @See {@link BasicDataSource#getLogAbandoned()}
+ * @see {@link BasicDataSource#getLogAbandoned()}
* @return {@link BasicDataSource#getLogAbandoned()}
*/
boolean getLogAbandoned();
/**
- * @See {@link BasicDataSource#isClosed()}
+ * @see {@link BasicDataSource#isClosed()}
* @return {@link BasicDataSource#isClosed()}
*/
boolean isClosed();
Modified: commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp2/package.html
URL: http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp2/package.html?rev=1550106&r1=1550105&r2=1550106&view=diff
==============================================================================
--- commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp2/package.html (original)
+++ commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp2/package.html Wed Dec 11 11:17:40 2013
@@ -42,20 +42,20 @@
get one of those?
</p><p>
A: The {@link org.apache.commons.pool2.ObjectPool ObjectPool} interface is defined
- in the {@link org.apache.commons.pool} package (Commons-Pool).
+ in the {@link org.apache.commons.pool2} package (Commons-Pool).
The {@link org.apache.commons.pool2.impl} package has a couple of implementations,
and you can always create your own.
</p>
<p>
Q: Ok, I've found an {@link org.apache.commons.pool2.ObjectPool ObjectPool}
implementation that I think suits my connection pooling needs. But it wants
- a {@link org.apache.commons.pool2.PoolableObjectFactory PoolableObjectFactory}.
+ a {@link org.apache.commons.pool2.PooledObjectFactory PooledObjectFactory}.
What should I use for that?
</p><p>
A: The DBCP package provides a class for this purpose. It's called
{@link org.apache.commons.dbcp2.PoolableConnectionFactory}.
It implements the factory and lifecycle methods of
- {@link org.apache.commons.pool2.PoolableObjectFactory}
+ {@link org.apache.commons.pool2.PooledObjectFactory}
for {@link java.sql.Connection}s. But it doesn't create the actual database
{@link java.sql.Connection}s itself, it uses a
{@link org.apache.commons.dbcp2.ConnectionFactory} for that.
@@ -85,7 +85,7 @@
{@link java.sql.Connection}.
</p><p>
To create a {@link org.apache.commons.pool2.ObjectPool}, you'll need
- a {@link org.apache.commons.pool2.PoolableObjectFactory} that creates
+ a {@link org.apache.commons.pool2.PooledObjectFactory} that creates
the actual {@link java.sql.Connection}s. That's what
{@link org.apache.commons.dbcp2.PoolableConnectionFactory} is for.
</p><p>
@@ -102,7 +102,7 @@
<br></br>
When you pass an {@link org.apache.commons.pool2.ObjectPool} into the
{@link org.apache.commons.dbcp2.PoolableConnectionFactory}, it will
- automatically register itself as the {@link org.apache.commons.pool2.PoolableObjectFactory}
+ automatically register itself as the {@link org.apache.commons.pool2.PooledObjectFactory}
for that pool.
</li>
</ol>