Javadoc

Author: garydgregory

src/main/java/org/apache/commons/dbcp2/BasicDataSource.java

@@ -103,7 +103,7 @@ public class BasicDataSource implements DataSource, BasicDataSourceMXBean, MBean
     /**
      * Validates the given factory.
      *
-     * @param connectionFactory the factory
+     * @param connectionFactory The factory
      * @throws SQLException Thrown by one of the factory methods while managing a temporary pooled object.
      */
     @SuppressWarnings("resource")
@@ -589,9 +589,9 @@ protected DataSource createDataSourceInstance() throws SQLException {
     /**
      * Creates an object pool used to provide pooling support for {@link Connection JDBC connections}.
      *
-     * @param factory         the object factory
-     * @param poolConfig      the object pool configuration
-     * @param abandonedConfig the abandoned objects configuration
+     * @param factory         The object factory
+     * @param poolConfig      The object pool configuration
+     * @param abandonedConfig The abandoned objects configuration
      * @return A non-null instance
      */
     protected GenericObjectPool<PoolableConnection> createObjectPool(final PoolableConnectionFactory factory,
@@ -1596,7 +1596,7 @@ public synchronized boolean isClosed() {
     /**
      * Delegates in a null-safe manner to {@link String#isEmpty()}.
      *
-     * @param value the string to test, may be null.
+     * @param value The string to test, may be null.
      * @return boolean false if value is null, otherwise {@link String#isEmpty()}.
      */
     private boolean isEmpty(final String value) {
@@ -1640,7 +1640,7 @@ private void jmxRegister() {
     /**
      * Logs the given message.
      *
-     * @param message the message to log.
+     * @param message The message to log.
      */
     protected void log(final String message) {
         if (logWriter != null) {
@@ -1652,7 +1652,7 @@ protected void log(final String message) {
      * Logs the given message and throwable.
      *
      * @param message value to be log.
-     * @param throwable the throwable.
+     * @param throwable The throwable.
      * @since 2.7.0
      */
     protected void log(final String message, final Throwable throwable) {
@@ -1869,7 +1869,7 @@ private <T> void setConnectionPool(final BiConsumer<GenericObjectPool<PoolableCo
      * NOTE - The "user" and "password" properties will be added explicitly, so they do not need to be included here.
      * </p>
      *
-     * @param connectionProperties the connection properties used to create new connections
+     * @param connectionProperties The connection properties used to create new connections
      */
     public void setConnectionProperties(final String connectionProperties) {
         Objects.requireNonNull(connectionProperties, "connectionProperties");
@@ -1912,7 +1912,7 @@ public void setDefaultAutoCommit(final Boolean defaultAutoCommit) {
      * {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
      * </p>
      *
-     * @param defaultCatalog the default catalog
+     * @param defaultCatalog The default catalog
      */
     public void setDefaultCatalog(final String defaultCatalog) {
         this.defaultCatalog = isEmpty(defaultCatalog) ? null : defaultCatalog;
@@ -1963,7 +1963,7 @@ public void setDefaultReadOnly(final Boolean defaultReadOnly) {
      * {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
      * </p>
      *
-     * @param defaultSchema the default catalog
+     * @param defaultSchema The default catalog
      * @since 2.5.0
      */
     public void setDefaultSchema(final String defaultSchema) {
@@ -1978,7 +1978,7 @@ public void setDefaultSchema(final String defaultSchema) {
      * {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
      * </p>
      *
-     * @param defaultTransactionIsolation the default transaction isolation state
+     * @param defaultTransactionIsolation The default transaction isolation state
      * @see Connection#getTransactionIsolation
      */
     public void setDefaultTransactionIsolation(final int defaultTransactionIsolation) {
@@ -2066,7 +2066,7 @@ public synchronized void setDriver(final Driver driver) {
      * {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
      * </p>
      *
-     * @param driverClassLoader the class loader with which to load the JDBC driver
+     * @param driverClassLoader The class loader with which to load the JDBC driver
      */
     public synchronized void setDriverClassLoader(final ClassLoader driverClassLoader) {
         this.driverClassLoader = driverClassLoader;
@@ -2080,7 +2080,7 @@ public synchronized void setDriverClassLoader(final ClassLoader driverClassLoade
      * {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
      * </p>
      *
-     * @param driverClassName the class name of the JDBC driver
+     * @param driverClassName The class name of the JDBC driver
      */
     public synchronized void setDriverClassName(final String driverClassName) {
         this.driverClassName = isEmpty(driverClassName) ? null : driverClassName;
@@ -2089,7 +2089,7 @@ public synchronized void setDriverClassName(final String driverClassName) {
     /**
      * Sets the {code durationBetweenEvictionRuns} property.
      *
-     * @param timeBetweenEvictionRunsMillis the new time between evictor runs
+     * @param timeBetweenEvictionRunsMillis The new time between evictor runs
      * @see #setDurationBetweenEvictionRuns(Duration)
      * @since 2.10.0
      */
@@ -2141,7 +2141,7 @@ public void setFastFailValidation(final boolean fastFailValidation) {
      * {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
      * </p>
      *
-     * @param initialSize the number of connections created when the pool is initialized
+     * @param initialSize The number of connections created when the pool is initialized
      */
     public synchronized void setInitialSize(final int initialSize) {
         this.initialSize = initialSize;
@@ -2162,7 +2162,7 @@ public void setJmxName(final String jmxName) {
     /**
      * Sets the LIFO property. True means the pool behaves as a LIFO queue; false means FIFO.
      *
-     * @param lifo the new value for the LIFO property
+     * @param lifo The new value for the LIFO property
      */
     public synchronized void setLifo(final boolean lifo) {
         this.lifo = lifo;
@@ -2265,7 +2265,7 @@ public void setMaxConnLifetimeMillis(final long maxConnLifetimeMillis) {
      * return to the pool.
      *
      * @see #getMaxIdle()
-     * @param maxIdle the new value for maxIdle
+     * @param maxIdle The new value for maxIdle
      */
     public synchronized void setMaxIdle(final int maxIdle) {
         this.maxIdle = maxIdle;
@@ -2280,7 +2280,7 @@ public synchronized void setMaxIdle(final int maxIdle) {
      * {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
      * </p>
      *
-     * @param maxOpenStatements the new maximum number of prepared statements
+     * @param maxOpenStatements The new maximum number of prepared statements
      */
     public synchronized void setMaxOpenPreparedStatements(final int maxOpenStatements) {
         this.maxOpenPreparedStatements = maxOpenStatements;
@@ -2290,7 +2290,7 @@ public synchronized void setMaxOpenPreparedStatements(final int maxOpenStatement
      * Sets the maximum total number of idle and borrows connections that can be active at the same time. Use a negative
      * value for no limit.
      *
-     * @param maxTotal the new value for maxTotal
+     * @param maxTotal The new value for maxTotal
      * @see #getMaxTotal()
      */
     public synchronized void setMaxTotal(final int maxTotal) {
@@ -2301,7 +2301,7 @@ public synchronized void setMaxTotal(final int maxTotal) {
     /**
      * Sets the MaxWaitMillis property. Use -1 to make the pool wait indefinitely.
      *
-     * @param maxWaitDuration the new value for MaxWaitMillis
+     * @param maxWaitDuration The new value for MaxWaitMillis
      * @see #getMaxWaitDuration()
      * @since 2.10.0
      */
@@ -2313,7 +2313,7 @@ public synchronized void setMaxWait(final Duration maxWaitDuration) {
     /**
      * Sets the MaxWaitMillis property. Use -1 to make the pool wait indefinitely.
      *
-     * @param maxWaitMillis the new value for MaxWaitMillis
+     * @param maxWaitMillis The new value for MaxWaitMillis
      * @see #getMaxWaitDuration()
      * @deprecated {@link #setMaxWait(Duration)}.
      */
@@ -2325,7 +2325,7 @@ public synchronized void setMaxWaitMillis(final long maxWaitMillis) {
     /**
      * Sets the {code minEvictableIdleDuration} property.
      *
-     * @param minEvictableIdleDuration the minimum amount of time an object may sit idle in the pool
+     * @param minEvictableIdleDuration The minimum amount of time an object may sit idle in the pool
      * @see #setMinEvictableIdle(Duration)
      * @since 2.10.0
      */
@@ -2337,7 +2337,7 @@ public synchronized void setMinEvictableIdle(final Duration minEvictableIdleDura
     /**
      * Sets the {code minEvictableIdleDuration} property.
      *
-     * @param minEvictableIdleTimeMillis the minimum amount of time an object may sit idle in the pool
+     * @param minEvictableIdleTimeMillis The minimum amount of time an object may sit idle in the pool
      * @see #setMinEvictableIdle(Duration)
      * @deprecated Use {@link #setMinEvictableIdle(Duration)}.
      */
@@ -2351,7 +2351,7 @@ public synchronized void setMinEvictableIdleTimeMillis(final long minEvictableId
      * available when the idle object evictor runs. The value of this property has no effect unless
      * {code durationBetweenEvictionRuns} has a positive value.
      *
-     * @param minIdle the new value for minIdle
+     * @param minIdle The new value for minIdle
      * @see GenericObjectPool#setMinIdle(int)
      */
     public synchronized void setMinIdle(final int minIdle) {
@@ -2362,7 +2362,7 @@ public synchronized void setMinIdle(final int minIdle) {
     /**
      * Sets the value of the {code numTestsPerEvictionRun} property.
      *
-     * @param numTestsPerEvictionRun the new {code numTestsPerEvictionRun} value
+     * @param numTestsPerEvictionRun The new {code numTestsPerEvictionRun} value
      * @see #setNumTestsPerEvictionRun(int)
      */
     public synchronized void setNumTestsPerEvictionRun(final int numTestsPerEvictionRun) {
@@ -2550,7 +2550,7 @@ public synchronized void setTestWhileIdle(final boolean testWhileIdle) {
     /**
      * Sets the {code durationBetweenEvictionRuns} property.
      *
-     * @param timeBetweenEvictionRunsMillis the new time between evictor runs
+     * @param timeBetweenEvictionRunsMillis The new time between evictor runs
      * @see #setDurationBetweenEvictionRuns(Duration)
      * @deprecated Use {@link #setDurationBetweenEvictionRuns(Duration)}.
      */
@@ -2567,7 +2567,7 @@ public synchronized void setTimeBetweenEvictionRunsMillis(final long timeBetween
      * {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
      * </p>
      *
-     * @param connectionString the new value for the JDBC connection connectionString
+     * @param connectionString The new value for the JDBC connection connectionString
      */
     public synchronized void setUrl(final String connectionString) {
         this.connectionString = connectionString;
@@ -2581,7 +2581,7 @@ public synchronized void setUrl(final String connectionString) {
      * {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
      * </p>
      *
-     * @param userName the new value for the JDBC connection user name
+     * @param userName The new value for the JDBC connection user name
      */
     public void setUsername(final String userName) {
         this.userName = userName;
@@ -2595,7 +2595,7 @@ public void setUsername(final String userName) {
      * {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
      * </p>
      *
-     * @param validationQuery the new value for the validation query
+     * @param validationQuery The new value for the validation query
      */
     public void setValidationQuery(final String validationQuery) {
         this.validationQuery = isEmpty(validationQuery) ? null : validationQuery;

src/main/java/org/apache/commons/dbcp2/DelegatingConnection.java

@@ -79,7 +79,7 @@ public class DelegatingConnection<C extends Connection> extends AbandonedTrace i
     /**
      * Creates a wrapper for the Connection which traces this Connection in the AbandonedObjectPool.
      *
-     * @param connection the {@link Connection} to delegate all calls to, may be null (see {@link ManagedConnection}).
+     * @param connection The {@link Connection} to delegate all calls to, may be null (see {@link ManagedConnection}).
      */
     public DelegatingConnection(final C connection) {
         this.connection = connection;
@@ -541,7 +541,7 @@ public SQLWarning getWarnings() throws SQLException {
     /**
      * Handles the given exception by throwing it.
      *
-     * @param e the exception to throw.
+     * @param e The exception to throw.
      * @throws SQLException the exception to throw.
      */
     protected void handleException(final SQLException e) throws SQLException {
@@ -906,7 +906,7 @@ public void setClientInfo(final String name, final String value) throws SQLClien
     /**
      * Sets the raw internal closed state.
      *
-     * @param closed the raw internal closed state.
+     * @param closed The raw internal closed state.
      */
     protected void setClosedInternal(final boolean closed) {
         this.closed = closed;

src/main/java/org/apache/commons/dbcp2/DelegatingDatabaseMetaData.java

@@ -46,8 +46,8 @@ public class DelegatingDatabaseMetaData implements DatabaseMetaData {
     /**
      * Constructs a new instance for the given delegating connection and database meta data.
      *
-     * @param connection       the delegating connection
-     * @param databaseMetaData the database meta data
+     * @param connection       The delegating connection
+     * @param databaseMetaData The database meta data
      */
     public DelegatingDatabaseMetaData(final DelegatingConnection<?> connection, final DatabaseMetaData databaseMetaData) {
         this.connection = Objects.requireNonNull(connection, "connection");
@@ -554,7 +554,7 @@ public ResultSet getVersionColumns(final String catalog, final String schema, fi
     /**
      * Delegates to the connection's {@link DelegatingConnection#handleException(SQLException)}.
      *
-     * @param e the exception to throw or delegate.
+     * @param e The exception to throw or delegate.
      * @throws SQLException the exception to throw.
      */
     protected void handleException(final SQLException e) throws SQLException {

src/main/java/org/apache/commons/dbcp2/LifetimeExceededException.java

@@ -36,7 +36,7 @@ final class LifetimeExceededException extends SQLException {
     /**
      * Constructs a new instance with the given message.
      *
-     * @param reason a description of the exception
+     * @param reason A description of the exception
      */
     LifetimeExceededException(final String reason) {
         super(reason);

src/main/java/org/apache/commons/dbcp2/PStmtKey.java

@@ -195,7 +195,7 @@ public PStmtKey(final String sql, final String catalog, final int resultSetType,
      *
      * @param sql The SQL statement.
      * @param catalog The catalog.
-     * @param resultSetType a result set type; one of {@link ResultSet#TYPE_FORWARD_ONLY},
+     * @param resultSetType A result set type; one of {@link ResultSet#TYPE_FORWARD_ONLY},
      *        {@link ResultSet#TYPE_SCROLL_INSENSITIVE}, or {@link ResultSet#TYPE_SCROLL_SENSITIVE}.
      * @param resultSetConcurrency A concurrency type; one of {@link ResultSet#CONCUR_READ_ONLY} or
      *        {@link ResultSet#CONCUR_UPDATABLE}
@@ -213,7 +213,7 @@ public PStmtKey(final String sql, final String catalog, final int resultSetType,
      *
      * @param sql The SQL statement.
      * @param catalog The catalog.
-     * @param resultSetType a result set type; one of {@link ResultSet#TYPE_FORWARD_ONLY},
+     * @param resultSetType A result set type; one of {@link ResultSet#TYPE_FORWARD_ONLY},
      *        {@link ResultSet#TYPE_SCROLL_INSENSITIVE}, or {@link ResultSet#TYPE_SCROLL_SENSITIVE}
      * @param resultSetConcurrency A concurrency type; one of {@link ResultSet#CONCUR_READ_ONLY} or
      *        {@link ResultSet#CONCUR_UPDATABLE}.
@@ -337,7 +337,7 @@ public PStmtKey(final String sql, final String catalog, final String schema, fin
      * @param sql The SQL statement.
      * @param catalog The catalog.
      * @param schema The schema
-     * @param resultSetType a result set type; one of {@link ResultSet#TYPE_FORWARD_ONLY},
+     * @param resultSetType A result set type; one of {@link ResultSet#TYPE_FORWARD_ONLY},
      *        {@link ResultSet#TYPE_SCROLL_INSENSITIVE}, or {@link ResultSet#TYPE_SCROLL_SENSITIVE}.
      * @param resultSetConcurrency A concurrency type; one of {@link ResultSet#CONCUR_READ_ONLY} or
      *        {@link ResultSet#CONCUR_UPDATABLE}
@@ -356,7 +356,7 @@ public PStmtKey(final String sql, final String catalog, final String schema, fin
      * @param sql The SQL statement.
      * @param catalog The catalog.
      * @param schema The schema.
-     * @param resultSetType a result set type; one of {@link ResultSet#TYPE_FORWARD_ONLY},
+     * @param resultSetType A result set type; one of {@link ResultSet#TYPE_FORWARD_ONLY},
      *        {@link ResultSet#TYPE_SCROLL_INSENSITIVE}, or {@link ResultSet#TYPE_SCROLL_SENSITIVE}
      * @param resultSetConcurrency A concurrency type; one of {@link ResultSet#CONCUR_READ_ONLY} or
      *        {@link ResultSet#CONCUR_UPDATABLE}.

src/main/java/org/apache/commons/dbcp2/PoolableConnectionFactory.java

@@ -411,7 +411,7 @@ public int getValidationQueryTimeoutSeconds() {
     /**
      * Initializes the given connection with the collection of SQL statements set in {@link #setConnectionInitSql(Collection)}.
      *
-     * @param conn the connection to initialize.
+     * @param conn The connection to initialize.
      * @throws SQLException if a database access error occurs or this method is called on a closed connection.
      * @see #setConnectionInitSql(Collection)
      */
@@ -576,7 +576,7 @@ public void setAutoCommitOnReturn(final boolean autoCommitOnReturn) {
     /**
      * Sets the cache state to propagate in {@link #makeObject()}.
      *
-     * @param cacheState the cache state to propagate.
+     * @param cacheState The cache state to propagate.
      */
     public void setCacheState(final boolean cacheState) {
         this.cacheState = cacheState;
@@ -627,7 +627,7 @@ public void setDefaultCatalog(final String defaultCatalog) {
     /**
      * Sets the query timeout Duration.
      *
-     * @param defaultQueryTimeoutDuration the query timeout Duration.
+     * @param defaultQueryTimeoutDuration The query timeout Duration.
      * @since 2.10.0
      */
     public void setDefaultQueryTimeout(final Duration defaultQueryTimeoutDuration) {
@@ -637,7 +637,7 @@ public void setDefaultQueryTimeout(final Duration defaultQueryTimeoutDuration) {
     /**
      * Sets the query timeout in seconds.
      *
-     * @param defaultQueryTimeoutSeconds the query timeout in seconds.
+     * @param defaultQueryTimeoutSeconds The query timeout in seconds.
      * @deprecated Use {@link #setDefaultQueryTimeout(Duration)}.
      */
     @Deprecated
@@ -841,7 +841,7 @@ public void setValidationQueryTimeout(final int validationQueryTimeoutSeconds) {
     /**
      * Validates the given connection if it is open.
      *
-     * @param conn the connection to validate.
+     * @param conn The connection to validate.
      * @throws SQLException if the connection is closed or validate fails.
      */
     public void validateConnection(final PoolableConnection conn) throws SQLException {

src/main/java/org/apache/commons/dbcp2/SQLExceptionList.java

@@ -40,7 +40,7 @@ public class SQLExceptionList extends SQLException {
     /**
      * Creates a new exception caused by a list of exceptions.
      *
-     * @param causeList a list of cause exceptions.
+     * @param causeList A list of cause exceptions.
      */
     public SQLExceptionList(final List<? extends Throwable> causeList) {
         super(String.format("%,d exceptions: %s", causeList == null ? 0 : causeList.size(), causeList),