Javadoc

Author: garydgregory

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

@@ -592,7 +592,7 @@ protected DataSource createDataSourceInstance() throws SQLException {
      * @param factory         the object factory
      * @param poolConfig      the object pool configuration
      * @param abandonedConfig the abandoned objects configuration
-     * @return a non-null instance
+     * @return A non-null instance
      */
     protected GenericObjectPool<PoolableConnection> createObjectPool(final PoolableConnectionFactory factory,
             final GenericObjectPoolConfig<PoolableConnection> poolConfig, final AbandonedConfig abandonedConfig) {
@@ -708,7 +708,7 @@ public boolean getCacheState() {
      * Creates (if necessary) and return a connection to the database.
      *
      * @throws SQLException if a database access error occurs
-     * @return a database connection
+     * @return A database connection
      */
     @Override
     public Connection getConnection() throws SQLException {
@@ -872,7 +872,7 @@ public int getDefaultTransactionIsolation() {
      * trigger a disconnection even if they match other disconnection criteria.
      * </p>
      *
-     * @return a set of SQL State codes that should be ignored for disconnection checks, or an empty set if none have been specified.
+     * @return A set of SQL State codes that should be ignored for disconnection checks, or an empty set if none have been specified.
      * @since 2.13.0
      */
     public Set<String> getDisconnectionIgnoreSqlCodes() {

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

@@ -29,7 +29,7 @@ public interface ConnectionFactory {
     /**
      * Create a new {@link Connection} in an implementation specific fashion.
      *
-     * @return a new {@link Connection}
+     * @return A new {@link Connection}
      * @throws SQLException
      *             if a database error occurs creating the connection
      */

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

@@ -33,7 +33,7 @@ final class ConnectionFactoryFactory {
      *
      * @param basicDataSource Configures creation.
      * @param driver          The JDBC driver.
-     * @return a new {@link DriverConnectionFactory} allowing for a {@link BasicDataSource#getDriverClassName()}
+     * @return A new {@link DriverConnectionFactory} allowing for a {@link BasicDataSource#getDriverClassName()}
      *         override.
      * @throws SQLException Thrown when instantiation fails.
      */

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

@@ -61,7 +61,7 @@ public final class DelegatingResultSet extends AbandonedTrace implements ResultS
      *            The Connection which created the ResultSet.
      * @param resultSet
      *            The ResultSet to wrap.
-     * @return a new delegate.
+     * @return A new delegate.
      */
     public static ResultSet wrapResultSet(final Connection connection, final ResultSet resultSet) {
         if (resultSet == null) {
@@ -77,7 +77,7 @@ public static ResultSet wrapResultSet(final Connection connection, final ResultS
      *            The Statement which created the ResultSet.
      * @param resultSet
      *            The ResultSet to wrap.
-     * @return a new delegate.
+     * @return A new delegate.
      */
     public static ResultSet wrapResultSet(final Statement statement, final ResultSet resultSet) {
         if (resultSet == null) {

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

@@ -539,7 +539,7 @@ public boolean equals(final Object obj) {
      * Gets a flag indicating whether auto-generated keys should be returned; one of {@link Statement#RETURN_GENERATED_KEYS}
      * or {@link Statement#NO_GENERATED_KEYS}.
      *
-     * @return a flag indicating whether auto-generated keys should be returned.
+     * @return A flag indicating whether auto-generated keys should be returned.
      */
     public Integer getAutoGeneratedKeys() {
         return autoGeneratedKeys;

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

@@ -301,7 +301,7 @@ public int getDefaultTransactionIsolation() {
      * being treated as fatal even if they match the typical disconnection criteria.
      * </p>
      *
-     * @return a {@link Collection} of SQL State codes that should be ignored for disconnection checks.
+     * @return A {@link Collection} of SQL State codes that should be ignored for disconnection checks.
      * @since 2.13.0
      */
     public Collection<String> getDisconnectionIgnoreSqlCodes() {

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

@@ -407,7 +407,7 @@ public void passivateObject(final PStmtKey key, final PooledObject<DelegatingPre
      *
      * @param key
      *            a {@link PStmtKey} for the given arguments
-     * @return a {@link PoolableCallableStatement}
+     * @return A {@link PoolableCallableStatement}
      * @throws SQLException
      *             Wraps an underlying exception.
      */
@@ -420,7 +420,7 @@ private CallableStatement prepareCall(final PStmtKey key) throws SQLException {
      *
      * @param sql
      *            the SQL string used to define the CallableStatement
-     * @return a {@link PoolableCallableStatement}
+     * @return A {@link PoolableCallableStatement}
      * @throws SQLException
      *             Wraps an underlying exception.
      */
@@ -438,7 +438,7 @@ public CallableStatement prepareCall(final String sql) throws SQLException {
      *            result set type
      * @param resultSetConcurrency
      *            result set concurrency
-     * @return a {@link PoolableCallableStatement}
+     * @return A {@link PoolableCallableStatement}
      * @throws SQLException
      *             Wraps an underlying exception.
      */
@@ -459,7 +459,7 @@ public CallableStatement prepareCall(final String sql, final int resultSetType,
      *            result set concurrency
      * @param resultSetHoldability
      *            result set holdability
-     * @return a {@link PoolableCallableStatement}
+     * @return A {@link PoolableCallableStatement}
      * @throws SQLException
      *             Wraps an underlying exception.
      */
@@ -475,7 +475,7 @@ public CallableStatement prepareCall(final String sql, final int resultSetType,
      *
      * @param key
      *            a {@link PStmtKey} for the given arguments
-     * @return a {@link PoolablePreparedStatement}
+     * @return A {@link PoolablePreparedStatement}
      * @throws SQLException
      *             Wraps an underlying exception.
      */
@@ -499,7 +499,7 @@ private PreparedStatement prepareStatement(final PStmtKey key) throws SQLExcepti
      *
      * @param sql
      *            the SQL string used to define the PreparedStatement
-     * @return a {@link PoolablePreparedStatement}
+     * @return A {@link PoolablePreparedStatement}
      * @throws SQLException
      *             Wraps an underlying exception.
      */
@@ -516,7 +516,7 @@ public PreparedStatement prepareStatement(final String sql) throws SQLException
      * @param autoGeneratedKeys
      *            A flag indicating whether auto-generated keys should be returned; one of
      *            {@link Statement#RETURN_GENERATED_KEYS} or {@link Statement#NO_GENERATED_KEYS}.
-     * @return a {@link PoolablePreparedStatement}
+     * @return A {@link PoolablePreparedStatement}
      * @throws SQLException
      *             Wraps an underlying exception.
      */
@@ -534,7 +534,7 @@ public PreparedStatement prepareStatement(final String sql, final int autoGenera
      *            result set type
      * @param resultSetConcurrency
      *            result set concurrency
-     * @return a {@link PoolablePreparedStatement}
+     * @return A {@link PoolablePreparedStatement}
      * @throws SQLException
      *             Wraps an underlying exception.
      */
@@ -555,7 +555,7 @@ public PreparedStatement prepareStatement(final String sql, final int resultSetT
      *            result set concurrency
      * @param resultSetHoldability
      *            result set holdability
-     * @return a {@link PoolablePreparedStatement}
+     * @return A {@link PoolablePreparedStatement}
      * @throws SQLException
      *             Wraps an underlying exception.
      */
@@ -573,7 +573,7 @@ public PreparedStatement prepareStatement(final String sql, final int resultSetT
      * @param columnIndexes
      *            An array of column indexes indicating the columns that should be returned from the inserted row or
      *            rows.
-     * @return a {@link PoolablePreparedStatement}
+     * @return A {@link PoolablePreparedStatement}
      * @throws SQLException
      *             Wraps an underlying exception.
      */
@@ -589,7 +589,7 @@ public PreparedStatement prepareStatement(final String sql, final int[] columnIn
      *            the SQL string used to define the PreparedStatement
      * @param columnNames
      *            column names
-     * @return a {@link PoolablePreparedStatement}
+     * @return A {@link PoolablePreparedStatement}
      * @throws SQLException
      *             Wraps an underlying exception.
      */

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

@@ -108,7 +108,7 @@ static void checkSqlCodes(final Collection<String> codes1, final Collection<Stri
      * Clones the given char[] if not null.
      *
      * @param value may be null.
-     * @return a cloned char[] or null.
+     * @return A cloned char[] or null.
      */
     public static char[] clone(final char[] value) {
         return value == null ? null : value.clone();
@@ -118,7 +118,7 @@ public static char[] clone(final char[] value) {
      * Clones the given {@link Properties} without the standard "user" or "password" entries.
      *
      * @param properties may be null
-     * @return a clone of the input without the standard "user" or "password" entries.
+     * @return A clone of the input without the standard "user" or "password" entries.
      * @since 2.8.0
      */
     public static Properties cloneWithoutCredentials(final Properties properties) {
@@ -260,7 +260,7 @@ static boolean isSecurityEnabled() {
      * Converts the given String to a char[].
      *
      * @param value may be null.
-     * @return a char[] or null.
+     * @return A char[] or null.
      */
     public static char[] toCharArray(final String value) {
         return value != null ? value.toCharArray() : null;
@@ -270,7 +270,7 @@ public static char[] toCharArray(final String value) {
      * Converts the given char[] to a String.
      *
      * @param value may be null.
-     * @return a String or null.
+     * @return A String or null.
      */
     public static String toString(final char[] value) {
         return value == null ? null : String.valueOf(value);

src/main/java/org/apache/commons/dbcp2/cpdsadapter/ConnectionImpl.java

@@ -138,7 +138,7 @@ public boolean isAccessToUnderlyingConnectionAllowed() {
      * @param sql
      *            an SQL statement that may contain one or more '?' parameter placeholders. Typically, this statement is
      *            specified using JDBC call escape syntax.
-     * @return a default {@link CallableStatement} object containing the pre-compiled SQL statement.
+     * @return A default {@link CallableStatement} object containing the pre-compiled SQL statement.
      * @throws SQLException
      *                Thrown if a database access error occurs or this method is called on a closed connection.
      * @since 2.4.0
@@ -167,7 +167,7 @@ public CallableStatement prepareCall(final String sql) throws SQLException {
      * @param resultSetConcurrency
      *            a concurrency type; one of {@link ResultSet#CONCUR_READ_ONLY} or
      *            {@link ResultSet#CONCUR_UPDATABLE}.
-     * @return a {@link CallableStatement} object containing the pre-compiled SQL statement that will produce
+     * @return A {@link CallableStatement} object containing the pre-compiled SQL statement that will produce
      *         {@link ResultSet} objects with the given type and concurrency.
      * @throws SQLException
      *             Thrown if a database access error occurs, this method is called on a closed connection or the given
@@ -203,7 +203,7 @@ public CallableStatement prepareCall(final String sql, final int resultSetType,
      * @param resultSetHoldability
      *            one of the following {@link ResultSet} constants: {@link ResultSet#HOLD_CURSORS_OVER_COMMIT}
      *            or {@link ResultSet#CLOSE_CURSORS_AT_COMMIT}.
-     * @return a new {@link CallableStatement} object, containing the pre-compiled SQL statement, that will
+     * @return A new {@link CallableStatement} object, containing the pre-compiled SQL statement, that will
      *         generate {@link ResultSet} objects with the given type, concurrency, and holdability.
      * @throws SQLException
      *             Thrown if a database access error occurs, this method is called on a closed connection or the given