Javadoc

Author: garydgregory

src/main/java/org/apache/commons/dbutils/AsyncQueryRunner.java

@@ -225,7 +225,7 @@ public Integer call() throws SQLException {
      * @param pmdKnownBroken Some drivers don't support {@link java.sql.ParameterMetaData#getParameterType(int)};
      * if {@code pmdKnownBroken} is set to true, we won't even try it; if false, we'll try it,
      * and if it breaks, we'll remember not to use it again.
-     * @param executorService the {@code ExecutorService} instance used to run JDBC invocations concurrently.
+     * @param executorService The {@code ExecutorService} instance used to run JDBC invocations concurrently.
      * @deprecated Use {@link #AsyncQueryRunner(ExecutorService, QueryRunner)} instead.
      * Constructor for AsyncQueryRunner that controls the use of {@code ParameterMetaData}.
      *
@@ -240,7 +240,7 @@ public AsyncQueryRunner(final boolean pmdKnownBroken, final ExecutorService exec
      * @param pmdKnownBroken Some drivers don't support {@link java.sql.ParameterMetaData#getParameterType(int)};
      * if {@code pmdKnownBroken} is set to true, we won't even try it; if false, we'll try it,
      * and if it breaks, we'll remember not to use it again.
-     * @param executorService the {@code ExecutorService} instance used to run JDBC invocations concurrently.
+     * @param executorService The {@code ExecutorService} instance used to run JDBC invocations concurrently.
      * @deprecated Use {@link #AsyncQueryRunner(ExecutorService, QueryRunner)} instead.
      * Constructor for AsyncQueryRunner that take a {@code DataSource} and controls the use of {@code ParameterMetaData}.
      * Methods that do not take a {@code Connection} parameter will retrieve connections from this
@@ -256,7 +256,7 @@ public AsyncQueryRunner(final DataSource ds, final boolean pmdKnownBroken, final
 
     /**
      * @param ds The {@code DataSource} to retrieve connections from.
-     * @param executorService the {@code ExecutorService} instance used to run JDBC invocations concurrently.
+     * @param executorService The {@code ExecutorService} instance used to run JDBC invocations concurrently.
      * @deprecated Use {@link #AsyncQueryRunner(ExecutorService, QueryRunner)} instead.
      * Constructor for AsyncQueryRunner that takes a {@code DataSource}.
      *
@@ -272,7 +272,7 @@ public AsyncQueryRunner(final DataSource ds, final ExecutorService executorServi
     /**
      * Constructor for AsyncQueryRunner.
      *
-     * @param executorService the {@code ExecutorService} instance used to run JDBC invocations concurrently.
+     * @param executorService The {@code ExecutorService} instance used to run JDBC invocations concurrently.
      */
     public AsyncQueryRunner(final ExecutorService executorService) {
         this(null, false, executorService);
@@ -281,8 +281,8 @@ public AsyncQueryRunner(final ExecutorService executorService) {
     /**
      * Constructor for AsyncQueryRunner which uses a provided ExecutorService and underlying QueryRunner.
      *
-     * @param executorService the {@code ExecutorService} instance used to run JDBC invocations concurrently.
-     * @param queryRunner the {@code QueryRunner} instance to use for the queries.
+     * @param executorService The {@code ExecutorService} instance used to run JDBC invocations concurrently.
+     * @param queryRunner The {@code QueryRunner} instance to use for the queries.
      * @since 1.5
      */
     public AsyncQueryRunner(final ExecutorService executorService, final QueryRunner queryRunner) {

src/main/java/org/apache/commons/dbutils/DbUtils.java

@@ -50,7 +50,7 @@ static final class DriverProxy implements Driver {
         /**
          * Creates a new JDBC Driver that adapts a JDBC Driver loaded dynamically.
          *
-         * @param adapted the adapted JDBC Driver loaded dynamically.
+         * @param adapted The adapted JDBC Driver loaded dynamically.
          */
         public DriverProxy(final Driver adapted) {
             this.adapted = adapted;
@@ -250,7 +250,7 @@ public static void commitAndCloseQuietly(final Connection conn) {
      * Loads and registers a database driver class.
      * If this succeeds, it returns true, else it returns false.
      *
-     * @param classLoader the class loader used to load the driver class
+     * @param classLoader The class loader used to load the driver class
      * @param driverClassName of driver to load
      * @return boolean {@code true} if the driver was found, otherwise {@code false}
      * @since 1.4

src/main/java/org/apache/commons/dbutils/OutParameter.java

@@ -42,9 +42,9 @@ public class OutParameter<T> {
      * Constructs an {@code OutParameter} for the given JDBC SQL type and
      * Java type.
      *
-     * @param sqlType the JDBC SQL type of the parameter as in
+     * @param sqlType The JDBC SQL type of the parameter as in
      * {@link java.sql.Types}.
-     * @param javaType the Java class of the parameter value, cast compatible
+     * @param javaType The Java class of the parameter value, cast compatible
      * with the type returned by {@code CallableStatement.getObject(int)}
      * for the JDBC type given by {@code sqlType}.
      */
@@ -58,12 +58,12 @@ public OutParameter(final int sqlType, final Class<T> javaType) {
      * Java type and with the given value.  The parameter will be treated as an
      * INOUT parameter if the value is null.
      *
-     * @param sqlType the JDBC SQL type of the parameter as in
+     * @param sqlType The JDBC SQL type of the parameter as in
      * {@link java.sql.Types}.
-     * @param javaType the Java class of the parameter value, cast compatible
+     * @param javaType The Java class of the parameter value, cast compatible
      * with the type returned by {@code CallableStatement.getObject(int)}
      * for the JDBC type given by {@code sqlType}.
-     * @param value the IN value of the parameter
+     * @param value The IN value of the parameter
      */
     public OutParameter(final int sqlType, final Class<T> javaType, final T value) {
         this.sqlType = sqlType;
@@ -105,8 +105,8 @@ public T getValue() {
      * {@code OutParameter}.  If the value is not null, the parameter is
      * treated like an INOUT parameter and the value is set on the statement.
      *
-     * @param stmt the statement the parameter should register on.
-     * @param index the (1-based) index of the parameter.
+     * @param stmt The statement the parameter should register on.
+     * @param index The (1-based) index of the parameter.
      * @throws SQLException if the parameter could not be registered, or if the
      * value of the parameter could not be set.
      */
@@ -121,8 +121,8 @@ void register(final CallableStatement stmt, final int index) throws SQLException
      * Set the value using the return value of the parameter an the given index
      * from the given {@code CallableStatement}.
      *
-     * @param stmt the already executed statement
-     * @param index the (1-based) index of the parameter
+     * @param stmt The already executed statement
+     * @param index The (1-based) index of the parameter
      * @throws SQLException when the value could not be retrieved from the
      * statement.
      */
@@ -135,7 +135,7 @@ void setValue(final CallableStatement stmt, final int index) throws SQLException
      * stored procedure is executed, then the parameter will be treated like an
      * INOUT parameter.
      *
-     * @param value the new value for the parameter.
+     * @param value The new value for the parameter.
      */
     public void setValue(final T value) {
         this.value = value;

src/main/java/org/apache/commons/dbutils/QueryRunner.java

@@ -721,8 +721,8 @@ public <T> T query(final String sql, final ResultSetHandler<T> rsh, final Object
      * {@code params} array using the OUT parameter values from the
      * {@code stmt}.
      *
-     * @param stmt the statement from which to retrieve OUT parameter values
-     * @param params the parameter array for the statement invocation
+     * @param stmt The statement from which to retrieve OUT parameter values
+     * @param params The parameter array for the statement invocation
      * @throws SQLException when the value could not be retrieved from the
      * statement.
      */

src/main/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java

@@ -402,7 +402,7 @@ public Object invoke(final Object proxy, final Method method, final Object[] arg
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getAsciiStream} method.
      *
-     * @param nullAsciiStream the value
+     * @param nullAsciiStream The value
      */
     public void setNullAsciiStream(final InputStream nullAsciiStream) {
         this.nullAsciiStream = nullAsciiStream;
@@ -412,7 +412,7 @@ public void setNullAsciiStream(final InputStream nullAsciiStream) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getBigDecimal} method.
      *
-     * @param nullBigDecimal the value
+     * @param nullBigDecimal The value
      */
     public void setNullBigDecimal(final BigDecimal nullBigDecimal) {
         this.nullBigDecimal = nullBigDecimal;
@@ -422,7 +422,7 @@ public void setNullBigDecimal(final BigDecimal nullBigDecimal) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getBinaryStream} method.
      *
-     * @param nullBinaryStream the value
+     * @param nullBinaryStream The value
      */
     public void setNullBinaryStream(final InputStream nullBinaryStream) {
         this.nullBinaryStream = nullBinaryStream;
@@ -432,7 +432,7 @@ public void setNullBinaryStream(final InputStream nullBinaryStream) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getBlob} method.
      *
-     * @param nullBlob the value
+     * @param nullBlob The value
      */
     public void setNullBlob(final Blob nullBlob) {
         this.nullBlob = nullBlob;
@@ -442,7 +442,7 @@ public void setNullBlob(final Blob nullBlob) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getBoolean} method.
      *
-     * @param nullBoolean the value
+     * @param nullBoolean The value
      */
     public void setNullBoolean(final boolean nullBoolean) {
         this.nullBoolean = nullBoolean;
@@ -452,7 +452,7 @@ public void setNullBoolean(final boolean nullBoolean) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getByte} method.
      *
-     * @param nullByte the value
+     * @param nullByte The value
      */
     public void setNullByte(final byte nullByte) {
         this.nullByte = nullByte;
@@ -462,7 +462,7 @@ public void setNullByte(final byte nullByte) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getBytes} method.
      *
-     * @param nullBytes the value
+     * @param nullBytes The value
      */
     public void setNullBytes(final byte[] nullBytes) {
         if (nullBytes != null) {
@@ -476,7 +476,7 @@ public void setNullBytes(final byte[] nullBytes) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getCharacterStream} method.
      *
-     * @param nullCharacterStream the value
+     * @param nullCharacterStream The value
      */
     public void setNullCharacterStream(final Reader nullCharacterStream) {
         this.nullCharacterStream = nullCharacterStream;
@@ -486,7 +486,7 @@ public void setNullCharacterStream(final Reader nullCharacterStream) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getClob} method.
      *
-     * @param nullClob the value
+     * @param nullClob The value
      */
     public void setNullClob(final Clob nullClob) {
         this.nullClob = nullClob;
@@ -496,7 +496,7 @@ public void setNullClob(final Clob nullClob) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getDate} method.
      *
-     * @param nullDate the value
+     * @param nullDate The value
      */
     public void setNullDate(final Date nullDate) {
         this.nullDate = nullDate != null ? new Date(nullDate.getTime()) : null;
@@ -506,7 +506,7 @@ public void setNullDate(final Date nullDate) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getDouble} method.
      *
-     * @param nullDouble the value
+     * @param nullDouble The value
      */
     public void setNullDouble(final double nullDouble) {
         this.nullDouble = nullDouble;
@@ -516,7 +516,7 @@ public void setNullDouble(final double nullDouble) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getFloat} method.
      *
-     * @param nullFloat the value
+     * @param nullFloat The value
      */
     public void setNullFloat(final float nullFloat) {
         this.nullFloat = nullFloat;
@@ -526,7 +526,7 @@ public void setNullFloat(final float nullFloat) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getInt} method.
      *
-     * @param nullInt the value
+     * @param nullInt The value
      */
     public void setNullInt(final int nullInt) {
         this.nullInt = nullInt;
@@ -536,7 +536,7 @@ public void setNullInt(final int nullInt) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getLong} method.
      *
-     * @param nullLong the value
+     * @param nullLong The value
      */
     public void setNullLong(final long nullLong) {
         this.nullLong = nullLong;
@@ -546,7 +546,7 @@ public void setNullLong(final long nullLong) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getObject} method.
      *
-     * @param nullObject the value
+     * @param nullObject The value
      */
     public void setNullObject(final Object nullObject) {
         this.nullObject = nullObject;
@@ -556,7 +556,7 @@ public void setNullObject(final Object nullObject) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getRef} method.
      *
-     * @param nullRef the value
+     * @param nullRef The value
      */
     public void setNullRef(final Ref nullRef) {
         this.nullRef = nullRef;
@@ -566,7 +566,7 @@ public void setNullRef(final Ref nullRef) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getShort} method.
      *
-     * @param nullShort the value
+     * @param nullShort The value
      */
     public void setNullShort(final short nullShort) {
         this.nullShort = nullShort;
@@ -576,7 +576,7 @@ public void setNullShort(final short nullShort) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getString} method.
      *
-     * @param nullString the value
+     * @param nullString The value
      */
     public void setNullString(final String nullString) {
         this.nullString = nullString;
@@ -586,7 +586,7 @@ public void setNullString(final String nullString) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getTime} method.
      *
-     * @param nullTime the value
+     * @param nullTime The value
      */
     public void setNullTime(final Time nullTime) {
         this.nullTime = nullTime != null ? new Time(nullTime.getTime()) : null;
@@ -596,7 +596,7 @@ public void setNullTime(final Time nullTime) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getTimestamp} method.
      *
-     * @param nullTimestamp the value
+     * @param nullTimestamp The value
      */
     public void setNullTimestamp(final Timestamp nullTimestamp) {
         if (nullTimestamp != null) {
@@ -611,7 +611,7 @@ public void setNullTimestamp(final Timestamp nullTimestamp) {
      * Sets the value to return when a SQL null is encountered as the result of
      * invoking a {@code getURL} method.
      *
-     * @param nullURL the value
+     * @param nullURL The value
      */
     public void setNullURL(final URL nullURL) {
         this.nullURL = nullURL;