This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-dbcp.git
The following commit(s) were added to refs/heads/master by this push:
new 9828d7f7 Javadoc
9828d7f7 is described below
commit 9828d7f78487619fcee41fbd3068b1e1e8913771
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:44:41 2026 -0400
Javadoc
---
.../org/apache/commons/dbcp2/BasicDataSource.java | 60 +++++++++++-----------
.../apache/commons/dbcp2/DelegatingConnection.java | 8 +--
.../commons/dbcp2/DelegatingDatabaseMetaData.java | 2 +-
.../apache/commons/dbcp2/DelegatingResultSet.java | 2 +-
.../apache/commons/dbcp2/DelegatingStatement.java | 2 +-
.../org/apache/commons/dbcp2/ListException.java | 2 +-
.../java/org/apache/commons/dbcp2/PStmtKey.java | 4 +-
.../commons/dbcp2/PoolableConnectionFactory.java | 4 +-
.../commons/dbcp2/PoolableConnectionMXBean.java | 2 +-
.../apache/commons/dbcp2/PoolingConnection.java | 18 +++----
.../apache/commons/dbcp2/PoolingDataSource.java | 2 +-
.../org/apache/commons/dbcp2/PoolingDriver.java | 2 +-
.../commons/dbcp2/cpdsadapter/ConnectionImpl.java | 8 +--
.../dbcp2/cpdsadapter/DriverAdapterCPDS.java | 14 ++---
.../dbcp2/datasources/InstanceKeyDataSource.java | 4 +-
.../dbcp2/datasources/PerUserPoolDataSource.java | 4 +-
.../dbcp2/datasources/PooledConnectionAndInfo.java | 2 +-
.../dbcp2/managed/BasicManagedDataSource.java | 10 ++--
.../managed/DataSourceXAConnectionFactory.java | 8 +--
.../dbcp2/managed/LocalXAConnectionFactory.java | 2 +-
.../commons/dbcp2/managed/TransactionContext.java | 2 +-
.../commons/dbcp2/managed/XAConnectionFactory.java | 2 +-
.../org/apache/commons/dbcp2/StackMessageLog.java | 2 +-
.../java/org/apache/commons/dbcp2/TestJndi.java | 2 +-
24 files changed, 84 insertions(+), 84 deletions(-)
diff --git a/src/main/java/org/apache/commons/dbcp2/BasicDataSource.java
b/src/main/java/org/apache/commons/dbcp2/BasicDataSource.java
index faf6efa7..1ff5d34b 100644
--- a/src/main/java/org/apache/commons/dbcp2/BasicDataSource.java
+++ b/src/main/java/org/apache/commons/dbcp2/BasicDataSource.java
@@ -697,7 +697,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* Gets the state caching flag.
*
- * @return the state caching flag
+ * @return The state caching flag
*/
@Override
public boolean getCacheState() {
@@ -749,7 +749,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
* Note: This getter only returns the last value set by a call to {@link
#setConnectionFactoryClassName(String)}.
* </p>
*
- * @return the ConnectionFactoryClassName that has been configured for use
by this pool.
+ * @return The ConnectionFactoryClassName that has been configured for use
by this pool.
* @since 2.7.0
*/
public String getConnectionFactoryClassName() {
@@ -778,7 +778,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* Gets the underlying connection pool.
*
- * @return the underlying connection pool.
+ * @return The underlying connection pool.
* @since 2.10.0
*/
public GenericObjectPool<PoolableConnection> getConnectionPool() {
@@ -802,7 +802,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* Gets the default catalog.
*
- * @return the default catalog
+ * @return The default catalog
*/
@Override
public String getDefaultCatalog() {
@@ -845,7 +845,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* Gets the default schema.
*
- * @return the default schema.
+ * @return The default schema.
* @since 2.5.0
*/
@Override
@@ -856,7 +856,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* Gets the default transaction isolation state of returned connections.
*
- * @return the default value for transaction isolation state
+ * @return The default value for transaction isolation state
* @see Connection#getTransactionIsolation
*/
@Override
@@ -919,7 +919,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
* driver instance that may have been created from the value set via
{@link #setDriverClassName(String)}.
* </p>
*
- * @return the JDBC Driver that has been configured for use by this pool
+ * @return The JDBC Driver that has been configured for use by this pool
*/
public synchronized Driver getDriver() {
return driver;
@@ -946,7 +946,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
* return the class name of any driver that may have been set via {@link
#setDriver(Driver)}.
* </p>
*
- * @return the JDBC driver class name
+ * @return The JDBC driver class name
*/
@Override
public synchronized String getDriverClassName() {
@@ -956,7 +956,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* Gets the value of the {code durationBetweenEvictionRuns} property.
*
- * @return the time (in milliseconds) between evictor runs
+ * @return The time (in milliseconds) between evictor runs
* @see #setDurationBetweenEvictionRuns(Duration)
* @since 2.10.0
*/
@@ -1003,7 +1003,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* Gets the initial size of the connection pool.
*
- * @return the number of connections created when the pool is initialized
+ * @return The number of connections created when the pool is initialized
*/
@Override
public synchronized int getInitialSize() {
@@ -1095,7 +1095,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
* Gets the maximum permitted duration of a connection. A value of zero or
less indicates an
* infinite lifetime.
*
- * @return the maximum permitted duration of a connection.
+ * @return The maximum permitted duration of a connection.
* @since 2.10.0
*/
public Duration getMaxConnDuration() {
@@ -1121,7 +1121,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
* A negative value indicates that there is no limit
* </p>
*
- * @return the maximum number of idle connections
+ * @return The maximum number of idle connections
*/
@Override
public synchronized int getMaxIdle() {
@@ -1131,7 +1131,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* Gets the value of the {@code maxOpenPreparedStatements} property.
*
- * @return the maximum number of open statements
+ * @return The maximum number of open statements
*/
@Override
public synchronized int getMaxOpenPreparedStatements() {
@@ -1144,7 +1144,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
* A negative number means that there is no limit.
* </p>
*
- * @return the maximum number of active connections
+ * @return The maximum number of active connections
*/
@Override
public synchronized int getMaxTotal() {
@@ -1155,7 +1155,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
* Gets the maximum Duration that the pool will wait for a connection to
be returned before throwing an exception. A
* value less than or equal to zero means the pool is set to wait
indefinitely.
*
- * @return the maxWaitDuration property value.
+ * @return The maxWaitDuration property value.
* @since 2.10.0
*/
public synchronized Duration getMaxWaitDuration() {
@@ -1166,7 +1166,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
* Gets the maximum number of milliseconds that the pool will wait for a
connection to be returned before
* throwing an exception. A value less than or equal to zero means the
pool is set to wait indefinitely.
*
- * @return the maxWaitMillis property value.
+ * @return The maxWaitMillis property value.
* @deprecated Use {@link #getMaxWaitDuration()}.
*/
@Deprecated
@@ -1178,7 +1178,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* Gets the {code minEvictableIdleDuration} property.
*
- * @return the value of the {code minEvictableIdleDuration} property
+ * @return The value of the {code minEvictableIdleDuration} property
* @see #setMinEvictableIdle(Duration)
* @since 2.10.0
*/
@@ -1189,7 +1189,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* Gets the {code minEvictableIdleDuration} property.
*
- * @return the value of the {code minEvictableIdleDuration} property
+ * @return The value of the {code minEvictableIdleDuration} property
* @see #setMinEvictableIdle(Duration)
* @deprecated Use {@link #getMinEvictableIdleDuration()}.
*/
@@ -1204,7 +1204,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
* are available when the idle object evictor runs. The value of this
property has no effect unless
* {code durationBetweenEvictionRuns} has a positive value.
*
- * @return the minimum number of idle connections
+ * @return The minimum number of idle connections
* @see GenericObjectPool#getMinIdle()
*/
@Override
@@ -1215,7 +1215,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* [Read Only] The current number of active connections that have been
allocated from this data source.
*
- * @return the current number of active connections
+ * @return The current number of active connections
*/
@Override
public int getNumActive() {
@@ -1227,7 +1227,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* [Read Only] The current number of idle connections that are waiting to
be allocated from this data source.
*
- * @return the current number of idle connections
+ * @return The current number of idle connections
*/
@Override
public int getNumIdle() {
@@ -1239,7 +1239,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* Gets the value of the {code numTestsPerEvictionRun} property.
*
- * @return the number of objects to examine during idle object evictor runs
+ * @return The number of objects to examine during idle object evictor runs
* @see #setNumTestsPerEvictionRun(int)
*/
@Override
@@ -1255,7 +1255,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* Gets the password passed to the JDBC driver to establish connections.
*
- * @return the connection password
+ * @return The connection password
* @deprecated Exposing passwords via JMX is an Information Exposure issue.
*/
@Deprecated
@@ -1267,7 +1267,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* Gets the registered JMX ObjectName.
*
- * @return the registered JMX ObjectName.
+ * @return The registered JMX ObjectName.
*/
protected ObjectName getRegisteredJmxName() {
return ObjectNameWrapper.unwrap(registeredJmxObjectName);
@@ -1463,7 +1463,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* Gets the value of the {code durationBetweenEvictionRuns} property.
*
- * @return the time (in milliseconds) between evictor runs
+ * @return The time (in milliseconds) between evictor runs
* @see #setDurationBetweenEvictionRuns(Duration)
* @deprecated Use {@link #getDurationBetweenEvictionRuns()}.
*/
@@ -1476,7 +1476,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* Gets the JDBC connection {code connectionString} property.
*
- * @return the {code connectionString} passed to the JDBC driver to
establish connections
+ * @return The {code connectionString} passed to the JDBC driver to
establish connections
*/
@Override
public synchronized String getUrl() {
@@ -1486,7 +1486,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* Gets the JDBC connection {code userName} property.
*
- * @return the {code userName} passed to the JDBC driver to establish
connections
+ * @return The {code userName} passed to the JDBC driver to establish
connections
* @deprecated Use {@link #getUserName()}.
*/
@Deprecated
@@ -1498,7 +1498,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* Gets the validation query used to validate connections before returning
them.
*
- * @return the SQL validation query
+ * @return The SQL validation query
* @see #setValidationQuery(String)
*/
@Override
@@ -1509,7 +1509,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* Gets the validation query timeout.
*
- * @return the timeout in seconds before connection validation queries
fail.
+ * @return The timeout in seconds before connection validation queries
fail.
* @deprecated Use {@link #getValidationQueryTimeoutDuration()}.
*/
@Deprecated
@@ -1521,7 +1521,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
/**
* Gets the validation query timeout.
*
- * @return the timeout in seconds before connection validation queries
fail.
+ * @return The timeout in seconds before connection validation queries
fail.
*/
public Duration getValidationQueryTimeoutDuration() {
return validationQueryTimeoutDuration;
diff --git a/src/main/java/org/apache/commons/dbcp2/DelegatingConnection.java
b/src/main/java/org/apache/commons/dbcp2/DelegatingConnection.java
index 8934f7f2..94e1834e 100644
--- a/src/main/java/org/apache/commons/dbcp2/DelegatingConnection.java
+++ b/src/main/java/org/apache/commons/dbcp2/DelegatingConnection.java
@@ -337,7 +337,7 @@ public class DelegatingConnection<C extends Connection>
extends AbandonedTrace i
* <li>read-only</li>
* </ul>
*
- * @return the state caching flag
+ * @return The state caching flag
*/
public boolean getCacheState() {
return cacheState;
@@ -415,7 +415,7 @@ public class DelegatingConnection<C extends Connection>
extends AbandonedTrace i
/**
* Gets the delegate connection.
*
- * @return the delegate connection.
+ * @return The delegate connection.
*/
protected final C getDelegateInternal() {
return connection;
@@ -553,7 +553,7 @@ public class DelegatingConnection<C extends Connection>
extends AbandonedTrace i
*
* @param <T> The throwable type.
* @param e The SQLException
- * @return the given {@link SQLException}
+ * @return The given {@link SQLException}
* @since 2.7.0
*/
protected <T extends Throwable> T handleExceptionNoThrow(final T e) {
@@ -599,7 +599,7 @@ public class DelegatingConnection<C extends Connection>
extends AbandonedTrace i
/**
* Tests the raw internal closed state.
*
- * @return the raw internal closed state.
+ * @return The raw internal closed state.
*/
protected boolean isClosedInternal() {
return closed;
diff --git
a/src/main/java/org/apache/commons/dbcp2/DelegatingDatabaseMetaData.java
b/src/main/java/org/apache/commons/dbcp2/DelegatingDatabaseMetaData.java
index 3b860d62..ad40902d 100644
--- a/src/main/java/org/apache/commons/dbcp2/DelegatingDatabaseMetaData.java
+++ b/src/main/java/org/apache/commons/dbcp2/DelegatingDatabaseMetaData.java
@@ -273,7 +273,7 @@ public class DelegatingDatabaseMetaData implements
DatabaseMetaData {
* This method is useful when you may have nested {@link
DelegatingResultSet}s, and you want to make sure to obtain a "genuine" {@link
ResultSet}.
* </p>
*
- * @return the innermost database meta data.
+ * @return The innermost database meta data.
*/
public DatabaseMetaData getInnermostDelegate() {
DatabaseMetaData m = databaseMetaData;
diff --git a/src/main/java/org/apache/commons/dbcp2/DelegatingResultSet.java
b/src/main/java/org/apache/commons/dbcp2/DelegatingResultSet.java
index e61525bc..2f15f489 100644
--- a/src/main/java/org/apache/commons/dbcp2/DelegatingResultSet.java
+++ b/src/main/java/org/apache/commons/dbcp2/DelegatingResultSet.java
@@ -602,7 +602,7 @@ public final class DelegatingResultSet extends
AbandonedTrace implements ResultS
* a "genuine" {@link ResultSet}.
* </p>
*
- * @return the innermost delegate.
+ * @return The innermost delegate.
*/
@SuppressWarnings("resource")
public ResultSet getInnermostDelegate() {
diff --git a/src/main/java/org/apache/commons/dbcp2/DelegatingStatement.java
b/src/main/java/org/apache/commons/dbcp2/DelegatingStatement.java
index 83d0348d..dffb42b3 100644
--- a/src/main/java/org/apache/commons/dbcp2/DelegatingStatement.java
+++ b/src/main/java/org/apache/commons/dbcp2/DelegatingStatement.java
@@ -400,7 +400,7 @@ public class DelegatingStatement extends AbandonedTrace
implements Statement {
/**
* Gets the internal connection.
*
- * @return the internal connection.
+ * @return The internal connection.
*/
protected DelegatingConnection<?> getConnectionInternal() {
return connection;
diff --git a/src/main/java/org/apache/commons/dbcp2/ListException.java
b/src/main/java/org/apache/commons/dbcp2/ListException.java
index e1263126..2c3d31a7 100644
--- a/src/main/java/org/apache/commons/dbcp2/ListException.java
+++ b/src/main/java/org/apache/commons/dbcp2/ListException.java
@@ -50,7 +50,7 @@ public class ListException extends Exception {
/**
* Gets the list of exceptions.
*
- * @return the list of exceptions.
+ * @return The list of exceptions.
*/
public List<Throwable> getExceptionList() {
return exceptionList;
diff --git a/src/main/java/org/apache/commons/dbcp2/PStmtKey.java
b/src/main/java/org/apache/commons/dbcp2/PStmtKey.java
index 20642a56..733f6297 100644
--- a/src/main/java/org/apache/commons/dbcp2/PStmtKey.java
+++ b/src/main/java/org/apache/commons/dbcp2/PStmtKey.java
@@ -596,7 +596,7 @@ public class PStmtKey {
* Gets the result set type, one of {@link ResultSet#TYPE_FORWARD_ONLY},
{@link ResultSet#TYPE_SCROLL_INSENSITIVE}, or
* {@link ResultSet#TYPE_SCROLL_SENSITIVE}.
*
- * @return the result set type.
+ * @return The result set type.
*/
public Integer getResultSetType() {
return resultSetType;
@@ -614,7 +614,7 @@ public class PStmtKey {
/**
* Gets the SQL statement.
*
- * @return the SQL statement.
+ * @return The SQL statement.
*/
public String getSql() {
return sql;
diff --git
a/src/main/java/org/apache/commons/dbcp2/PoolableConnectionFactory.java
b/src/main/java/org/apache/commons/dbcp2/PoolableConnectionFactory.java
index c7b6feb5..f7027abe 100644
--- a/src/main/java/org/apache/commons/dbcp2/PoolableConnectionFactory.java
+++ b/src/main/java/org/apache/commons/dbcp2/PoolableConnectionFactory.java
@@ -174,7 +174,7 @@ public class PoolableConnectionFactory implements
PooledObjectFactory<PoolableCo
/**
* Gets how many connections were created in {@link #makeObject()}.
*
- * @return the connection count.
+ * @return The connection count.
*/
protected AtomicLong getConnectionIndex() {
return connectionIndex;
@@ -360,7 +360,7 @@ public class PoolableConnectionFactory implements
PooledObjectFactory<PoolableCo
/**
* Returns the {@link ObjectPool} in which {@link Connection}s are pooled.
*
- * @return the connection pool
+ * @return The connection pool
*/
public synchronized ObjectPool<PoolableConnection> getPool() {
return pool;
diff --git
a/src/main/java/org/apache/commons/dbcp2/PoolableConnectionMXBean.java
b/src/main/java/org/apache/commons/dbcp2/PoolableConnectionMXBean.java
index b907362b..376ead84 100644
--- a/src/main/java/org/apache/commons/dbcp2/PoolableConnectionMXBean.java
+++ b/src/main/java/org/apache/commons/dbcp2/PoolableConnectionMXBean.java
@@ -93,7 +93,7 @@ public interface PoolableConnectionMXBean {
/**
* Gets the value of the {@link Object#toString()} method via a bean
getter, so it can be read as a property via JMX.
*
- * @return the value of the {@link Object#toString()}.
+ * @return The value of the {@link Object#toString()}.
*/
String getToString();
diff --git a/src/main/java/org/apache/commons/dbcp2/PoolingConnection.java
b/src/main/java/org/apache/commons/dbcp2/PoolingConnection.java
index de15e4db..13859323 100644
--- a/src/main/java/org/apache/commons/dbcp2/PoolingConnection.java
+++ b/src/main/java/org/apache/commons/dbcp2/PoolingConnection.java
@@ -157,7 +157,7 @@ public class PoolingConnection extends
DelegatingConnection<Connection>
* @param sql
* the SQL string used to define the statement
*
- * @return the PStmtKey created for the given arguments.
+ * @return The PStmtKey created for the given arguments.
*/
protected PStmtKey createKey(final String sql) {
return new PStmtKey(normalizeSQL(sql), getCatalogOrNull(),
getSchemaOrNull());
@@ -172,7 +172,7 @@ public class PoolingConnection extends
DelegatingConnection<Connection>
* A flag indicating whether auto-generated keys should be
returned; one of
* {@link Statement#RETURN_GENERATED_KEYS} or {@link
Statement#NO_GENERATED_KEYS}.
*
- * @return the PStmtKey created for the given arguments.
+ * @return The PStmtKey created for the given arguments.
*/
protected PStmtKey createKey(final String sql, final int
autoGeneratedKeys) {
return new PStmtKey(normalizeSQL(sql), getCatalogOrNull(),
getSchemaOrNull(), autoGeneratedKeys);
@@ -188,7 +188,7 @@ public class PoolingConnection extends
DelegatingConnection<Connection>
* @param resultSetConcurrency
* result set concurrency
*
- * @return the PStmtKey created for the given arguments.
+ * @return The PStmtKey created for the given arguments.
*/
protected PStmtKey createKey(final String sql, final int resultSetType,
final int resultSetConcurrency) {
return new PStmtKey(normalizeSQL(sql), getCatalogOrNull(),
getSchemaOrNull(), resultSetType, resultSetConcurrency);
@@ -206,7 +206,7 @@ public class PoolingConnection extends
DelegatingConnection<Connection>
* @param resultSetHoldability
* result set holdability
*
- * @return the PStmtKey created for the given arguments.
+ * @return The PStmtKey created for the given arguments.
*/
protected PStmtKey createKey(final String sql, final int resultSetType,
final int resultSetConcurrency,
final int resultSetHoldability) {
@@ -228,7 +228,7 @@ public class PoolingConnection extends
DelegatingConnection<Connection>
* @param statementType
* statement type
*
- * @return the PStmtKey created for the given arguments.
+ * @return The PStmtKey created for the given arguments.
*/
protected PStmtKey createKey(final String sql, final int resultSetType,
final int resultSetConcurrency,
final int resultSetHoldability, final StatementType statementType)
{
@@ -248,7 +248,7 @@ public class PoolingConnection extends
DelegatingConnection<Connection>
* @param statementType
* statement type
*
- * @return the PStmtKey created for the given arguments.
+ * @return The PStmtKey created for the given arguments.
*/
protected PStmtKey createKey(final String sql, final int resultSetType,
final int resultSetConcurrency,
final StatementType statementType) {
@@ -264,7 +264,7 @@ public class PoolingConnection extends
DelegatingConnection<Connection>
* An array of column indexes indicating the columns that
should be returned from the inserted row or
* rows.
*
- * @return the PStmtKey created for the given arguments.
+ * @return The PStmtKey created for the given arguments.
*/
protected PStmtKey createKey(final String sql, final int[] columnIndexes) {
return new PStmtKey(normalizeSQL(sql), getCatalogOrNull(),
getSchemaOrNull(), columnIndexes);
@@ -278,7 +278,7 @@ public class PoolingConnection extends
DelegatingConnection<Connection>
* @param statementType
* statement type
*
- * @return the PStmtKey created for the given arguments.
+ * @return The PStmtKey created for the given arguments.
*/
protected PStmtKey createKey(final String sql, final StatementType
statementType) {
return new PStmtKey(normalizeSQL(sql), getCatalogOrNull(),
getSchemaOrNull(), statementType, null);
@@ -292,7 +292,7 @@ public class PoolingConnection extends
DelegatingConnection<Connection>
* @param columnNames
* column names
*
- * @return the PStmtKey created for the given arguments.
+ * @return The PStmtKey created for the given arguments.
*/
protected PStmtKey createKey(final String sql, final String[] columnNames)
{
return new PStmtKey(normalizeSQL(sql), getCatalogOrNull(),
getSchemaOrNull(), columnNames);
diff --git a/src/main/java/org/apache/commons/dbcp2/PoolingDataSource.java
b/src/main/java/org/apache/commons/dbcp2/PoolingDataSource.java
index d72ddb90..452e180c 100644
--- a/src/main/java/org/apache/commons/dbcp2/PoolingDataSource.java
+++ b/src/main/java/org/apache/commons/dbcp2/PoolingDataSource.java
@@ -194,7 +194,7 @@ public class PoolingDataSource<C extends Connection>
implements DataSource, Auto
/**
* Gets the backing object pool.
*
- * @return the backing object pool.
+ * @return The backing object pool.
*/
protected ObjectPool<C> getPool() {
return pool;
diff --git a/src/main/java/org/apache/commons/dbcp2/PoolingDriver.java
b/src/main/java/org/apache/commons/dbcp2/PoolingDriver.java
index 323bc164..c9db33e8 100644
--- a/src/main/java/org/apache/commons/dbcp2/PoolingDriver.java
+++ b/src/main/java/org/apache/commons/dbcp2/PoolingDriver.java
@@ -209,7 +209,7 @@ public class PoolingDriver implements Driver {
/**
* Gets the pool names.
*
- * @return the pool names.
+ * @return The pool names.
*/
public synchronized String[] getPoolNames() {
return pools.keySet().toArray(Utils.EMPTY_STRING_ARRAY);
diff --git
a/src/main/java/org/apache/commons/dbcp2/cpdsadapter/ConnectionImpl.java
b/src/main/java/org/apache/commons/dbcp2/cpdsadapter/ConnectionImpl.java
index 5009d0cc..bd994c36 100644
--- a/src/main/java/org/apache/commons/dbcp2/cpdsadapter/ConnectionImpl.java
+++ b/src/main/java/org/apache/commons/dbcp2/cpdsadapter/ConnectionImpl.java
@@ -87,7 +87,7 @@ final class ConnectionImpl extends
DelegatingConnection<Connection> {
/**
* Gets the delegated connection, if allowed.
*
- * @return the internal connection, or null if access is not allowed.
+ * @return The internal connection, or null if access is not allowed.
* @see #isAccessToUnderlyingConnectionAllowed()
*/
@Override
@@ -101,7 +101,7 @@ final class ConnectionImpl extends
DelegatingConnection<Connection> {
/**
* Gets the innermost connection, if allowed.
*
- * @return the innermost internal connection, or null if access is not
allowed.
+ * @return The innermost internal connection, or null if access is not
allowed.
* @see #isAccessToUnderlyingConnectionAllowed()
*/
@Override
@@ -115,7 +115,7 @@ final class ConnectionImpl extends
DelegatingConnection<Connection> {
/**
* Package-private for tests.
*
- * @return the PooledConnectionImpl.
+ * @return The PooledConnectionImpl.
*/
PooledConnectionImpl getPooledConnectionImpl() {
return pooledConnection;
@@ -229,7 +229,7 @@ final class ConnectionImpl extends
DelegatingConnection<Connection> {
*
* @param sql
* SQL statement to be prepared
- * @return the prepared statement
+ * @return The prepared statement
* @throws SQLException
* if this connection is closed or an error occurs in the
wrapped connection.
*/
diff --git
a/src/main/java/org/apache/commons/dbcp2/cpdsadapter/DriverAdapterCPDS.java
b/src/main/java/org/apache/commons/dbcp2/cpdsadapter/DriverAdapterCPDS.java
index db1340da..45300036 100644
--- a/src/main/java/org/apache/commons/dbcp2/cpdsadapter/DriverAdapterCPDS.java
+++ b/src/main/java/org/apache/commons/dbcp2/cpdsadapter/DriverAdapterCPDS.java
@@ -188,7 +188,7 @@ public class DriverAdapterCPDS implements
ConnectionPoolDataSource, Referenceabl
/**
* Gets the connection properties passed to the JDBC driver.
*
- * @return the JDBC connection properties used when creating connections.
+ * @return The JDBC connection properties used when creating connections.
*/
public Properties getConnectionProperties() {
return connectionProperties;
@@ -218,7 +218,7 @@ public class DriverAdapterCPDS implements
ConnectionPoolDataSource, Referenceabl
* Gets the duration to sleep between runs of the idle object evictor
thread. When non-positive, no
* idle object evictor thread will be run.
*
- * @return the value of the evictor thread timer
+ * @return The value of the evictor thread timer
* @see #setDurationBetweenEvictionRuns(Duration)
* @since 2.9.0
*/
@@ -251,7 +251,7 @@ public class DriverAdapterCPDS implements
ConnectionPoolDataSource, Referenceabl
* Gets the maximum number of statements that can remain idle in the pool,
without extra ones being released, or
* negative for no limit.
*
- * @return the value of maxIdle
+ * @return The value of maxIdle
*/
public int getMaxIdle() {
return maxIdle;
@@ -272,7 +272,7 @@ public class DriverAdapterCPDS implements
ConnectionPoolDataSource, Referenceabl
*
* @see #setMinEvictableIdleDuration
* @see #setDurationBetweenEvictionRuns
- * @return the minimum amount of time a statement may sit idle in the pool.
+ * @return The minimum amount of time a statement may sit idle in the pool.
* @since 2.9.0
*/
public Duration getMinEvictableIdleDuration() {
@@ -285,7 +285,7 @@ public class DriverAdapterCPDS implements
ConnectionPoolDataSource, Referenceabl
*
* @see #setMinEvictableIdleTimeMillis
* @see #setTimeBetweenEvictionRunsMillis
- * @return the minimum amount of time a statement may sit idle in the pool.
+ * @return The minimum amount of time a statement may sit idle in the pool.
* @deprecated USe {@link #getMinEvictableIdleDuration()}.
*/
@Deprecated
@@ -298,7 +298,7 @@ public class DriverAdapterCPDS implements
ConnectionPoolDataSource, Referenceabl
*
* @see #setNumTestsPerEvictionRun
* @see #setTimeBetweenEvictionRunsMillis
- * @return the number of statements to examine during each run of the idle
object evictor thread (if any.)
+ * @return The number of statements to examine during each run of the idle
object evictor thread (if any.)
*/
public int getNumTestsPerEvictionRun() {
return numTestsPerEvictionRun;
@@ -510,7 +510,7 @@ public class DriverAdapterCPDS implements
ConnectionPoolDataSource, Referenceabl
* Gets the number of milliseconds to sleep between runs of the idle
object evictor thread. When non-positive, no
* idle object evictor thread will be run.
*
- * @return the value of the evictor thread timer
+ * @return The value of the evictor thread timer
* @see #setDurationBetweenEvictionRuns(Duration)
* @deprecated Use {@link #getDurationBetweenEvictionRuns()}.
*/
diff --git
a/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSource.java
b/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSource.java
index 217292af..bb2bb562 100644
---
a/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSource.java
+++
b/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSource.java
@@ -311,7 +311,7 @@ public abstract class InstanceKeyDataSource implements
DataSource, Referenceable
* Gets the pooled connection manager for the given key.
*
* @param upkey the key.
- * @return the pooled connection manager for the given key.
+ * @return The pooled connection manager for the given key.
*/
protected abstract PooledConnectionManager
getConnectionManager(UserPassKey upkey);
@@ -563,7 +563,7 @@ public abstract class InstanceKeyDataSource implements
DataSource, Referenceable
/**
* Gets the instance key.
*
- * @return the instance key.
+ * @return The instance key.
*/
protected String getInstanceKey() {
return instanceKey;
diff --git
a/src/main/java/org/apache/commons/dbcp2/datasources/PerUserPoolDataSource.java
b/src/main/java/org/apache/commons/dbcp2/datasources/PerUserPoolDataSource.java
index c71b0452..9f001229 100644
---
a/src/main/java/org/apache/commons/dbcp2/datasources/PerUserPoolDataSource.java
+++
b/src/main/java/org/apache/commons/dbcp2/datasources/PerUserPoolDataSource.java
@@ -245,7 +245,7 @@ public class PerUserPoolDataSource extends
InstanceKeyDataSource {
* Gets the underlying pre-allocated pool (does NOT allocate).
*
* @param manager A CPDSConnectionFactory.
- * @return the underlying pool.
+ * @return The underlying pool.
*/
private ObjectPool<PooledConnectionAndInfo>
getCPDSConnectionFactoryPool(final PooledConnectionManager manager) {
return ((CPDSConnectionFactory) manager).getPool();
@@ -577,7 +577,7 @@ public class PerUserPoolDataSource extends
InstanceKeyDataSource {
*
* @param poolKey
* PoolKey identifying the pool
- * @return the GenericObjectPool pooling connections for the userName and
datasource specified by the PoolKey
+ * @return The GenericObjectPool pooling connections for the userName and
datasource specified by the PoolKey
*/
private ObjectPool<PooledConnectionAndInfo> getPool(final PoolKey poolKey)
{
final CPDSConnectionFactory mgr = (CPDSConnectionFactory)
managers.get(poolKey);
diff --git
a/src/main/java/org/apache/commons/dbcp2/datasources/PooledConnectionAndInfo.java
b/src/main/java/org/apache/commons/dbcp2/datasources/PooledConnectionAndInfo.java
index bef8874d..07e640c1 100644
---
a/src/main/java/org/apache/commons/dbcp2/datasources/PooledConnectionAndInfo.java
+++
b/src/main/java/org/apache/commons/dbcp2/datasources/PooledConnectionAndInfo.java
@@ -47,7 +47,7 @@ final class PooledConnectionAndInfo {
/**
* Gets the pooled connection.
*
- * @return the pooled connection.
+ * @return The pooled connection.
*/
PooledConnection getPooledConnection() {
return pooledConnection;
diff --git
a/src/main/java/org/apache/commons/dbcp2/managed/BasicManagedDataSource.java
b/src/main/java/org/apache/commons/dbcp2/managed/BasicManagedDataSource.java
index 8ffb0461..05bbbdce 100644
--- a/src/main/java/org/apache/commons/dbcp2/managed/BasicManagedDataSource.java
+++ b/src/main/java/org/apache/commons/dbcp2/managed/BasicManagedDataSource.java
@@ -165,7 +165,7 @@ public class BasicManagedDataSource extends BasicDataSource
{
/**
* Gets the required transaction manager property.
*
- * @return the transaction manager used to enlist connections
+ * @return The transaction manager used to enlist connections
*/
public TransactionManager getTransactionManager() {
return transactionManager;
@@ -174,7 +174,7 @@ public class BasicManagedDataSource extends BasicDataSource
{
/**
* Gets the transaction registry.
*
- * @return the transaction registry associating XAResources with managed
connections
+ * @return The transaction registry associating XAResources with managed
connections
*/
protected synchronized TransactionRegistry getTransactionRegistry() {
return transactionRegistry;
@@ -183,7 +183,7 @@ public class BasicManagedDataSource extends BasicDataSource
{
/**
* Gets the optional TransactionSynchronizationRegistry.
*
- * @return the TSR that can be used to register synchronizations.
+ * @return The TSR that can be used to register synchronizations.
* @since 2.6.0
*/
public TransactionSynchronizationRegistry
getTransactionSynchronizationRegistry() {
@@ -193,7 +193,7 @@ public class BasicManagedDataSource extends BasicDataSource
{
/**
* Gets the optional XADataSource class name.
*
- * @return the optional XADataSource class name
+ * @return The optional XADataSource class name
*/
public synchronized String getXADataSource() {
return xaDataSource;
@@ -202,7 +202,7 @@ public class BasicManagedDataSource extends BasicDataSource
{
/**
* Gets the XADataSource instance used by the XAConnectionFactory.
*
- * @return the XADataSource
+ * @return The XADataSource
*/
public synchronized XADataSource getXaDataSourceInstance() {
return xaDataSourceInstance;
diff --git
a/src/main/java/org/apache/commons/dbcp2/managed/DataSourceXAConnectionFactory.java
b/src/main/java/org/apache/commons/dbcp2/managed/DataSourceXAConnectionFactory.java
index cc8731a9..ffe03db7 100644
---
a/src/main/java/org/apache/commons/dbcp2/managed/DataSourceXAConnectionFactory.java
+++
b/src/main/java/org/apache/commons/dbcp2/managed/DataSourceXAConnectionFactory.java
@@ -204,7 +204,7 @@ public class DataSourceXAConnectionFactory implements
XAConnectionFactory {
/**
* Gets the user name used to authenticate new connections.
*
- * @return the user name or null if unauthenticated connections are used
+ * @return The user name or null if unauthenticated connections are used
* @deprecated Use {@link #getUserName()}.
*/
@Deprecated
@@ -215,7 +215,7 @@ public class DataSourceXAConnectionFactory implements
XAConnectionFactory {
/**
* Gets the user name used to authenticate new connections.
*
- * @return the user name or null if unauthenticated connections are used
+ * @return The user name or null if unauthenticated connections are used
* @since 2.6.0
*/
public String getUserName() {
@@ -225,7 +225,7 @@ public class DataSourceXAConnectionFactory implements
XAConnectionFactory {
/**
* Gets the user password.
*
- * @return the user password.
+ * @return The user password.
*/
public char[] getUserPassword() {
return Utils.clone(userPassword);
@@ -234,7 +234,7 @@ public class DataSourceXAConnectionFactory implements
XAConnectionFactory {
/**
* Gets the XA data source.
*
- * @return the XA data source.
+ * @return The XA data source.
*/
public XADataSource getXaDataSource() {
return xaDataSource;
diff --git
a/src/main/java/org/apache/commons/dbcp2/managed/LocalXAConnectionFactory.java
b/src/main/java/org/apache/commons/dbcp2/managed/LocalXAConnectionFactory.java
index d4bbd802..25bc0d80 100644
---
a/src/main/java/org/apache/commons/dbcp2/managed/LocalXAConnectionFactory.java
+++
b/src/main/java/org/apache/commons/dbcp2/managed/LocalXAConnectionFactory.java
@@ -161,7 +161,7 @@ public class LocalXAConnectionFactory implements
XAConnectionFactory {
/**
* Gets the current xid of the transaction branch associated with this
XAResource.
*
- * @return the current xid of the transaction branch associated with
this XAResource.
+ * @return The current xid of the transaction branch associated with
this XAResource.
*/
public synchronized Xid getXid() {
return currentXid;
diff --git
a/src/main/java/org/apache/commons/dbcp2/managed/TransactionContext.java
b/src/main/java/org/apache/commons/dbcp2/managed/TransactionContext.java
index 76487b6f..68954427 100644
--- a/src/main/java/org/apache/commons/dbcp2/managed/TransactionContext.java
+++ b/src/main/java/org/apache/commons/dbcp2/managed/TransactionContext.java
@@ -123,7 +123,7 @@ public class TransactionContext {
* Gets the connection shared by all ManagedConnections in the
transaction. Specifically, connection using the same
* XAConnectionFactory from which the TransactionRegistry was obtained.
*
- * @return the shared connection for this transaction
+ * @return The shared connection for this transaction
*/
public Connection getSharedConnection() {
return sharedConnection;
diff --git
a/src/main/java/org/apache/commons/dbcp2/managed/XAConnectionFactory.java
b/src/main/java/org/apache/commons/dbcp2/managed/XAConnectionFactory.java
index 64206eb3..3628a93c 100644
--- a/src/main/java/org/apache/commons/dbcp2/managed/XAConnectionFactory.java
+++ b/src/main/java/org/apache/commons/dbcp2/managed/XAConnectionFactory.java
@@ -48,7 +48,7 @@ public interface XAConnectionFactory extends
ConnectionFactory {
* Gets the TransactionRegistry for this connection factory which contains
the XAResource for every connection
* created by this factory.
*
- * @return the transaction registry for this connection factory
+ * @return The transaction registry for this connection factory
*/
TransactionRegistry getTransactionRegistry();
}
diff --git a/src/test/java/org/apache/commons/dbcp2/StackMessageLog.java
b/src/test/java/org/apache/commons/dbcp2/StackMessageLog.java
index bb8d44f5..df25d275 100644
--- a/src/test/java/org/apache/commons/dbcp2/StackMessageLog.java
+++ b/src/test/java/org/apache/commons/dbcp2/StackMessageLog.java
@@ -71,7 +71,7 @@ public class StackMessageLog extends SimpleLog {
}
/**
- * @return the most recent log message, or null if the log is empty
+ * @return The most recent log message, or null if the log is empty
*/
public static String popMessage() {
LOCK.lock();
diff --git a/src/test/java/org/apache/commons/dbcp2/TestJndi.java
b/src/test/java/org/apache/commons/dbcp2/TestJndi.java
index 8579019f..39ab2c9c 100644
--- a/src/test/java/org/apache/commons/dbcp2/TestJndi.java
+++ b/src/test/java/org/apache/commons/dbcp2/TestJndi.java
@@ -75,7 +75,7 @@ public class TestJndi {
/**
* Gets (or creates if it does not exist) an InitialContext.
*
- * @return the InitialContext.
+ * @return The InitialContext.
* @throws NamingException if the InitialContext cannot be retrieved
* or created.
*/
