Javadoc

Author: garydgregory

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

@@ -697,7 +697,7 @@ public boolean getAutoCommitOnReturn() {
     /**
      * Gets the state caching flag.
      *
-     * @return the state caching flag
+     * @return The state caching flag
      */
     @Override
     public boolean getCacheState() {
@@ -749,7 +749,7 @@ public Connection getConnection(final String user, final String pass) throws SQL
      * 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 String[] getConnectionInitSqlsAsArray() {
     /**
      * 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 Boolean getDefaultAutoCommit() {
     /**
      * Gets the default catalog.
      *
-     * @return the default catalog
+     * @return The default catalog
      */
     @Override
     public String getDefaultCatalog() {
@@ -845,7 +845,7 @@ public Boolean getDefaultReadOnly() {
     /**
      * Gets the default schema.
      *
-     * @return the default schema.
+     * @return The default schema.
      * @since 2.5.0
      */
     @Override
@@ -856,7 +856,7 @@ public String getDefaultSchema() {
     /**
      * 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 String[] getDisconnectionSqlCodesAsArray() {
      * 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 synchronized ClassLoader getDriverClassLoader() {
      * 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 synchronized String getDriverClassName() {
     /**
      * 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 boolean getFastFailValidation() {
     /**
      * 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 PrintWriter getLogWriter() throws SQLException {
      * 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 long getMaxConnLifetimeMillis() {
      * 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 synchronized int getMaxIdle() {
     /**
      * 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 synchronized int getMaxOpenPreparedStatements() {
      * 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 synchronized int getMaxTotal() {
      * 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 synchronized Duration getMaxWaitDuration() {
      * 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 synchronized long getMaxWaitMillis() {
     /**
      * 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 synchronized Duration getMinEvictableIdleDuration() {
     /**
      * 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 synchronized long getMinEvictableIdleTimeMillis() {
      * 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 synchronized int getMinIdle() {
     /**
      * [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 int getNumActive() {
     /**
      * [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 int getNumIdle() {
     /**
      * 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 Logger getParentLogger() throws SQLFeatureNotSupportedException {
     /**
      * 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 String getPassword() {
     /**
      * 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 synchronized boolean getTestWhileIdle() {
     /**
      * 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 synchronized long getTimeBetweenEvictionRunsMillis() {
     /**
      * 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 synchronized String getUrl() {
     /**
      * 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 String getUsername() {
     /**
      * 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 String getValidationQuery() {
     /**
      * 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 int getValidationQueryTimeout() {
     /**
      * 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;

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

@@ -337,7 +337,7 @@ public boolean getAutoCommit() throws SQLException {
      * <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 C getDelegate() {
     /**
      * Gets the delegate connection.
      *
-     * @return the delegate connection.
+     * @return The delegate connection.
      */
     protected final C getDelegateInternal() {
         return connection;
@@ -553,7 +553,7 @@ protected void handleException(final SQLException e) throws SQLException {
      *
      * @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 boolean isClosed() throws SQLException {
     /**
      * Tests the raw internal closed state.
      *
-     * @return the raw internal closed state.
+     * @return The raw internal closed state.
      */
     protected boolean isClosedInternal() {
         return closed;

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

@@ -273,7 +273,7 @@ public ResultSet getIndexInfo(final String catalog, final String schema, final S
      * 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;

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

@@ -602,7 +602,7 @@ public int getHoldability() throws SQLException {
      * a "genuine" {@link ResultSet}.
      * </p>
      *
-     * @return the innermost delegate.
+     * @return The innermost delegate.
      */
     @SuppressWarnings("resource")
     public ResultSet getInnermostDelegate() {

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

@@ -400,7 +400,7 @@ public Connection getConnection() throws SQLException {
     /**
      * Gets the internal connection.
      *
-     * @return the internal connection.
+     * @return The internal connection.
      */
     protected DelegatingConnection<?> getConnectionInternal() {
         return connection;

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

@@ -50,7 +50,7 @@ public ListException(final String message, final List<Throwable> exceptionList)
     /**
      * Gets the list of exceptions.
      *
-     * @return the list of exceptions.
+     * @return The list of exceptions.
      */
     public List<Throwable> getExceptionList() {
         return exceptionList;

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

@@ -596,7 +596,7 @@ public Integer getResultSetHoldability() {
      * 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 String getSchema() {
     /**
      * Gets the SQL statement.
      *
-     * @return the SQL statement.
+     * @return The SQL statement.
      */
     public String getSql() {
         return sql;

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

@@ -174,7 +174,7 @@ public ConnectionFactory getConnectionFactory() {
     /**
      * 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 @@ protected int getMaxOpenPreparedStatements() {
     /**
      * 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;

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();