This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-dbutils.git
The following commit(s) were added to refs/heads/master by this push:
new c769607 Javadoc: Replace <code></code> HTML tags with Javadoc {@code}
notation.
c769607 is described below
commit c7696079e0aae9e9e582b6c8b1979f4ea5653cf3
Author: Gary Gregory <[email protected]>
AuthorDate: Tue Dec 10 10:15:37 2019 -0500
Javadoc: Replace <code></code> HTML tags with Javadoc {@code} notation.
---
.../commons/dbutils/AbstractQueryRunner.java | 124 ++++++++++-----------
.../apache/commons/dbutils/AsyncQueryRunner.java | 82 +++++++-------
.../commons/dbutils/BaseResultSetHandler.java | 10 +-
.../apache/commons/dbutils/BasicRowProcessor.java | 22 ++--
.../org/apache/commons/dbutils/BeanProcessor.java | 52 ++++-----
.../org/apache/commons/dbutils/ColumnHandler.java | 10 +-
.../java/org/apache/commons/dbutils/DbUtils.java | 28 ++---
.../org/apache/commons/dbutils/OutParameter.java | 32 +++---
.../apache/commons/dbutils/PropertyHandler.java | 8 +-
.../org/apache/commons/dbutils/ProxyFactory.java | 14 +--
.../org/apache/commons/dbutils/QueryLoader.java | 6 +-
.../org/apache/commons/dbutils/QueryRunner.java | 124 ++++++++++-----------
.../apache/commons/dbutils/ResultSetHandler.java | 10 +-
.../apache/commons/dbutils/ResultSetIterator.java | 30 ++---
.../org/apache/commons/dbutils/RowProcessor.java | 32 +++---
.../commons/dbutils/StatementConfiguration.java | 8 +-
.../dbutils/handlers/AbstractKeyedHandler.java | 22 ++--
.../dbutils/handlers/AbstractListHandler.java | 12 +-
.../commons/dbutils/handlers/ArrayHandler.java | 14 +--
.../commons/dbutils/handlers/ArrayListHandler.java | 14 +--
.../commons/dbutils/handlers/BeanHandler.java | 20 ++--
.../commons/dbutils/handlers/BeanListHandler.java | 18 +--
.../commons/dbutils/handlers/BeanMapHandler.java | 20 ++--
.../dbutils/handlers/ColumnListHandler.java | 22 ++--
.../commons/dbutils/handlers/KeyedHandler.java | 24 ++--
.../commons/dbutils/handlers/MapHandler.java | 18 +--
.../commons/dbutils/handlers/MapListHandler.java | 14 +--
.../commons/dbutils/handlers/ScalarHandler.java | 24 ++--
.../dbutils/wrappers/SqlNullCheckedResultSet.java | 106 +++++++++---------
.../dbutils/wrappers/StringTrimmedResultSet.java | 18 +--
.../org/apache/commons/dbutils/MockResultSet.java | 6 +-
.../commons/dbutils/MockResultSetMetaData.java | 2 +-
.../dbutils/StatementConfigurationTest.java | 2 +-
.../wrappers/SqlNullCheckedResultSetTest.java | 2 +-
34 files changed, 475 insertions(+), 475 deletions(-)
diff --git a/src/main/java/org/apache/commons/dbutils/AbstractQueryRunner.java
b/src/main/java/org/apache/commons/dbutils/AbstractQueryRunner.java
index 7db2cd1..ec117db 100644
--- a/src/main/java/org/apache/commons/dbutils/AbstractQueryRunner.java
+++ b/src/main/java/org/apache/commons/dbutils/AbstractQueryRunner.java
@@ -67,12 +67,12 @@ public abstract class AbstractQueryRunner {
}
/**
- * Constructor to control the use of <code>ParameterMetaData</code>.
+ * Constructor to control the use of {@code ParameterMetaData}.
*
* @param pmdKnownBroken
* Some drivers don't support
* {@link ParameterMetaData#getParameterType(int) }; if
- * <code>pmdKnownBroken</code> is set to true, we won't even try
+ * {@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.
*/
@@ -83,12 +83,12 @@ public abstract class AbstractQueryRunner {
}
/**
- * Constructor to provide a <code>DataSource</code>. Methods that do not
- * take a <code>Connection</code> parameter will retrieve connections from
- * this <code>DataSource</code>.
+ * Constructor to provide a {@code DataSource}. Methods that do not
+ * take a {@code Connection} parameter will retrieve connections from
+ * this {@code DataSource}.
*
* @param ds
- * The <code>DataSource</code> to retrieve connections from.
+ * The {@code DataSource} to retrieve connections from.
*/
public AbstractQueryRunner(final DataSource ds) {
this.ds = ds;
@@ -96,17 +96,17 @@ public abstract class AbstractQueryRunner {
}
/**
- * Constructor to provide a <code>DataSource</code> and control the use of
- * <code>ParameterMetaData</code>. Methods that do not take a
- * <code>Connection</code> parameter will retrieve connections from this
- * <code>DataSource</code>.
+ * Constructor to provide a {@code DataSource} and control the use of
+ * {@code ParameterMetaData}. Methods that do not take a
+ * {@code Connection} parameter will retrieve connections from this
+ * {@code DataSource}.
*
* @param ds
- * The <code>DataSource</code> to retrieve connections from.
+ * The {@code DataSource} to retrieve connections from.
* @param pmdKnownBroken
* Some drivers don't support
* {@link ParameterMetaData#getParameterType(int) }; if
- * <code>pmdKnownBroken</code> is set to true, we won't even try
+ * {@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.
*/
@@ -117,13 +117,13 @@ public abstract class AbstractQueryRunner {
}
/**
- * Constructor for QueryRunner that takes a <code>DataSource</code>, a
<code>StatementConfiguration</code>, and
- * controls the use of <code>ParameterMetaData</code>. Methods that do
not take a <code>Connection</code> parameter
- * will retrieve connections from this <code>DataSource</code>.
+ * Constructor for QueryRunner that takes a {@code DataSource}, a {@code
StatementConfiguration}, and
+ * controls the use of {@code ParameterMetaData}. Methods that do not
take a {@code Connection} parameter
+ * will retrieve connections from this {@code DataSource}.
*
- * @param ds The <code>DataSource</code> to retrieve connections from.
+ * @param ds The {@code DataSource} to retrieve connections from.
* @param pmdKnownBroken Some drivers don't support {@link
java.sql.ParameterMetaData#getParameterType(int) };
- * if <code>pmdKnownBroken</code> is set to true, we won't even try it; if
false, we'll try it,
+ * 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 stmtConfig The configuration to apply to statements when they
are prepared.
*/
@@ -134,12 +134,12 @@ public abstract class AbstractQueryRunner {
}
/**
- * Constructor for QueryRunner that takes a <code>DataSource</code> to use
and a <code>StatementConfiguration</code>.
+ * Constructor for QueryRunner that takes a {@code DataSource} to use and
a {@code StatementConfiguration}.
*
- * Methods that do not take a <code>Connection</code> parameter will
retrieve connections from this
- * <code>DataSource</code>.
+ * Methods that do not take a {@code Connection} parameter will retrieve
connections from this
+ * {@code DataSource}.
*
- * @param ds The <code>DataSource</code> to retrieve connections from.
+ * @param ds The {@code DataSource} to retrieve connections from.
* @param stmtConfig The configuration to apply to statements when they
are prepared.
*/
public AbstractQueryRunner(final DataSource ds, final
StatementConfiguration stmtConfig) {
@@ -148,7 +148,7 @@ public abstract class AbstractQueryRunner {
}
/**
- * Constructor for QueryRunner that takes a
<code>StatementConfiguration</code> to configure statements when
+ * Constructor for QueryRunner that takes a {@code StatementConfiguration}
to configure statements when
* preparing them.
*
* @param stmtConfig The configuration to apply to statements when they
are prepared.
@@ -159,7 +159,7 @@ public abstract class AbstractQueryRunner {
}
/**
- * Close a <code>Connection</code>. This implementation avoids closing if
+ * Close a {@code Connection}. This implementation avoids closing if
* null and does <strong>not</strong> suppress any exceptions. Subclasses
* can override to provide special handling like logging.
*
@@ -174,7 +174,7 @@ public abstract class AbstractQueryRunner {
}
/**
- * Close a <code>ResultSet</code>. This implementation avoids closing if
+ * Close a {@code ResultSet}. This implementation avoids closing if
* null and does <strong>not</strong> suppress any exceptions. Subclasses
* can override to provide special handling like logging.
*
@@ -189,7 +189,7 @@ public abstract class AbstractQueryRunner {
}
/**
- * Close a <code>Statement</code>. This implementation avoids closing if
+ * Close a {@code Statement}. This implementation avoids closing if
* null and does <strong>not</strong> suppress any exceptions. Subclasses
* can override to provide special handling like logging.
*
@@ -259,13 +259,13 @@ public abstract class AbstractQueryRunner {
}
/**
- * Fill the <code>PreparedStatement</code> replacement parameters with the
+ * Fill the {@code PreparedStatement} replacement parameters with the
* given objects.
*
* @param stmt
* PreparedStatement to fill
* @param params
- * Query replacement parameters; <code>null</code> is a valid
+ * Query replacement parameters; {@code null} is a valid
* value to pass in.
* @throws SQLException
* if a database access error occurs
@@ -336,7 +336,7 @@ public abstract class AbstractQueryRunner {
}
/**
- * Fill the <code>PreparedStatement</code> replacement parameters with the
+ * Fill the {@code PreparedStatement} replacement parameters with the
* given object's bean property values.
*
* @param stmt
@@ -378,7 +378,7 @@ public abstract class AbstractQueryRunner {
}
/**
- * Fill the <code>PreparedStatement</code> replacement parameters with the
+ * Fill the {@code PreparedStatement} replacement parameters with the
* given object's bean property values.
*
* @param stmt
@@ -426,9 +426,9 @@ public abstract class AbstractQueryRunner {
}
/**
- * Returns the <code>DataSource</code> this runner is using.
- * <code>QueryRunner</code> methods always call this method to get the
- * <code>DataSource</code> so subclasses can provide specialized behavior.
+ * Returns the {@code DataSource} this runner is using.
+ * {@code QueryRunner} methods always call this method to get the
+ * {@code DataSource} so subclasses can provide specialized behavior.
*
* @return DataSource the runner is using
*/
@@ -439,7 +439,7 @@ public abstract class AbstractQueryRunner {
/**
* Some drivers don't support
* {@link ParameterMetaData#getParameterType(int) }; if
- * <code>pmdKnownBroken</code> is set to true, we won't even try it; 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.
*
@@ -453,18 +453,18 @@ public abstract class AbstractQueryRunner {
/**
* Factory method that creates and initializes a
- * <code>CallableStatement</code> object for the given SQL.
- * <code>QueryRunner</code> methods always call this method to prepare
+ * {@code CallableStatement} object for the given SQL.
+ * {@code QueryRunner} methods always call this method to prepare
* callable statements for them. Subclasses can override this method to
* provide special CallableStatement configuration if needed. This
- * implementation simply calls <code>conn.prepareCall(sql)</code>.
+ * implementation simply calls {@code conn.prepareCall(sql)}.
*
* @param conn
- * The <code>Connection</code> used to create the
- * <code>CallableStatement</code>
+ * The {@code Connection} used to create the
+ * {@code CallableStatement}
* @param sql
* The SQL statement to prepare.
- * @return An initialized <code>CallableStatement</code>.
+ * @return An initialized {@code CallableStatement}.
* @throws SQLException
* if a database access error occurs
*/
@@ -475,13 +475,13 @@ public abstract class AbstractQueryRunner {
}
/**
- * Factory method that creates and initializes a <code>Connection</code>
- * object. <code>QueryRunner</code> methods always call this method to
+ * Factory method that creates and initializes a {@code Connection}
+ * object. {@code QueryRunner} methods always call this method to
* retrieve connections from its DataSource. Subclasses can override this
- * method to provide special <code>Connection</code> configuration if
- * needed. This implementation simply calls
<code>ds.getConnection()</code>.
+ * method to provide special {@code Connection} configuration if
+ * needed. This implementation simply calls {@code ds.getConnection()}.
*
- * @return An initialized <code>Connection</code>.
+ * @return An initialized {@code Connection}.
* @throws SQLException
* if a database access error occurs
* @since DbUtils 1.1
@@ -497,18 +497,18 @@ public abstract class AbstractQueryRunner {
/**
* Factory method that creates and initializes a
- * <code>PreparedStatement</code> object for the given SQL.
- * <code>QueryRunner</code> methods always call this method to prepare
+ * {@code PreparedStatement} object for the given SQL.
+ * {@code QueryRunner} methods always call this method to prepare
* statements for them. Subclasses can override this method to provide
* special PreparedStatement configuration if needed. This implementation
- * simply calls <code>conn.prepareStatement(sql)</code>.
+ * simply calls {@code conn.prepareStatement(sql)}.
*
* @param conn
- * The <code>Connection</code> used to create the
- * <code>PreparedStatement</code>
+ * The {@code Connection} used to create the
+ * {@code PreparedStatement}
* @param sql
* The SQL statement to prepare.
- * @return An initialized <code>PreparedStatement</code>.
+ * @return An initialized {@code PreparedStatement}.
* @throws SQLException
* if a database access error occurs
*/
@@ -529,23 +529,23 @@ public abstract class AbstractQueryRunner {
/**
* Factory method that creates and initializes a
- * <code>PreparedStatement</code> object for the given SQL.
- * <code>QueryRunner</code> methods always call this method to prepare
+ * {@code PreparedStatement} object for the given SQL.
+ * {@code QueryRunner} methods always call this method to prepare
* statements for them. Subclasses can override this method to provide
* special PreparedStatement configuration if needed. This implementation
- * simply calls <code>conn.prepareStatement(sql, returnedKeys)</code>
+ * simply calls {@code conn.prepareStatement(sql, returnedKeys)}
* which will result in the ability to retrieve the automatically-generated
* keys from an auto_increment column.
*
* @param conn
- * The <code>Connection</code> used to create the
- * <code>PreparedStatement</code>
+ * The {@code Connection} used to create the
+ * {@code PreparedStatement}
* @param sql
* The SQL statement to prepare.
* @param returnedKeys
* Flag indicating whether to return generated keys or not.
*
- * @return An initialized <code>PreparedStatement</code>.
+ * @return An initialized {@code PreparedStatement}.
* @throws SQLException
* if a database access error occurs
* @since 1.6
@@ -576,7 +576,7 @@ public abstract class AbstractQueryRunner {
* The query that was executing when the exception happened.
*
* @param params
- * The query replacement parameters; <code>null</code> is a
valid
+ * The query replacement parameters; {@code null} is a valid
* value to pass in.
*
* @throws SQLException
@@ -609,8 +609,8 @@ public abstract class AbstractQueryRunner {
}
/**
- * Wrap the <code>ResultSet</code> in a decorator before processing it.
This
- * implementation returns the <code>ResultSet</code> it is given without
any
+ * Wrap the {@code ResultSet} in a decorator before processing it. This
+ * implementation returns the {@code ResultSet} it is given without any
* decoration.
*
* <p>
@@ -627,9 +627,9 @@ public abstract class AbstractQueryRunner {
* </pre>
*
* @param rs
- * The <code>ResultSet</code> to decorate; never
- * <code>null</code>.
- * @return The <code>ResultSet</code> wrapped in some decorator.
+ * The {@code ResultSet} to decorate; never
+ * {@code null}.
+ * @return The {@code ResultSet} wrapped in some decorator.
*/
protected ResultSet wrap(final ResultSet rs) {
return rs;
diff --git a/src/main/java/org/apache/commons/dbutils/AsyncQueryRunner.java
b/src/main/java/org/apache/commons/dbutils/AsyncQueryRunner.java
index 0b6540c..f430a28 100644
--- a/src/main/java/org/apache/commons/dbutils/AsyncQueryRunner.java
+++ b/src/main/java/org/apache/commons/dbutils/AsyncQueryRunner.java
@@ -28,7 +28,7 @@ import javax.sql.DataSource;
/**
* Executes SQL queries with pluggable strategies for handling
- * <code>ResultSet</code>s. This class is thread safe.
+ * {@code ResultSet}s. This class is thread safe.
*
* @see ResultSetHandler
* @since 1.4
@@ -61,10 +61,10 @@ public class AsyncQueryRunner extends AbstractQueryRunner {
/**
* @deprecated Use {@link #AsyncQueryRunner(ExecutorService, QueryRunner)}
instead.
- * Constructor for AsyncQueryRunner that controls the use of
<code>ParameterMetaData</code>.
+ * Constructor for AsyncQueryRunner that controls the use of {@code
ParameterMetaData}.
*
* @param pmdKnownBroken Some drivers don't support {@link
java.sql.ParameterMetaData#getParameterType(int) };
- * if <code>pmdKnownBroken</code> is set to true, we won't even try it; if
false, we'll try it,
+ * 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.
*/
@@ -75,12 +75,12 @@ public class AsyncQueryRunner extends AbstractQueryRunner {
/**
* @deprecated Use {@link #AsyncQueryRunner(ExecutorService, QueryRunner)}
instead.
- * Constructor for AsyncQueryRunner that takes a <code>DataSource</code>.
+ * Constructor for AsyncQueryRunner that takes a {@code DataSource}.
*
- * Methods that do not take a <code>Connection</code> parameter will
retrieve connections from this
- * <code>DataSource</code>.
+ * Methods that do not take a {@code Connection} parameter will retrieve
connections from this
+ * {@code DataSource}.
*
- * @param ds The <code>DataSource</code> to retrieve connections from.
+ * @param ds The {@code DataSource} to retrieve connections from.
* @param executorService the {@code ExecutorService} instance used to run
JDBC invocations concurrently.
*/
@Deprecated
@@ -90,13 +90,13 @@ public class AsyncQueryRunner extends AbstractQueryRunner {
/**
* @deprecated Use {@link #AsyncQueryRunner(ExecutorService, QueryRunner)}
instead.
- * Constructor for AsyncQueryRunner that take a <code>DataSource</code>
and controls the use of <code>ParameterMetaData</code>.
- * Methods that do not take a <code>Connection</code> parameter will
retrieve connections from this
- * <code>DataSource</code>.
+ * 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
+ * {@code DataSource}.
*
- * @param ds The <code>DataSource</code> to retrieve connections from.
+ * @param ds The {@code DataSource} to retrieve connections from.
* @param pmdKnownBroken Some drivers don't support {@link
java.sql.ParameterMetaData#getParameterType(int) };
- * if <code>pmdKnownBroken</code> is set to true, we won't even try it; if
false, we'll try it,
+ * 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.
*/
@@ -166,12 +166,12 @@ public class AsyncQueryRunner extends AbstractQueryRunner
{
/**
* Execute a batch of SQL INSERT, UPDATE, or DELETE queries.
*
- * @param conn The <code>Connection</code> to use to run the query. The
caller is
+ * @param conn The {@code Connection} to use to run the query. The caller
is
* responsible for closing this Connection.
* @param sql The SQL to execute.
* @param params An array of query replacement parameters. Each row in
* this array is one set of batch replacement values.
- * @return A <code>Future</code> which returns the number of rows updated
per statement.
+ * @return A {@code Future} which returns the number of rows updated per
statement.
* @throws SQLException if a database access error occurs
*/
public Future<int[]> batch(final Connection conn, final String sql, final
Object[][] params) throws SQLException {
@@ -187,14 +187,14 @@ public class AsyncQueryRunner extends AbstractQueryRunner
{
/**
* Execute a batch of SQL INSERT, UPDATE, or DELETE queries. The
- * <code>Connection</code> is retrieved from the <code>DataSource</code>
- * set in the constructor. This <code>Connection</code> must be in
+ * {@code Connection} is retrieved from the {@code DataSource}
+ * set in the constructor. This {@code Connection} must be in
* auto-commit mode or the update will not be saved.
*
* @param sql The SQL to execute.
* @param params An array of query replacement parameters. Each row in
* this array is one set of batch replacement values.
- * @return A <code>Future</code> which returns the number of rows updated
per statement.
+ * @return A {@code Future} which returns the number of rows updated per
statement.
* @throws SQLException if a database access error occurs
*/
public Future<int[]> batch(final String sql, final Object[][] params)
throws SQLException {
@@ -282,7 +282,7 @@ public class AsyncQueryRunner extends AbstractQueryRunner {
* @param sql The query to execute.
* @param rsh The handler that converts the results into an object.
* @param params The replacement parameters.
- * @return A <code>Future</code> which returns the result of the query
call.
+ * @return A {@code Future} which returns the result of the query call.
* @throws SQLException if a database access error occurs
*/
public <T> Future<T> query(final Connection conn, final String sql, final
ResultSetHandler<T> rsh, final Object... params)
@@ -304,7 +304,7 @@ public class AsyncQueryRunner extends AbstractQueryRunner {
* @param conn The connection to execute the query in.
* @param sql The query to execute.
* @param rsh The handler that converts the results into an object.
- * @return A <code>Future</code> which returns the result of the query
call.
+ * @return A {@code Future} which returns the result of the query call.
* @throws SQLException if a database access error occurs
*/
public <T> Future<T> query(final Connection conn, final String sql, final
ResultSetHandler<T> rsh) throws SQLException {
@@ -320,15 +320,15 @@ public class AsyncQueryRunner extends AbstractQueryRunner
{
/**
* Executes the given SELECT SQL query and returns a result object.
- * The <code>Connection</code> is retrieved from the
- * <code>DataSource</code> set in the constructor.
+ * The {@code Connection} is retrieved from the
+ * {@code DataSource} set in the constructor.
* @param <T> The type of object that the handler returns
* @param sql The SQL statement to execute.
* @param rsh The handler used to create the result object from
- * the <code>ResultSet</code>.
+ * the {@code ResultSet}.
* @param params Initialize the PreparedStatement's IN parameters with
* this array.
- * @return A <code>Future</code> which returns the result of the query
call.
+ * @return A {@code Future} which returns the result of the query call.
* @throws SQLException if a database access error occurs
*/
public <T> Future<T> query(final String sql, final ResultSetHandler<T>
rsh, final Object... params) throws SQLException {
@@ -344,14 +344,14 @@ public class AsyncQueryRunner extends AbstractQueryRunner
{
/**
* Executes the given SELECT SQL without any replacement parameters.
- * The <code>Connection</code> is retrieved from the
- * <code>DataSource</code> set in the constructor.
+ * The {@code Connection} is retrieved from the
+ * {@code DataSource} set in the constructor.
* @param <T> The type of object that the handler returns
* @param sql The SQL statement to execute.
* @param rsh The handler used to create the result object from
- * the <code>ResultSet</code>.
+ * the {@code ResultSet}.
*
- * @return A <code>Future</code> which returns the result of the query
call.
+ * @return A {@code Future} which returns the result of the query call.
* @throws SQLException if a database access error occurs
*/
public <T> Future<T> query(final String sql, final ResultSetHandler<T>
rsh) throws SQLException {
@@ -429,7 +429,7 @@ public class AsyncQueryRunner extends AbstractQueryRunner {
*
* @param conn The connection to use to run the query.
* @param sql The SQL to execute.
- * @return A <code>Future</code> which returns the number of rows updated.
+ * @return A {@code Future} which returns the number of rows updated.
* @throws SQLException if a database access error occurs
*/
public Future<Integer> update(final Connection conn, final String sql)
throws SQLException {
@@ -450,7 +450,7 @@ public class AsyncQueryRunner extends AbstractQueryRunner {
* @param conn The connection to use to run the query.
* @param sql The SQL to execute.
* @param param The replacement parameter.
- * @return A <code>Future</code> which returns the number of rows updated.
+ * @return A {@code Future} which returns the number of rows updated.
* @throws SQLException if a database access error occurs
*/
public Future<Integer> update(final Connection conn, final String sql,
final Object param) throws SQLException {
@@ -470,7 +470,7 @@ public class AsyncQueryRunner extends AbstractQueryRunner {
* @param conn The connection to use to run the query.
* @param sql The SQL to execute.
* @param params The query replacement parameters.
- * @return A <code>Future</code> which returns the number of rows updated.
+ * @return A {@code Future} which returns the number of rows updated.
* @throws SQLException if a database access error occurs
*/
public Future<Integer> update(final Connection conn, final String sql,
final Object... params) throws SQLException {
@@ -486,14 +486,14 @@ public class AsyncQueryRunner extends AbstractQueryRunner
{
/**
* Executes the given INSERT, UPDATE, or DELETE SQL statement without
- * any replacement parameters. The <code>Connection</code> is retrieved
- * from the <code>DataSource</code> set in the constructor. This
- * <code>Connection</code> must be in auto-commit mode or the update will
+ * any replacement parameters. The {@code Connection} is retrieved
+ * from the {@code DataSource} set in the constructor. This
+ * {@code Connection} must be in auto-commit mode or the update will
* not be saved.
*
* @param sql The SQL statement to execute.
* @throws SQLException if a database access error occurs
- * @return A <code>Future</code> which returns the number of rows updated.
+ * @return A {@code Future} which returns the number of rows updated.
*/
public Future<Integer> update(final String sql) throws SQLException {
return executorService.submit(new Callable<Integer>() {
@@ -508,15 +508,15 @@ public class AsyncQueryRunner extends AbstractQueryRunner
{
/**
* Executes the given INSERT, UPDATE, or DELETE SQL statement with
- * a single replacement parameter. The <code>Connection</code> is
- * retrieved from the <code>DataSource</code> set in the constructor.
- * This <code>Connection</code> must be in auto-commit mode or the
+ * a single replacement parameter. The {@code Connection} is
+ * retrieved from the {@code DataSource} set in the constructor.
+ * This {@code Connection} must be in auto-commit mode or the
* update will not be saved.
*
* @param sql The SQL statement to execute.
* @param param The replacement parameter.
* @throws SQLException if a database access error occurs
- * @return A <code>Future</code> which returns the number of rows updated.
+ * @return A {@code Future} which returns the number of rows updated.
*/
public Future<Integer> update(final String sql, final Object param) throws
SQLException {
return executorService.submit(new Callable<Integer>() {
@@ -531,15 +531,15 @@ public class AsyncQueryRunner extends AbstractQueryRunner
{
/**
* Executes the given INSERT, UPDATE, or DELETE SQL statement. The
- * <code>Connection</code> is retrieved from the <code>DataSource</code>
- * set in the constructor. This <code>Connection</code> must be in
+ * {@code Connection} is retrieved from the {@code DataSource}
+ * set in the constructor. This {@code Connection} must be in
* auto-commit mode or the update will not be saved.
*
* @param sql The SQL statement to execute.
* @param params Initializes the PreparedStatement's IN (i.e. '?')
* parameters.
* @throws SQLException if a database access error occurs
- * @return A <code>Future</code> which returns the number of rows updated.
+ * @return A {@code Future} which returns the number of rows updated.
*/
public Future<Integer> update(final String sql, final Object... params)
throws SQLException {
return executorService.submit(new Callable<Integer>() {
diff --git a/src/main/java/org/apache/commons/dbutils/BaseResultSetHandler.java
b/src/main/java/org/apache/commons/dbutils/BaseResultSetHandler.java
index 5b0db6a..814b52d 100644
--- a/src/main/java/org/apache/commons/dbutils/BaseResultSetHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/BaseResultSetHandler.java
@@ -41,10 +41,10 @@ import java.util.Map;
/**
* Extensions of this class convert ResultSets into other objects.
*
- * According to the <i>DRY</i> principle (Don't Repeat Yourself), repeating
<code>resultSet</code>
+ * According to the <i>DRY</i> principle (Don't Repeat Yourself), repeating
{@code resultSet}
* variable inside the {@link ResultSetHandler#handle(ResultSet)} over and
over for each iteration
- * can get a little tedious, <code>AbstractResultSetHandler</code> implicitly
gives users access to
- * <code>ResultSet</code>'s methods.
+ * can get a little tedious, {@code AbstractResultSetHandler} implicitly gives
users access to
+ * {@code ResultSet}'s methods.
*
* <b>NOTE</b> This class is <i>NOT</i> thread safe!
*
@@ -77,9 +77,9 @@ public abstract class BaseResultSetHandler<T> implements
ResultSetHandler<T> {
}
/**
- * Turn the <code>ResultSet</code> into an Object.
+ * Turn the {@code ResultSet} into an Object.
*
- * @return An Object initialized with <code>ResultSet</code> data
+ * @return An Object initialized with {@code ResultSet} data
* @throws SQLException if a database access error occurs
* @see ResultSetHandler#handle(ResultSet)
*/
diff --git a/src/main/java/org/apache/commons/dbutils/BasicRowProcessor.java
b/src/main/java/org/apache/commons/dbutils/BasicRowProcessor.java
index afffbd6..66d2250 100644
--- a/src/main/java/org/apache/commons/dbutils/BasicRowProcessor.java
+++ b/src/main/java/org/apache/commons/dbutils/BasicRowProcessor.java
@@ -26,7 +26,7 @@ import java.util.Locale;
import java.util.Map;
/**
- * Basic implementation of the <code>RowProcessor</code> interface.
+ * Basic implementation of the {@code RowProcessor} interface.
*
* <p>
* This class is thread-safe.
@@ -88,10 +88,10 @@ public class BasicRowProcessor implements RowProcessor {
}
/**
- * Convert a <code>ResultSet</code> row into an <code>Object[]</code>.
+ * Convert a {@code ResultSet} row into an {@code Object[]}.
* This implementation copies column values into the array in the same
- * order they're returned from the <code>ResultSet</code>. Array elements
- * will be set to <code>null</code> if the column was SQL NULL.
+ * order they're returned from the {@code ResultSet}. Array elements
+ * will be set to {@code null} if the column was SQL NULL.
*
* @see org.apache.commons.dbutils.RowProcessor#toArray(java.sql.ResultSet)
* @param rs ResultSet that supplies the array data
@@ -112,7 +112,7 @@ public class BasicRowProcessor implements RowProcessor {
}
/**
- * Convert a <code>ResultSet</code> row into a JavaBean. This
+ * Convert a {@code ResultSet} row into a JavaBean. This
* implementation delegates to a BeanProcessor instance.
* @see org.apache.commons.dbutils.RowProcessor#toBean(java.sql.ResultSet,
java.lang.Class)
* @see
org.apache.commons.dbutils.BeanProcessor#toBean(java.sql.ResultSet,
java.lang.Class)
@@ -128,7 +128,7 @@ public class BasicRowProcessor implements RowProcessor {
}
/**
- * Convert a <code>ResultSet</code> into a <code>List</code> of JavaBeans.
+ * Convert a {@code ResultSet} into a {@code List} of JavaBeans.
* This implementation delegates to a BeanProcessor instance.
* @see
org.apache.commons.dbutils.RowProcessor#toBeanList(java.sql.ResultSet,
java.lang.Class)
* @see
org.apache.commons.dbutils.BeanProcessor#toBeanList(java.sql.ResultSet,
java.lang.Class)
@@ -136,8 +136,8 @@ public class BasicRowProcessor implements RowProcessor {
* @param rs ResultSet that supplies the bean data
* @param type Class from which to create the bean instance
* @throws SQLException if a database access error occurs
- * @return A <code>List</code> of beans with the given type in the order
- * they were returned by the <code>ResultSet</code>.
+ * @return A {@code List} of beans with the given type in the order
+ * they were returned by the {@code ResultSet}.
*/
@Override
public <T> List<T> toBeanList(final ResultSet rs, final Class<? extends T>
type) throws SQLException {
@@ -145,11 +145,11 @@ public class BasicRowProcessor implements RowProcessor {
}
/**
- * Convert a <code>ResultSet</code> row into a <code>Map</code>.
+ * Convert a {@code ResultSet} row into a {@code Map}.
*
* <p>
- * This implementation returns a <code>Map</code> with case insensitive
column names as keys. Calls to
- * <code>map.get("COL")</code> and <code>map.get("col")</code> return the
same value. Furthermore this implementation
+ * This implementation returns a {@code Map} with case insensitive column
names as keys. Calls to
+ * {@code map.get("COL")} and {@code map.get("col")} return the same
value. Furthermore this implementation
* will return an ordered map, that preserves the ordering of the columns
in the ResultSet, so that iterating over
* the entry set of the returned map will return the first column of the
ResultSet, then the second and so forth.
* </p>
diff --git a/src/main/java/org/apache/commons/dbutils/BeanProcessor.java
b/src/main/java/org/apache/commons/dbutils/BeanProcessor.java
index 6fdf8fb..802542f 100644
--- a/src/main/java/org/apache/commons/dbutils/BeanProcessor.java
+++ b/src/main/java/org/apache/commons/dbutils/BeanProcessor.java
@@ -37,8 +37,8 @@ import java.util.ServiceLoader;
/**
* <p>
- * <code>BeanProcessor</code> matches column names to bean property names
- * and converts <code>ResultSet</code> columns into objects for those bean
+ * {@code BeanProcessor} matches column names to bean property names
+ * and converts {@code ResultSet} columns into objects for those bean
* properties. Subclasses should override the methods in the processing chain
* to customize behavior.
* </p>
@@ -54,9 +54,9 @@ import java.util.ServiceLoader;
public class BeanProcessor {
/**
- * Special array value used by <code>mapColumnsToProperties</code> that
+ * Special array value used by {@code mapColumnsToProperties} that
* indicates there is no bean property that matches a column from a
- * <code>ResultSet</code>.
+ * {@code ResultSet}.
*/
protected static final int PROPERTY_NOT_FOUND = -1;
@@ -119,8 +119,8 @@ public class BeanProcessor {
}
/**
- * Convert a <code>ResultSet</code> row into a JavaBean. This
- * implementation uses reflection and <code>BeanInfo</code> classes to
+ * Convert a {@code ResultSet} row into a JavaBean. This
+ * implementation uses reflection and {@code BeanInfo} classes to
* match column names to bean property names. Properties are matched to
* columns based on several factors:
* <br/>
@@ -140,10 +140,10 @@ public class BeanProcessor {
*
* <p>
* Primitive bean properties are set to their defaults when SQL NULL is
- * returned from the <code>ResultSet</code>. Numeric fields are set to 0
+ * returned from the {@code ResultSet}. Numeric fields are set to 0
* and booleans are set to false. Object bean properties are set to
- * <code>null</code> when SQL NULL is returned. This is the same behavior
- * as the <code>ResultSet</code> get* methods.
+ * {@code null} when SQL NULL is returned. This is the same behavior
+ * as the {@code ResultSet} get* methods.
* </p>
* @param <T> The type of bean to create
* @param rs ResultSet that supplies the bean data
@@ -157,8 +157,8 @@ public class BeanProcessor {
}
/**
- * Convert a <code>ResultSet</code> into a <code>List</code> of JavaBeans.
- * This implementation uses reflection and <code>BeanInfo</code> classes to
+ * Convert a {@code ResultSet} into a {@code List} of JavaBeans.
+ * This implementation uses reflection and {@code BeanInfo} classes to
* match column names to bean property names. Properties are matched to
* columns based on several factors:
* <br/>
@@ -178,10 +178,10 @@ public class BeanProcessor {
*
* <p>
* Primitive bean properties are set to their defaults when SQL NULL is
- * returned from the <code>ResultSet</code>. Numeric fields are set to 0
+ * returned from the {@code ResultSet}. Numeric fields are set to 0
* and booleans are set to false. Object bean properties are set to
- * <code>null</code> when SQL NULL is returned. This is the same behavior
- * as the <code>ResultSet</code> get* methods.
+ * {@code null} when SQL NULL is returned. This is the same behavior
+ * as the {@code ResultSet} get* methods.
* </p>
* @param <T> The type of bean to create
* @param rs ResultSet that supplies the bean data
@@ -352,11 +352,11 @@ public class BeanProcessor {
}
/**
- * Check whether a value is of the same primitive type as
<code>targetType</code>.
+ * Check whether a value is of the same primitive type as {@code
targetType}.
*
* @param targetType The primitive type to target.
* @param valueType The value to match to the primitive type.
- * @return Whether <code>valueType</code> can be coerced (e.g. autoboxed)
into <code>targetType</code>.
+ * @return Whether {@code valueType} can be coerced (e.g. autoboxed) into
{@code targetType}.
*/
private boolean matchesPrimitive(final Class<?> targetType, final Class<?>
valueType) {
if (!targetType.isPrimitive()) {
@@ -444,11 +444,11 @@ public class BeanProcessor {
/**
* The positions in the returned array represent column numbers. The
* values stored at each position represent the index in the
- * <code>PropertyDescriptor[]</code> for the bean property that matches
+ * {@code PropertyDescriptor[]} for the bean property that matches
* the column name. If no bean property was found for a column, the
- * position is set to <code>PROPERTY_NOT_FOUND</code>.
+ * position is set to {@code PROPERTY_NOT_FOUND}.
*
- * @param rsmd The <code>ResultSetMetaData</code> containing column
+ * @param rsmd The {@code ResultSetMetaData} containing column
* information.
*
* @param props The bean property descriptors.
@@ -495,19 +495,19 @@ public class BeanProcessor {
}
/**
- * Convert a <code>ResultSet</code> column into an object. Simple
- * implementations could just call <code>rs.getObject(index)</code> while
+ * Convert a {@code ResultSet} column into an object. Simple
+ * implementations could just call {@code rs.getObject(index)} while
* more complex implementations could perform type manipulation to match
* the column's type to the bean property type.
*
* <p>
- * This implementation calls the appropriate <code>ResultSet</code> getter
+ * This implementation calls the appropriate {@code ResultSet} getter
* method for the given property type to perform the type conversion. If
* the property type doesn't match one of the supported
- * <code>ResultSet</code> types, <code>getObject</code> is called.
+ * {@code ResultSet} types, {@code getObject} is called.
* </p>
*
- * @param rs The <code>ResultSet</code> currently being processed. It is
+ * @param rs The {@code ResultSet} currently being processed. It is
* positioned on a valid row before being passed into this method.
*
* @param index The current column index being processed.
@@ -517,8 +517,8 @@ public class BeanProcessor {
*
* @throws SQLException if a database access error occurs
*
- * @return The object from the <code>ResultSet</code> at the given column
- * index after optional type processing or <code>null</code> if the column
+ * @return The object from the {@code ResultSet} at the given column
+ * index after optional type processing or {@code null} if the column
* value was SQL NULL.
*/
protected Object processColumn(final ResultSet rs, final int index, final
Class<?> propType)
diff --git a/src/main/java/org/apache/commons/dbutils/ColumnHandler.java
b/src/main/java/org/apache/commons/dbutils/ColumnHandler.java
index 0187c03..173435c 100644
--- a/src/main/java/org/apache/commons/dbutils/ColumnHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/ColumnHandler.java
@@ -21,12 +21,12 @@ import java.sql.SQLException;
/**
* Interface to define how implementations can interact with column handling
when constructing a bean from a
- * {@link java.sql.ResultSet}. ColumnHandlers do the work of retrieving data
correctly from the <code>ResultSet</code>.
+ * {@link java.sql.ResultSet}. ColumnHandlers do the work of retrieving data
correctly from the {@code ResultSet}.
*/
public interface ColumnHandler {
/**
- * Test whether this <code>ColumnHandler</code> wants to handle a column
targeted for a value type matching
- * <code>propType</code>.
+ * Test whether this {@code ColumnHandler} wants to handle a column
targeted for a value type matching
+ * {@code propType}.
*
* @param propType The type of the target parameter.
* @return true is this property handler can/wants to handle this value;
false otherwise.
@@ -34,8 +34,8 @@ public interface ColumnHandler {
boolean match(Class<?> propType);
/**
- * Do the work required to retrieve and store a column from
<code>ResultSet</code> into something of type
- * <code>propType</code>. This method is called only if this handler
responded <code>true</code> after a call to
+ * Do the work required to retrieve and store a column from {@code
ResultSet} into something of type
+ * {@code propType}. This method is called only if this handler responded
{@code true} after a call to
* {@link #match(Class)}.
*
* @param rs The result set to get data from. This should be moved to the
correct row already.
diff --git a/src/main/java/org/apache/commons/dbutils/DbUtils.java
b/src/main/java/org/apache/commons/dbutils/DbUtils.java
index 0ce654a..7b561a0 100644
--- a/src/main/java/org/apache/commons/dbutils/DbUtils.java
+++ b/src/main/java/org/apache/commons/dbutils/DbUtils.java
@@ -50,7 +50,7 @@ public final class DbUtils {
}
/**
- * Close a <code>Connection</code>, avoid closing if null.
+ * Close a {@code Connection}, avoid closing if null.
*
* @param conn Connection to close.
* @throws SQLException if a database access error occurs
@@ -62,7 +62,7 @@ public final class DbUtils {
}
/**
- * Close a <code>ResultSet</code>, avoid closing if null.
+ * Close a {@code ResultSet}, avoid closing if null.
*
* @param rs ResultSet to close.
* @throws SQLException if a database access error occurs
@@ -74,7 +74,7 @@ public final class DbUtils {
}
/**
- * Close a <code>Statement</code>, avoid closing if null.
+ * Close a {@code Statement}, avoid closing if null.
*
* @param stmt Statement to close.
* @throws SQLException if a database access error occurs
@@ -86,7 +86,7 @@ public final class DbUtils {
}
/**
- * Close a <code>Connection</code>, avoid closing if null and hide
+ * Close a {@code Connection}, avoid closing if null and hide
* any SQLExceptions that occur.
*
* @param conn Connection to close.
@@ -100,8 +100,8 @@ public final class DbUtils {
}
/**
- * Close a <code>Connection</code>, <code>Statement</code> and
- * <code>ResultSet</code>. Avoid closing if null and hide any
+ * Close a {@code Connection}, {@code Statement} and
+ * {@code ResultSet}. Avoid closing if null and hide any
* SQLExceptions that occur.
*
* @param conn Connection to close.
@@ -124,7 +124,7 @@ public final class DbUtils {
}
/**
- * Close a <code>ResultSet</code>, avoid closing if null and hide any
+ * Close a {@code ResultSet}, avoid closing if null and hide any
* SQLExceptions that occur.
*
* @param rs ResultSet to close.
@@ -138,7 +138,7 @@ public final class DbUtils {
}
/**
- * Close a <code>Statement</code>, avoid closing if null and hide
+ * Close a {@code Statement}, avoid closing if null and hide
* any SQLExceptions that occur.
*
* @param stmt Statement to close.
@@ -152,7 +152,7 @@ public final class DbUtils {
}
/**
- * Commits a <code>Connection</code> then closes it, avoid closing if null.
+ * Commits a {@code Connection} then closes it, avoid closing if null.
*
* @param conn Connection to close.
* @throws SQLException if a database access error occurs
@@ -168,7 +168,7 @@ public final class DbUtils {
}
/**
- * Commits a <code>Connection</code> then closes it, avoid closing if null
+ * Commits a {@code Connection} then closes it, avoid closing if null
* and hide any SQLExceptions that occur.
*
* @param conn Connection to close.
@@ -186,7 +186,7 @@ public final class DbUtils {
* If this succeeds, it returns true, else it returns false.
*
* @param driverClassName of driver to load
- * @return boolean <code>true</code> if the driver was found, otherwise
<code>false</code>
+ * @return boolean {@code true} if the driver was found, otherwise {@code
false}
*/
public static boolean loadDriver(final String driverClassName) {
return loadDriver(DbUtils.class.getClassLoader(), driverClassName);
@@ -198,7 +198,7 @@ public final class DbUtils {
*
* @param classLoader the class loader used to load the driver class
* @param driverClassName of driver to load
- * @return boolean <code>true</code> if the driver was found, otherwise
<code>false</code>
+ * @return boolean {@code true} if the driver was found, otherwise {@code
false}
* @since 1.4
*/
public static boolean loadDriver(final ClassLoader classLoader, final
String driverClassName) {
@@ -300,7 +300,7 @@ public final class DbUtils {
}
/**
- * Performs a rollback on the <code>Connection</code> then closes it,
+ * Performs a rollback on the {@code Connection} then closes it,
* avoid closing if null.
*
* @param conn Connection to rollback. A null value is legal.
@@ -318,7 +318,7 @@ public final class DbUtils {
}
/**
- * Performs a rollback on the <code>Connection</code> then closes it,
+ * Performs a rollback on the {@code Connection} then closes it,
* avoid closing if null and hide any SQLExceptions that occur.
*
* @param conn Connection to rollback. A null value is legal.
diff --git a/src/main/java/org/apache/commons/dbutils/OutParameter.java
b/src/main/java/org/apache/commons/dbutils/OutParameter.java
index 93e00fb..f40ce5d 100644
--- a/src/main/java/org/apache/commons/dbutils/OutParameter.java
+++ b/src/main/java/org/apache/commons/dbutils/OutParameter.java
@@ -22,15 +22,15 @@ import java.sql.SQLException;
/**
* Represents an OUT parameter for a stored procedure. When running a stored
* procedure with {@link QueryRunner}, pass an instance of
- * <code>OutParameter</code> to indicate that the parameter at that index is an
+ * {@code OutParameter} to indicate that the parameter at that index is an
* OUT parameter. The value of the parameter may be obtained from the
- * <code>OutParameter</code> instance via {@link #getValue() }.
+ * {@code OutParameter} instance via {@link #getValue() }.
* <p>
- * INOUT parameters are also supported by setting the <code>value</code> of
- * the <code>OutParameter</code> instance before invoking the stored procedure.
+ * INOUT parameters are also supported by setting the {@code value} of
+ * the {@code OutParameter} instance before invoking the stored procedure.
*
* @param <T> the class of the parameter; should be compatible via cast with
the
- * class returned by the <code>CallableStatement.getObject(int)</code> method.
+ * class returned by the {@code CallableStatement.getObject(int)} method.
*/
public class OutParameter<T> {
private final int sqlType;
@@ -38,13 +38,13 @@ public class OutParameter<T> {
private T value = null;
/**
- * Construct an <code>OutParameter</code> for the given JDBC SQL type and
+ * Construct an {@code OutParameter} for the given JDBC SQL type and
* Java type.
* @param sqlType the JDBC SQL type of the parameter as in
- * <code>java.sql.Types</code>.
+ * {@code java.sql.Types}.
* @param javaType the Java class of the parameter value, cast compatible
- * with the type returned by <code>CallableStatement.getObject(int)</code>
- * for the JDBC type given by <code>sqlType</code>.
+ * with the type returned by {@code CallableStatement.getObject(int)}
+ * for the JDBC type given by {@code sqlType}.
*/
public OutParameter(final int sqlType, final Class<T> javaType) {
this.sqlType = sqlType;
@@ -52,14 +52,14 @@ public class OutParameter<T> {
}
/**
- * Construct an <code>OutParameter</code> for the given JDBC SQL type and
+ * Construct an {@code OutParameter} for the given JDBC SQL type and
* 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
- * <code>java.sql.Types</code>.
+ * {@code java.sql.Types}.
* @param javaType the Java class of the parameter value, cast compatible
- * with the type returned by <code>CallableStatement.getObject(int)</code>
- * for the JDBC type given by <code>sqlType</code>.
+ * 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
*/
public OutParameter(final int sqlType, final Class<T> javaType, final T
value) {
@@ -106,7 +106,7 @@ public class OutParameter<T> {
/**
* Set the value using the return value of the parameter an the given index
- * from the given <code>CallableStatement</code>.
+ * from the given {@code CallableStatement}.
* @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
@@ -119,8 +119,8 @@ public class OutParameter<T> {
/**
* Set up the given statement by registering an OUT parameter at the given
- * index using the <code>sqlType</code> and <code>value</code> of this
- * <code>OutParameter</code>. If the value is not null, the parameter is
+ * index using the {@code sqlType} and {@code value} of this
+ * {@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.
diff --git a/src/main/java/org/apache/commons/dbutils/PropertyHandler.java
b/src/main/java/org/apache/commons/dbutils/PropertyHandler.java
index 952179c..dfb4d55 100644
--- a/src/main/java/org/apache/commons/dbutils/PropertyHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/PropertyHandler.java
@@ -23,8 +23,8 @@ package org.apache.commons.dbutils;
public interface PropertyHandler {
/**
- * Test whether this <code>PropertyHandler</code> wants to handle setting
<code>value</code> into something of type
- * <code>parameter</code>.
+ * Test whether this {@code PropertyHandler} wants to handle setting
{@code value} into something of type
+ * {@code parameter}.
*
* @param parameter The type of the target parameter.
* @param value The value to be set.
@@ -33,8 +33,8 @@ public interface PropertyHandler {
boolean match(Class<?> parameter, Object value);
/**
- * Do the work required to store <code>value</code> into something of type
<code>parameter</code>. This method is
- * called only if this handler responded <code>true</code> after a call to
{@link #match(Class, Object)}.
+ * Do the work required to store {@code value} into something of type
{@code parameter}. This method is
+ * called only if this handler responded {@code true} after a call to
{@link #match(Class, Object)}.
*
* @param parameter The type of the target parameter.
* @param value The value to be set.
diff --git a/src/main/java/org/apache/commons/dbutils/ProxyFactory.java
b/src/main/java/org/apache/commons/dbutils/ProxyFactory.java
index 1c97c84..9d655d0 100644
--- a/src/main/java/org/apache/commons/dbutils/ProxyFactory.java
+++ b/src/main/java/org/apache/commons/dbutils/ProxyFactory.java
@@ -70,7 +70,7 @@ public class ProxyFactory {
}
/**
- * Creates a new proxy <code>CallableStatement</code> object.
+ * Creates a new proxy {@code CallableStatement} object.
* @param handler The handler that intercepts/overrides method calls.
* @return proxied CallableStatement
*/
@@ -79,7 +79,7 @@ public class ProxyFactory {
}
/**
- * Creates a new proxy <code>Connection</code> object.
+ * Creates a new proxy {@code Connection} object.
* @param handler The handler that intercepts/overrides method calls.
* @return proxied Connection
*/
@@ -88,7 +88,7 @@ public class ProxyFactory {
}
/**
- * Creates a new proxy <code>Driver</code> object.
+ * Creates a new proxy {@code Driver} object.
* @param handler The handler that intercepts/overrides method calls.
* @return proxied Driver
*/
@@ -97,7 +97,7 @@ public class ProxyFactory {
}
/**
- * Creates a new proxy <code>PreparedStatement</code> object.
+ * Creates a new proxy {@code PreparedStatement} object.
* @param handler The handler that intercepts/overrides method calls.
* @return proxied PreparedStatement
*/
@@ -106,7 +106,7 @@ public class ProxyFactory {
}
/**
- * Creates a new proxy <code>ResultSet</code> object.
+ * Creates a new proxy {@code ResultSet} object.
* @param handler The handler that intercepts/overrides method calls.
* @return proxied ResultSet
*/
@@ -115,7 +115,7 @@ public class ProxyFactory {
}
/**
- * Creates a new proxy <code>ResultSetMetaData</code> object.
+ * Creates a new proxy {@code ResultSetMetaData} object.
* @param handler The handler that intercepts/overrides method calls.
* @return proxied ResultSetMetaData
*/
@@ -124,7 +124,7 @@ public class ProxyFactory {
}
/**
- * Creates a new proxy <code>Statement</code> object.
+ * Creates a new proxy {@code Statement} object.
* @param handler The handler that intercepts/overrides method calls.
* @return proxied Statement
*/
diff --git a/src/main/java/org/apache/commons/dbutils/QueryLoader.java
b/src/main/java/org/apache/commons/dbutils/QueryLoader.java
index a38e530..dde758a 100644
--- a/src/main/java/org/apache/commons/dbutils/QueryLoader.java
+++ b/src/main/java/org/apache/commons/dbutils/QueryLoader.java
@@ -24,7 +24,7 @@ import java.util.Properties;
import java.util.regex.Pattern;
/**
- * <code>QueryLoader</code> is a registry for sets of queries so
+ * {@code QueryLoader} is a registry for sets of queries so
* that multiple copies of the same queries aren't loaded into memory.
* This implementation loads properties files filled with query name to
* SQL mappings. This class is thread safe.
@@ -66,7 +66,7 @@ public class QueryLoader {
* subsequent request to load queries from the same path will return
* the cached Map. The properties file to load can be in either
* line-oriented or XML format. XML formatted properties files must use a
- * <code>.xml</code> file extension.
+ * {@code .xml} file extension.
*
* @param path The path that the ClassLoader will use to find the file.
* This is <strong>not</strong> a file system path. If you had a jarred
@@ -96,7 +96,7 @@ public class QueryLoader {
* Loads a set of named queries into a Map object. This implementation
* reads a properties file at the given path. The properties file can be
* in either line-oriented or XML format. XML formatted properties files
- * must use a <code>.xml</code> file extension.
+ * must use a {@code .xml} file extension.
* @param path The path that the ClassLoader will use to find the file.
* @throws IOException if a file access error occurs
diff --git a/src/main/java/org/apache/commons/dbutils/QueryRunner.java
b/src/main/java/org/apache/commons/dbutils/QueryRunner.java
index 85bae22..997ff44 100644
--- a/src/main/java/org/apache/commons/dbutils/QueryRunner.java
+++ b/src/main/java/org/apache/commons/dbutils/QueryRunner.java
@@ -28,7 +28,7 @@ import javax.sql.DataSource;
/**
* Executes SQL queries with pluggable strategies for handling
- * <code>ResultSet</code>s. This class is thread safe.
+ * {@code ResultSet}s. This class is thread safe.
*
* @see ResultSetHandler
*/
@@ -42,10 +42,10 @@ public class QueryRunner extends AbstractQueryRunner {
}
/**
- * Constructor for QueryRunner that controls the use of
<code>ParameterMetaData</code>.
+ * Constructor for QueryRunner that controls the use of {@code
ParameterMetaData}.
*
* @param pmdKnownBroken Some drivers don't support {@link
java.sql.ParameterMetaData#getParameterType(int) };
- * if <code>pmdKnownBroken</code> is set to true, we won't even try it; if
false, we'll try it,
+ * 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.
*/
public QueryRunner(final boolean pmdKnownBroken) {
@@ -53,19 +53,19 @@ public class QueryRunner extends AbstractQueryRunner {
}
/**
- * Constructor for QueryRunner that takes a <code>DataSource</code> to use.
+ * Constructor for QueryRunner that takes a {@code DataSource} to use.
*
- * Methods that do not take a <code>Connection</code> parameter will
retrieve connections from this
- * <code>DataSource</code>.
+ * Methods that do not take a {@code Connection} parameter will retrieve
connections from this
+ * {@code DataSource}.
*
- * @param ds The <code>DataSource</code> to retrieve connections from.
+ * @param ds The {@code DataSource} to retrieve connections from.
*/
public QueryRunner(final DataSource ds) {
super(ds);
}
/**
- * Constructor for QueryRunner that takes a
<code>StatementConfiguration</code> to configure statements when
+ * Constructor for QueryRunner that takes a {@code StatementConfiguration}
to configure statements when
* preparing them.
*
* @param stmtConfig The configuration to apply to statements when they
are prepared.
@@ -75,13 +75,13 @@ public class QueryRunner extends AbstractQueryRunner {
}
/**
- * Constructor for QueryRunner that takes a <code>DataSource</code> and
controls the use of <code>ParameterMetaData</code>.
- * Methods that do not take a <code>Connection</code> parameter will
retrieve connections from this
- * <code>DataSource</code>.
+ * Constructor for QueryRunner that takes a {@code DataSource} and
controls the use of {@code ParameterMetaData}.
+ * Methods that do not take a {@code Connection} parameter will retrieve
connections from this
+ * {@code DataSource}.
*
- * @param ds The <code>DataSource</code> to retrieve connections from.
+ * @param ds The {@code DataSource} to retrieve connections from.
* @param pmdKnownBroken Some drivers don't support {@link
java.sql.ParameterMetaData#getParameterType(int) };
- * if <code>pmdKnownBroken</code> is set to true, we won't even try it; if
false, we'll try it,
+ * 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.
*/
public QueryRunner(final DataSource ds, final boolean pmdKnownBroken) {
@@ -89,12 +89,12 @@ public class QueryRunner extends AbstractQueryRunner {
}
/**
- * Constructor for QueryRunner that takes a <code>DataSource</code> to use
and a <code>StatementConfiguration</code>.
+ * Constructor for QueryRunner that takes a {@code DataSource} to use and
a {@code StatementConfiguration}.
*
- * Methods that do not take a <code>Connection</code> parameter will
retrieve connections from this
- * <code>DataSource</code>.
+ * Methods that do not take a {@code Connection} parameter will retrieve
connections from this
+ * {@code DataSource}.
*
- * @param ds The <code>DataSource</code> to retrieve connections from.
+ * @param ds The {@code DataSource} to retrieve connections from.
* @param stmtConfig The configuration to apply to statements when they
are prepared.
*/
public QueryRunner(final DataSource ds, final StatementConfiguration
stmtConfig) {
@@ -102,13 +102,13 @@ public class QueryRunner extends AbstractQueryRunner {
}
/**
- * Constructor for QueryRunner that takes a <code>DataSource</code>, a
<code>StatementConfiguration</code>, and
- * controls the use of <code>ParameterMetaData</code>. Methods that do
not take a <code>Connection</code> parameter
- * will retrieve connections from this <code>DataSource</code>.
+ * Constructor for QueryRunner that takes a {@code DataSource}, a {@code
StatementConfiguration}, and
+ * controls the use of {@code ParameterMetaData}. Methods that do not
take a {@code Connection} parameter
+ * will retrieve connections from this {@code DataSource}.
*
- * @param ds The <code>DataSource</code> to retrieve connections from.
+ * @param ds The {@code DataSource} to retrieve connections from.
* @param pmdKnownBroken Some drivers don't support {@link
java.sql.ParameterMetaData#getParameterType(int) };
- * if <code>pmdKnownBroken</code> is set to true, we won't even try it; if
false, we'll try it,
+ * 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 stmtConfig The configuration to apply to statements when they
are prepared.
*/
@@ -134,8 +134,8 @@ public class QueryRunner extends AbstractQueryRunner {
/**
* Execute a batch of SQL INSERT, UPDATE, or DELETE queries. The
- * <code>Connection</code> is retrieved from the <code>DataSource</code>
- * set in the constructor. This <code>Connection</code> must be in
+ * {@code Connection} is retrieved from the {@code DataSource}
+ * set in the constructor. This {@code Connection} must be in
* auto-commit mode or the update will not be saved.
*
* @param sql The SQL to execute.
@@ -268,13 +268,13 @@ public class QueryRunner extends AbstractQueryRunner {
/**
* Executes the given SELECT SQL with a single replacement parameter.
- * The <code>Connection</code> is retrieved from the
- * <code>DataSource</code> set in the constructor.
+ * The {@code Connection} is retrieved from the
+ * {@code DataSource} set in the constructor.
* @param <T> The type of object that the handler returns
* @param sql The SQL statement to execute.
* @param param The replacement parameter.
* @param rsh The handler used to create the result object from
- * the <code>ResultSet</code>.
+ * the {@code ResultSet}.
*
* @return An object generated by the handler.
* @throws SQLException if a database access error occurs
@@ -289,15 +289,15 @@ public class QueryRunner extends AbstractQueryRunner {
/**
* Executes the given SELECT SQL query and returns a result object.
- * The <code>Connection</code> is retrieved from the
- * <code>DataSource</code> set in the constructor.
+ * The {@code Connection} is retrieved from the
+ * {@code DataSource} set in the constructor.
* @param <T> The type of object that the handler returns
* @param sql The SQL statement to execute.
* @param params Initialize the PreparedStatement's IN parameters with
* this array.
*
* @param rsh The handler used to create the result object from
- * the <code>ResultSet</code>.
+ * the {@code ResultSet}.
*
* @return An object generated by the handler.
* @throws SQLException if a database access error occurs
@@ -312,12 +312,12 @@ public class QueryRunner extends AbstractQueryRunner {
/**
* Executes the given SELECT SQL query and returns a result object.
- * The <code>Connection</code> is retrieved from the
- * <code>DataSource</code> set in the constructor.
+ * The {@code Connection} is retrieved from the
+ * {@code DataSource} set in the constructor.
* @param <T> The type of object that the handler returns
* @param sql The SQL statement to execute.
* @param rsh The handler used to create the result object from
- * the <code>ResultSet</code>.
+ * the {@code ResultSet}.
* @param params Initialize the PreparedStatement's IN parameters with
* this array.
* @return An object generated by the handler.
@@ -331,12 +331,12 @@ public class QueryRunner extends AbstractQueryRunner {
/**
* Executes the given SELECT SQL without any replacement parameters.
- * The <code>Connection</code> is retrieved from the
- * <code>DataSource</code> set in the constructor.
+ * The {@code Connection} is retrieved from the
+ * {@code DataSource} set in the constructor.
* @param <T> The type of object that the handler returns
* @param sql The SQL statement to execute.
* @param rsh The handler used to create the result object from
- * the <code>ResultSet</code>.
+ * the {@code ResultSet}.
*
* @return An object generated by the handler.
* @throws SQLException if a database access error occurs
@@ -443,9 +443,9 @@ public class QueryRunner extends AbstractQueryRunner {
/**
* Executes the given INSERT, UPDATE, or DELETE SQL statement without
- * any replacement parameters. The <code>Connection</code> is retrieved
- * from the <code>DataSource</code> set in the constructor. This
- * <code>Connection</code> must be in auto-commit mode or the update will
+ * any replacement parameters. The {@code Connection} is retrieved
+ * from the {@code DataSource} set in the constructor. This
+ * {@code Connection} must be in auto-commit mode or the update will
* not be saved.
*
* @param sql The SQL statement to execute.
@@ -460,9 +460,9 @@ public class QueryRunner extends AbstractQueryRunner {
/**
* Executes the given INSERT, UPDATE, or DELETE SQL statement with
- * a single replacement parameter. The <code>Connection</code> is
- * retrieved from the <code>DataSource</code> set in the constructor.
- * This <code>Connection</code> must be in auto-commit mode or the
+ * a single replacement parameter. The {@code Connection} is
+ * retrieved from the {@code DataSource} set in the constructor.
+ * This {@code Connection} must be in auto-commit mode or the
* update will not be saved.
*
* @param sql The SQL statement to execute.
@@ -478,8 +478,8 @@ public class QueryRunner extends AbstractQueryRunner {
/**
* Executes the given INSERT, UPDATE, or DELETE SQL statement. The
- * <code>Connection</code> is retrieved from the <code>DataSource</code>
- * set in the constructor. This <code>Connection</code> must be in
+ * {@code Connection} is retrieved from the {@code DataSource}
+ * set in the constructor. This {@code Connection} must be in
* auto-commit mode or the update will not be saved.
*
* @param sql The SQL statement to execute.
@@ -539,12 +539,12 @@ public class QueryRunner extends AbstractQueryRunner {
/**
* Executes the given INSERT SQL without any replacement parameters.
- * The <code>Connection</code> is retrieved from the
- * <code>DataSource</code> set in the constructor.
+ * The {@code Connection} is retrieved from the
+ * {@code DataSource} set in the constructor.
* @param <T> The type of object that the handler returns
* @param sql The SQL statement to execute.
* @param rsh The handler used to create the result object from
- * the <code>ResultSet</code> of auto-generated keys.
+ * the {@code ResultSet} of auto-generated keys.
* @return An object generated by the handler.
* @throws SQLException if a database access error occurs
* @since 1.6
@@ -555,13 +555,13 @@ public class QueryRunner extends AbstractQueryRunner {
/**
* Executes the given INSERT SQL statement. The
- * <code>Connection</code> is retrieved from the <code>DataSource</code>
- * set in the constructor. This <code>Connection</code> must be in
+ * {@code Connection} is retrieved from the {@code DataSource}
+ * set in the constructor. This {@code Connection} must be in
* auto-commit mode or the insert will not be saved.
* @param <T> The type of object that the handler returns
* @param sql The SQL statement to execute.
* @param rsh The handler used to create the result object from
- * the <code>ResultSet</code> of auto-generated keys.
+ * the {@code ResultSet} of auto-generated keys.
* @param params Initializes the PreparedStatement's IN (i.e. '?')
* @return An object generated by the handler.
* @throws SQLException if a database access error occurs
@@ -577,7 +577,7 @@ public class QueryRunner extends AbstractQueryRunner {
* @param conn The connection to use to run the query.
* @param sql The SQL to execute.
* @param rsh The handler used to create the result object from
- * the <code>ResultSet</code> of auto-generated keys.
+ * the {@code ResultSet} of auto-generated keys.
* @return An object generated by the handler.
* @throws SQLException if a database access error occurs
* @since 1.6
@@ -592,7 +592,7 @@ public class QueryRunner extends AbstractQueryRunner {
* @param conn The connection to use to run the query.
* @param sql The SQL to execute.
* @param rsh The handler used to create the result object from
- * the <code>ResultSet</code> of auto-generated keys.
+ * the {@code ResultSet} of auto-generated keys.
* @param params The query replacement parameters.
* @return An object generated by the handler.
* @throws SQLException if a database access error occurs
@@ -608,7 +608,7 @@ public class QueryRunner extends AbstractQueryRunner {
* @param closeConn True if the connection should be closed, false
otherwise.
* @param sql The SQL statement to execute.
* @param rsh The handler used to create the result object from
- * the <code>ResultSet</code> of auto-generated keys.
+ * the {@code ResultSet} of auto-generated keys.
* @param params The query replacement parameters.
* @return An object generated by the handler.
* @throws SQLException If there are database or parameter errors.
@@ -657,13 +657,13 @@ public class QueryRunner extends AbstractQueryRunner {
/**
* Executes the given batch of INSERT SQL statements. The
- * <code>Connection</code> is retrieved from the <code>DataSource</code>
- * set in the constructor. This <code>Connection</code> must be in
+ * {@code Connection} is retrieved from the {@code DataSource}
+ * set in the constructor. This {@code Connection} must be in
* auto-commit mode or the insert will not be saved.
* @param <T> The type of object that the handler returns
* @param sql The SQL statement to execute.
* @param rsh The handler used to create the result object from
- * the <code>ResultSet</code> of auto-generated keys.
+ * the {@code ResultSet} of auto-generated keys.
* @param params Initializes the PreparedStatement's IN (i.e. '?')
* @return The result generated by the handler.
* @throws SQLException if a database access error occurs
@@ -679,7 +679,7 @@ public class QueryRunner extends AbstractQueryRunner {
* @param conn The connection to use to run the query.
* @param sql The SQL to execute.
* @param rsh The handler used to create the result object from
- * the <code>ResultSet</code> of auto-generated keys.
+ * the {@code ResultSet} of auto-generated keys.
* @param params The query replacement parameters.
* @return The result generated by the handler.
* @throws SQLException if a database access error occurs
@@ -695,7 +695,7 @@ public class QueryRunner extends AbstractQueryRunner {
* @param closeConn True if the connection should be closed, false
otherwise.
* @param sql The SQL statement to execute.
* @param rsh The handler used to create the result object from
- * the <code>ResultSet</code> of auto-generated keys.
+ * the {@code ResultSet} of auto-generated keys.
* @param params The query replacement parameters.
* @return The result generated by the handler.
* @throws SQLException If there are database or parameter errors.
@@ -782,8 +782,8 @@ public class QueryRunner extends AbstractQueryRunner {
* If the stored procedure returns result sets, use
* {@link #execute(java.lang.String,
org.apache.commons.dbutils.ResultSetHandler, java.lang.Object...) }.
* <p>
- * The <code>Connection</code> is retrieved from the
<code>DataSource</code>
- * set in the constructor. This <code>Connection</code> must be in
+ * The {@code Connection} is retrieved from the {@code DataSource}
+ * set in the constructor. This {@code Connection} must be in
* auto-commit mode or the update will not be saved.
*
* @param sql The SQL statement to execute.
@@ -964,8 +964,8 @@ public class QueryRunner extends AbstractQueryRunner {
/**
* Set the value on all the {@link OutParameter} instances in the
- * <code>params</code> array using the OUT parameter values from the
- * <code>stmt</code>.
+ * {@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
* @throws SQLException when the value could not be retrieved from the
diff --git a/src/main/java/org/apache/commons/dbutils/ResultSetHandler.java
b/src/main/java/org/apache/commons/dbutils/ResultSetHandler.java
index d1a7b4c..17dcd39 100644
--- a/src/main/java/org/apache/commons/dbutils/ResultSetHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/ResultSetHandler.java
@@ -27,14 +27,14 @@ import java.sql.SQLException;
public interface ResultSetHandler<T> {
/**
- * Turn the <code>ResultSet</code> into an Object.
+ * Turn the {@code ResultSet} into an Object.
*
- * @param rs The <code>ResultSet</code> to handle. It has not been touched
+ * @param rs The {@code ResultSet} to handle. It has not been touched
* before being passed to this method.
*
- * @return An Object initialized with <code>ResultSet</code> data. It is
- * legal for implementations to return <code>null</code> if the
- * <code>ResultSet</code> contained 0 rows.
+ * @return An Object initialized with {@code ResultSet} data. It is
+ * legal for implementations to return {@code null} if the
+ * {@code ResultSet} contained 0 rows.
*
* @throws SQLException if a database access error occurs
*/
diff --git a/src/main/java/org/apache/commons/dbutils/ResultSetIterator.java
b/src/main/java/org/apache/commons/dbutils/ResultSetIterator.java
index 025a2dd..b96f39e 100644
--- a/src/main/java/org/apache/commons/dbutils/ResultSetIterator.java
+++ b/src/main/java/org/apache/commons/dbutils/ResultSetIterator.java
@@ -22,20 +22,20 @@ import java.util.Iterator;
/**
* <p>
- * Wraps a <code>ResultSet</code> in an <code>Iterator<Object[]></code>.
This is useful
+ * Wraps a {@code ResultSet} in an {@code Iterator<Object[]>}. This is
useful
* when you want to present a non-database application layer with domain
* neutral data.
* </p>
*
* <p>
- * This implementation requires the <code>ResultSet.isLast()</code> method
+ * This implementation requires the {@code ResultSet.isLast()} method
* to be implemented.
* </p>
*/
public class ResultSetIterator implements Iterator<Object[]> {
/**
- * The wrapped <code>ResultSet</code>.
+ * The wrapped {@code ResultSet}.
*/
private final ResultSet rs;
@@ -46,7 +46,7 @@ public class ResultSetIterator implements Iterator<Object[]> {
/**
* Constructor for ResultSetIterator.
- * @param rs Wrap this <code>ResultSet</code> in an <code>Iterator</code>.
+ * @param rs Wrap this {@code ResultSet} in an {@code Iterator}.
*/
public ResultSetIterator(final ResultSet rs) {
this(rs, new BasicRowProcessor());
@@ -54,10 +54,10 @@ public class ResultSetIterator implements
Iterator<Object[]> {
/**
* Constructor for ResultSetIterator.
- * @param rs Wrap this <code>ResultSet</code> in an <code>Iterator</code>.
+ * @param rs Wrap this {@code ResultSet} in an {@code Iterator}.
* @param convert The processor to use when converting a row into an
- * <code>Object[]</code>. Defaults to a
- * <code>BasicRowProcessor</code>.
+ * {@code Object[]}. Defaults to a
+ * {@code BasicRowProcessor}.
*/
public ResultSetIterator(final ResultSet rs, final RowProcessor convert) {
this.rs = rs;
@@ -66,7 +66,7 @@ public class ResultSetIterator implements Iterator<Object[]> {
/**
* Returns true if there are more rows in the ResultSet.
- * @return boolean <code>true</code> if there are more rows
+ * @return boolean {@code true} if there are more rows
* @throws RuntimeException if an SQLException occurs.
*/
@Override
@@ -80,9 +80,9 @@ public class ResultSetIterator implements Iterator<Object[]> {
}
/**
- * Returns the next row as an <code>Object[]</code>.
- * @return An <code>Object[]</code> with the same number of elements as
- * columns in the <code>ResultSet</code>.
+ * Returns the next row as an {@code Object[]}.
+ * @return An {@code Object[]} with the same number of elements as
+ * columns in the {@code ResultSet}.
* @see java.util.Iterator#next()
* @throws RuntimeException if an SQLException occurs.
*/
@@ -98,7 +98,7 @@ public class ResultSetIterator implements Iterator<Object[]> {
}
/**
- * Deletes the current row from the <code>ResultSet</code>.
+ * Deletes the current row from the {@code ResultSet}.
* @see java.util.Iterator#remove()
* @throws RuntimeException if an SQLException occurs.
*/
@@ -122,10 +122,10 @@ public class ResultSetIterator implements
Iterator<Object[]> {
}
/**
- * Generates an <code>Iterable</code>, suitable for use in for-each loops.
+ * Generates an {@code Iterable}, suitable for use in for-each loops.
*
- * @param rs Wrap this <code>ResultSet</code> in an <code>Iterator</code>.
- * @return an <code>Iterable</code>, suitable for use in for-each loops.
+ * @param rs Wrap this {@code ResultSet} in an {@code Iterator}.
+ * @return an {@code Iterable}, suitable for use in for-each loops.
*/
public static Iterable<Object[]> iterable(final ResultSet rs) {
return new Iterable<Object[]>() {
diff --git a/src/main/java/org/apache/commons/dbutils/RowProcessor.java
b/src/main/java/org/apache/commons/dbutils/RowProcessor.java
index 2434dc4..201f3e7 100644
--- a/src/main/java/org/apache/commons/dbutils/RowProcessor.java
+++ b/src/main/java/org/apache/commons/dbutils/RowProcessor.java
@@ -22,9 +22,9 @@ import java.util.List;
import java.util.Map;
/**
- * <code>RowProcessor</code> implementations convert
- * <code>ResultSet</code> rows into various other objects. Implementations
- * can extend <code>BasicRowProcessor</code> to protect themselves
+ * {@code RowProcessor} implementations convert
+ * {@code ResultSet} rows into various other objects. Implementations
+ * can extend {@code BasicRowProcessor} to protect themselves
* from changes to this interface.
*
* @see BasicRowProcessor
@@ -32,11 +32,11 @@ import java.util.Map;
public interface RowProcessor {
/**
- * Create an <code>Object[]</code> from the column values in one
- * <code>ResultSet</code> row. The <code>ResultSet</code> should be
+ * Create an {@code Object[]} from the column values in one
+ * {@code ResultSet} row. The {@code ResultSet} should be
* positioned on a valid row before passing it to this method.
* Implementations of this method must not alter the row position of
- * the <code>ResultSet</code>.
+ * the {@code ResultSet}.
*
* @param rs ResultSet that supplies the array data
* @throws SQLException if a database access error occurs
@@ -45,10 +45,10 @@ public interface RowProcessor {
Object[] toArray(ResultSet rs) throws SQLException;
/**
- * Create a JavaBean from the column values in one <code>ResultSet</code>
- * row. The <code>ResultSet</code> should be positioned on a valid row
before
+ * Create a JavaBean from the column values in one {@code ResultSet}
+ * row. The {@code ResultSet} should be positioned on a valid row before
* passing it to this method. Implementations of this method must not
- * alter the row position of the <code>ResultSet</code>.
+ * alter the row position of the {@code ResultSet}.
* @param <T> The type of bean to create
* @param rs ResultSet that supplies the bean data
* @param type Class from which to create the bean instance
@@ -58,24 +58,24 @@ public interface RowProcessor {
<T> T toBean(ResultSet rs, Class<? extends T> type) throws SQLException;
/**
- * Create a <code>List</code> of JavaBeans from the column values in all
- * <code>ResultSet</code> rows. <code>ResultSet.next()</code> should
+ * Create a {@code List} of JavaBeans from the column values in all
+ * {@code ResultSet} rows. {@code ResultSet.next()} should
* <strong>not</strong> be called before passing it to this method.
* @param <T> The type of bean to create
* @param rs ResultSet that supplies the bean data
* @param type Class from which to create the bean instance
* @throws SQLException if a database access error occurs
- * @return A <code>List</code> of beans with the given type in the order
- * they were returned by the <code>ResultSet</code>.
+ * @return A {@code List} of beans with the given type in the order
+ * they were returned by the {@code ResultSet}.
*/
<T> List<T> toBeanList(ResultSet rs, Class<? extends T> type) throws
SQLException;
/**
- * Create a <code>Map</code> from the column values in one
- * <code>ResultSet</code> row. The <code>ResultSet</code> should be
+ * Create a {@code Map} from the column values in one
+ * {@code ResultSet} row. The {@code ResultSet} should be
* positioned on a valid row before
* passing it to this method. Implementations of this method must not
- * alter the row position of the <code>ResultSet</code>.
+ * alter the row position of the {@code ResultSet}.
*
* @param rs ResultSet that supplies the map data
* @throws SQLException if a database access error occurs
diff --git
a/src/main/java/org/apache/commons/dbutils/StatementConfiguration.java
b/src/main/java/org/apache/commons/dbutils/StatementConfiguration.java
index e916b8b..be89c58 100644
--- a/src/main/java/org/apache/commons/dbutils/StatementConfiguration.java
+++ b/src/main/java/org/apache/commons/dbutils/StatementConfiguration.java
@@ -17,7 +17,7 @@
package org.apache.commons.dbutils;
/**
- * Configuration options for a {@link java.sql.Statement} when preparing
statements in <code>QueryRunner</code>.
+ * Configuration options for a {@link java.sql.Statement} when preparing
statements in {@code QueryRunner}.
*/
public class StatementConfiguration {
private final Integer fetchDirection;
@@ -27,12 +27,12 @@ public class StatementConfiguration {
private final Integer queryTimeout;
/**
- * Constructor for <code>StatementConfiguration</code>. For more
flexibility, use {@link Builder}.
+ * Constructor for {@code StatementConfiguration}. For more flexibility,
use {@link Builder}.
*
* @param fetchDirection The direction for fetching rows from database
tables.
* @param fetchSize The number of rows that should be fetched from the
database when more rows are needed.
* @param maxFieldSize The maximum number of bytes that can be returned
for character and binary column values.
- * @param maxRows The maximum number of rows that a <code>ResultSet</code>
can produce.
+ * @param maxRows The maximum number of rows that a {@code ResultSet} can
produce.
* @param queryTimeout The number of seconds the driver will wait for
execution.
*/
public StatementConfiguration(final Integer fetchDirection, final Integer
fetchSize, final Integer maxFieldSize, final Integer maxRows,
@@ -135,7 +135,7 @@ public class StatementConfiguration {
}
/**
- * Builder class for <code>StatementConfiguration</code> for more flexible
construction.
+ * Builder class for {@code StatementConfiguration} for more flexible
construction.
*/
public static final class Builder {
private Integer fetchDirection;
diff --git
a/src/main/java/org/apache/commons/dbutils/handlers/AbstractKeyedHandler.java
b/src/main/java/org/apache/commons/dbutils/handlers/AbstractKeyedHandler.java
index d694f30..0432bb1 100644
---
a/src/main/java/org/apache/commons/dbutils/handlers/AbstractKeyedHandler.java
+++
b/src/main/java/org/apache/commons/dbutils/handlers/AbstractKeyedHandler.java
@@ -25,8 +25,8 @@ import org.apache.commons.dbutils.ResultSetHandler;
/**
* <p>
- * <code>ResultSetHandler</code> implementation that returns a Map.
- * <code>ResultSet</code> rows are converted into objects (Vs) which are then
stored
+ * {@code ResultSetHandler} implementation that returns a Map.
+ * {@code ResultSet} rows are converted into objects (Vs) which are then stored
* in a Map under the given keys (Ks).
* </p>
*
@@ -40,9 +40,9 @@ public abstract class AbstractKeyedHandler<K, V> implements
ResultSetHandler<Map
/**
* Convert each row's columns into a Map and store then
- * in a <code>Map</code> under <code>ResultSet.getObject(key)</code> key.
- * @param rs <code>ResultSet</code> to process.
- * @return A <code>Map</code>, never <code>null</code>.
+ * in a {@code Map} under {@code ResultSet.getObject(key)} key.
+ * @param rs {@code ResultSet} to process.
+ * @return A {@code Map}, never {@code null}.
* @throws SQLException if a database access error occurs
* @see
org.apache.commons.dbutils.ResultSetHandler#handle(java.sql.ResultSet)
*/
@@ -56,8 +56,8 @@ public abstract class AbstractKeyedHandler<K, V> implements
ResultSetHandler<Map
}
/**
- * This factory method is called by <code>handle()</code> to create the Map
- * to store records in. This implementation returns a <code>HashMap</code>
+ * This factory method is called by {@code handle()} to create the Map
+ * to store records in. This implementation returns a {@code HashMap}
* instance.
*
* @return Map to store records in
@@ -67,8 +67,8 @@ public abstract class AbstractKeyedHandler<K, V> implements
ResultSetHandler<Map
}
/**
- * This factory method is called by <code>handle()</code> to retrieve the
- * key value from the current <code>ResultSet</code> row.
+ * This factory method is called by {@code handle()} to retrieve the
+ * key value from the current {@code ResultSet} row.
* @param rs ResultSet to create a key from
* @return K from the configured key column name/index
* @throws SQLException if a database access error occurs
@@ -76,8 +76,8 @@ public abstract class AbstractKeyedHandler<K, V> implements
ResultSetHandler<Map
protected abstract K createKey(ResultSet rs) throws SQLException;
/**
- * This factory method is called by <code>handle()</code> to store the
- * current <code>ResultSet</code> row in some object.
+ * This factory method is called by {@code handle()} to store the
+ * current {@code ResultSet} row in some object.
* @param rs ResultSet to create a row from
* @return V object created from the current row
* @throws SQLException if a database access error occurs
diff --git
a/src/main/java/org/apache/commons/dbutils/handlers/AbstractListHandler.java
b/src/main/java/org/apache/commons/dbutils/handlers/AbstractListHandler.java
index 6db0bb8..30a1e86 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/AbstractListHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/AbstractListHandler.java
@@ -24,20 +24,20 @@ import java.util.List;
import org.apache.commons.dbutils.ResultSetHandler;
/**
- * Abstract class that simplify development of <code>ResultSetHandler</code>
- * classes that convert <code>ResultSet</code> into <code>List</code>.
+ * Abstract class that simplify development of {@code ResultSetHandler}
+ * classes that convert {@code ResultSet} into {@code List}.
*
* @param <T> the target List generic type
* @see org.apache.commons.dbutils.ResultSetHandler
*/
public abstract class AbstractListHandler<T> implements
ResultSetHandler<List<T>> {
/**
- * Whole <code>ResultSet</code> handler. It produce <code>List</code> as
+ * Whole {@code ResultSet} handler. It produce {@code List} as
* result. To convert individual rows into Java objects it uses
- * <code>handleRow(ResultSet)</code> method.
+ * {@code handleRow(ResultSet)} method.
*
* @see #handleRow(ResultSet)
- * @param rs <code>ResultSet</code> to process.
+ * @param rs {@code ResultSet} to process.
* @return a list of all rows in the result set
* @throws SQLException error occurs
*/
@@ -53,7 +53,7 @@ public abstract class AbstractListHandler<T> implements
ResultSetHandler<List<T>
/**
* Row handler. Method converts current row into some Java object.
*
- * @param rs <code>ResultSet</code> to process.
+ * @param rs {@code ResultSet} to process.
* @return row processing result
* @throws SQLException error occurs
*/
diff --git
a/src/main/java/org/apache/commons/dbutils/handlers/ArrayHandler.java
b/src/main/java/org/apache/commons/dbutils/handlers/ArrayHandler.java
index 4344c42..17ec084 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/ArrayHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/ArrayHandler.java
@@ -24,8 +24,8 @@ import org.apache.commons.dbutils.ResultSetHandler;
import org.apache.commons.dbutils.RowProcessor;
/**
- * <code>ResultSetHandler</code> implementation that converts a
- * <code>ResultSet</code> into an <code>Object[]</code>. This class is
+ * {@code ResultSetHandler} implementation that converts a
+ * {@code ResultSet} into an {@code Object[]}. This class is
* thread safe.
*
* @see org.apache.commons.dbutils.ResultSetHandler
@@ -52,7 +52,7 @@ public class ArrayHandler implements
ResultSetHandler<Object[]> {
/**
* Creates a new instance of ArrayHandler using a
- * <code>BasicRowProcessor</code> for conversion.
+ * {@code BasicRowProcessor} for conversion.
*/
public ArrayHandler() {
this(ROW_PROCESSOR);
@@ -61,7 +61,7 @@ public class ArrayHandler implements
ResultSetHandler<Object[]> {
/**
* Creates a new instance of ArrayHandler.
*
- * @param convert The <code>RowProcessor</code> implementation
+ * @param convert The {@code RowProcessor} implementation
* to use when converting rows into arrays.
*/
public ArrayHandler(final RowProcessor convert) {
@@ -70,9 +70,9 @@ public class ArrayHandler implements
ResultSetHandler<Object[]> {
}
/**
- * Places the column values from the first row in an <code>Object[]</code>.
- * @param rs <code>ResultSet</code> to process.
- * @return An Object[]. If there are no rows in the <code>ResultSet</code>
+ * Places the column values from the first row in an {@code Object[]}.
+ * @param rs {@code ResultSet} to process.
+ * @return An Object[]. If there are no rows in the {@code ResultSet}
* an empty array will be returned.
*
* @throws SQLException if a database access error occurs
diff --git
a/src/main/java/org/apache/commons/dbutils/handlers/ArrayListHandler.java
b/src/main/java/org/apache/commons/dbutils/handlers/ArrayListHandler.java
index 9527f3b..a817bdb 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/ArrayListHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/ArrayListHandler.java
@@ -22,8 +22,8 @@ import java.sql.SQLException;
import org.apache.commons.dbutils.RowProcessor;
/**
- * <code>ResultSetHandler</code> implementation that converts the
- * <code>ResultSet</code> into a <code>List</code> of <code>Object[]</code>s.
+ * {@code ResultSetHandler} implementation that converts the
+ * {@code ResultSet} into a {@code List} of {@code Object[]}s.
* This class is thread safe.
*
* @see org.apache.commons.dbutils.ResultSetHandler
@@ -38,7 +38,7 @@ public class ArrayListHandler extends
AbstractListHandler<Object[]> {
/**
* Creates a new instance of ArrayListHandler using a
- * <code>BasicRowProcessor</code> for conversions.
+ * {@code BasicRowProcessor} for conversions.
*/
public ArrayListHandler() {
this(ArrayHandler.ROW_PROCESSOR);
@@ -47,7 +47,7 @@ public class ArrayListHandler extends
AbstractListHandler<Object[]> {
/**
* Creates a new instance of ArrayListHandler.
*
- * @param convert The <code>RowProcessor</code> implementation
+ * @param convert The {@code RowProcessor} implementation
* to use when converting rows into Object[]s.
*/
public ArrayListHandler(final RowProcessor convert) {
@@ -57,9 +57,9 @@ public class ArrayListHandler extends
AbstractListHandler<Object[]> {
/**
- * Convert row's columns into an <code>Object[]</code>.
- * @param rs <code>ResultSet</code> to process.
- * @return <code>Object[]</code>, never <code>null</code>.
+ * Convert row's columns into an {@code Object[]}.
+ * @param rs {@code ResultSet} to process.
+ * @return {@code Object[]}, never {@code null}.
*
* @throws SQLException if a database access error occurs
* @see
org.apache.commons.dbutils.handlers.AbstractListHandler#handle(ResultSet)
diff --git a/src/main/java/org/apache/commons/dbutils/handlers/BeanHandler.java
b/src/main/java/org/apache/commons/dbutils/handlers/BeanHandler.java
index 09758df..d1c0415 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/BeanHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/BeanHandler.java
@@ -23,8 +23,8 @@ import org.apache.commons.dbutils.ResultSetHandler;
import org.apache.commons.dbutils.RowProcessor;
/**
- * <code>ResultSetHandler</code> implementation that converts the first
- * <code>ResultSet</code> row into a JavaBean. This class is thread safe.
+ * {@code ResultSetHandler} implementation that converts the first
+ * {@code ResultSet} row into a JavaBean. This class is thread safe.
*
* @param <T> the target bean type
* @see org.apache.commons.dbutils.ResultSetHandler
@@ -45,7 +45,7 @@ public class BeanHandler<T> implements ResultSetHandler<T> {
/**
* Creates a new instance of BeanHandler.
*
- * @param type The Class that objects returned from <code>handle()</code>
+ * @param type The Class that objects returned from {@code handle()}
* are created from.
*/
public BeanHandler(final Class<? extends T> type) {
@@ -55,9 +55,9 @@ public class BeanHandler<T> implements ResultSetHandler<T> {
/**
* Creates a new instance of BeanHandler.
*
- * @param type The Class that objects returned from <code>handle()</code>
+ * @param type The Class that objects returned from {@code handle()}
* are created from.
- * @param convert The <code>RowProcessor</code> implementation
+ * @param convert The {@code RowProcessor} implementation
* to use when converting rows into beans.
*/
public BeanHandler(final Class<? extends T> type, final RowProcessor
convert) {
@@ -66,11 +66,11 @@ public class BeanHandler<T> implements ResultSetHandler<T> {
}
/**
- * Convert the first row of the <code>ResultSet</code> into a bean with the
- * <code>Class</code> given in the constructor.
- * @param rs <code>ResultSet</code> to process.
- * @return An initialized JavaBean or <code>null</code> if there were no
- * rows in the <code>ResultSet</code>.
+ * Convert the first row of the {@code ResultSet} into a bean with the
+ * {@code Class} given in the constructor.
+ * @param rs {@code ResultSet} to process.
+ * @return An initialized JavaBean or {@code null} if there were no
+ * rows in the {@code ResultSet}.
*
* @throws SQLException if a database access error occurs
* @see
org.apache.commons.dbutils.ResultSetHandler#handle(java.sql.ResultSet)
diff --git
a/src/main/java/org/apache/commons/dbutils/handlers/BeanListHandler.java
b/src/main/java/org/apache/commons/dbutils/handlers/BeanListHandler.java
index cee50fd..9044a6c 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/BeanListHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/BeanListHandler.java
@@ -24,8 +24,8 @@ import org.apache.commons.dbutils.ResultSetHandler;
import org.apache.commons.dbutils.RowProcessor;
/**
- * <code>ResultSetHandler</code> implementation that converts a
- * <code>ResultSet</code> into a <code>List</code> of beans. This class is
+ * {@code ResultSetHandler} implementation that converts a
+ * {@code ResultSet} into a {@code List} of beans. This class is
* thread safe.
*
* @param <T> the target bean type
@@ -47,7 +47,7 @@ public class BeanListHandler<T> implements
ResultSetHandler<List<T>> {
/**
* Creates a new instance of BeanListHandler.
*
- * @param type The Class that objects returned from <code>handle()</code>
+ * @param type The Class that objects returned from {@code handle()}
* are created from.
*/
public BeanListHandler(final Class<? extends T> type) {
@@ -57,9 +57,9 @@ public class BeanListHandler<T> implements
ResultSetHandler<List<T>> {
/**
* Creates a new instance of BeanListHandler.
*
- * @param type The Class that objects returned from <code>handle()</code>
+ * @param type The Class that objects returned from {@code handle()}
* are created from.
- * @param convert The <code>RowProcessor</code> implementation
+ * @param convert The {@code RowProcessor} implementation
* to use when converting rows into beans.
*/
public BeanListHandler(final Class<? extends T> type, final RowProcessor
convert) {
@@ -68,12 +68,12 @@ public class BeanListHandler<T> implements
ResultSetHandler<List<T>> {
}
/**
- * Convert the whole <code>ResultSet</code> into a List of beans with
- * the <code>Class</code> given in the constructor.
+ * Convert the whole {@code ResultSet} into a List of beans with
+ * the {@code Class} given in the constructor.
*
- * @param rs The <code>ResultSet</code> to handle.
+ * @param rs The {@code ResultSet} to handle.
*
- * @return A List of beans, never <code>null</code>.
+ * @return A List of beans, never {@code null}.
*
* @throws SQLException if a database access error occurs
* @see org.apache.commons.dbutils.RowProcessor#toBeanList(ResultSet,
Class)
diff --git
a/src/main/java/org/apache/commons/dbutils/handlers/BeanMapHandler.java
b/src/main/java/org/apache/commons/dbutils/handlers/BeanMapHandler.java
index e9af0d0..7dbdf36 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/BeanMapHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/BeanMapHandler.java
@@ -23,8 +23,8 @@ import org.apache.commons.dbutils.RowProcessor;
/**
* <p>
- * <code>ResultSetHandler</code> implementation that returns a Map of Beans.
- * <code>ResultSet</code> rows are converted into Beans which are then stored
in
+ * {@code ResultSetHandler} implementation that returns a Map of Beans.
+ * {@code ResultSet} rows are converted into Beans which are then stored in
* a Map under the given key.
* </p>
* <p>
@@ -83,7 +83,7 @@ public class BeanMapHandler<K, V> extends
AbstractKeyedHandler<K, V> {
* of each row will be a key in the Map.
*
* @param type
- * The Class that objects returned from <code>createRow()</code>
+ * The Class that objects returned from {@code createRow()}
* are created from.
*/
public BeanMapHandler(final Class<V> type) {
@@ -95,10 +95,10 @@ public class BeanMapHandler<K, V> extends
AbstractKeyedHandler<K, V> {
* of each row will be a key in the Map.
*
* @param type
- * The Class that objects returned from <code>createRow()</code>
+ * The Class that objects returned from {@code createRow()}
* are created from.
* @param convert
- * The <code>RowProcessor</code> implementation to use when
+ * The {@code RowProcessor} implementation to use when
* converting rows into Beans
*/
public BeanMapHandler(final Class<V> type, final RowProcessor convert) {
@@ -109,7 +109,7 @@ public class BeanMapHandler<K, V> extends
AbstractKeyedHandler<K, V> {
* Creates a new instance of BeanMapHandler.
*
* @param type
- * The Class that objects returned from <code>createRow()</code>
+ * The Class that objects returned from {@code createRow()}
* are created from.
* @param columnIndex
* The values to use as keys in the Map are retrieved from the
@@ -123,7 +123,7 @@ public class BeanMapHandler<K, V> extends
AbstractKeyedHandler<K, V> {
* Creates a new instance of BeanMapHandler.
*
* @param type
- * The Class that objects returned from <code>createRow()</code>
+ * The Class that objects returned from {@code createRow()}
* are created from.
* @param columnName
* The values to use as keys in the Map are retrieved from the
@@ -137,7 +137,7 @@ public class BeanMapHandler<K, V> extends
AbstractKeyedHandler<K, V> {
* Private Helper
*
* @param convert
- * The <code>RowProcessor</code> implementation to use when
+ * The {@code RowProcessor} implementation to use when
* converting rows into Beans
* @param columnIndex
* The values to use as keys in the Map are retrieved from the
@@ -156,8 +156,8 @@ public class BeanMapHandler<K, V> extends
AbstractKeyedHandler<K, V> {
}
/**
- * This factory method is called by <code>handle()</code> to retrieve the
- * key value from the current <code>ResultSet</code> row.
+ * This factory method is called by {@code handle()} to retrieve the
+ * key value from the current {@code ResultSet} row.
* @param rs ResultSet to create a key from
*
* @return K from the configured key column name/index
diff --git
a/src/main/java/org/apache/commons/dbutils/handlers/ColumnListHandler.java
b/src/main/java/org/apache/commons/dbutils/handlers/ColumnListHandler.java
index 8a12f2e..fe9c774 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/ColumnListHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/ColumnListHandler.java
@@ -20,9 +20,9 @@ import java.sql.ResultSet;
import java.sql.SQLException;
/**
- * <code>ResultSetHandler</code> implementation that converts one
- * <code>ResultSet</code> column into a <code>List</code> of
- * <code>Object</code>s. This class is thread safe.
+ * {@code ResultSetHandler} implementation that converts one
+ * {@code ResultSet} column into a {@code List} of
+ * {@code Object}s. This class is thread safe.
*
* @param <T> The type of the column.
* @see org.apache.commons.dbutils.ResultSetHandler
@@ -43,7 +43,7 @@ public class ColumnListHandler<T> extends
AbstractListHandler<T> {
/**
* Creates a new instance of ColumnListHandler. The first column of each
- * row will be returned from <code>handle()</code>.
+ * row will be returned from {@code handle()}.
*/
public ColumnListHandler() {
this(1, null);
@@ -53,7 +53,7 @@ public class ColumnListHandler<T> extends
AbstractListHandler<T> {
* Creates a new instance of ColumnListHandler.
*
* @param columnIndex The index of the column to retrieve from the
- * <code>ResultSet</code>.
+ * {@code ResultSet}.
*/
public ColumnListHandler(final int columnIndex) {
this(columnIndex, null);
@@ -63,7 +63,7 @@ public class ColumnListHandler<T> extends
AbstractListHandler<T> {
* Creates a new instance of ColumnListHandler.
*
* @param columnName The name of the column to retrieve from the
- * <code>ResultSet</code>.
+ * {@code ResultSet}.
*/
public ColumnListHandler(final String columnName) {
this(1, columnName);
@@ -71,9 +71,9 @@ public class ColumnListHandler<T> extends
AbstractListHandler<T> {
/** Private Helper
* @param columnIndex The index of the column to retrieve from the
- * <code>ResultSet</code>.
+ * {@code ResultSet}.
* @param columnName The name of the column to retrieve from the
- * <code>ResultSet</code>.
+ * {@code ResultSet}.
*/
private ColumnListHandler(final int columnIndex, final String columnName) {
super();
@@ -82,9 +82,9 @@ public class ColumnListHandler<T> extends
AbstractListHandler<T> {
}
/**
- * Returns one <code>ResultSet</code> column value as <code>Object</code>.
- * @param rs <code>ResultSet</code> to process.
- * @return <code>Object</code>, never <code>null</code>.
+ * Returns one {@code ResultSet} column value as {@code Object}.
+ * @param rs {@code ResultSet} to process.
+ * @return {@code Object}, never {@code null}.
*
* @throws SQLException if a database access error occurs
* @throws ClassCastException if the class datatype does not match the
column type
diff --git
a/src/main/java/org/apache/commons/dbutils/handlers/KeyedHandler.java
b/src/main/java/org/apache/commons/dbutils/handlers/KeyedHandler.java
index 6580d6d..b61610a 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/KeyedHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/KeyedHandler.java
@@ -24,8 +24,8 @@ import org.apache.commons.dbutils.RowProcessor;
/**
* <p>
- * <code>ResultSetHandler</code> implementation that returns a Map of Maps.
- * <code>ResultSet</code> rows are converted into Maps which are then stored
+ * {@code ResultSetHandler} implementation that returns a Map of Maps.
+ * {@code ResultSet} rows are converted into Maps which are then stored
* in a Map under the given key.
* </p>
* <p>
@@ -80,7 +80,7 @@ public class KeyedHandler<K> extends AbstractKeyedHandler<K,
Map<String, Object>
* Creates a new instance of KeyedHandler. The value of the first column
* of each row will be a key in the Map.
*
- * @param convert The <code>RowProcessor</code> implementation
+ * @param convert The {@code RowProcessor} implementation
* to use when converting rows into Maps
*/
public KeyedHandler(final RowProcessor convert) {
@@ -108,7 +108,7 @@ public class KeyedHandler<K> extends
AbstractKeyedHandler<K, Map<String, Object>
}
/** Private Helper
- * @param convert The <code>RowProcessor</code> implementation
+ * @param convert The {@code RowProcessor} implementation
* to use when converting rows into Maps
* @param columnIndex The values to use as keys in the Map are
* retrieved from the column at this index.
@@ -123,9 +123,9 @@ public class KeyedHandler<K> extends
AbstractKeyedHandler<K, Map<String, Object>
this.columnName = columnName;
}
/**
- * This factory method is called by <code>handle()</code> to retrieve the
- * key value from the current <code>ResultSet</code> row. This
- * implementation returns <code>ResultSet.getObject()</code> for the
+ * This factory method is called by {@code handle()} to retrieve the
+ * key value from the current {@code ResultSet} row. This
+ * implementation returns {@code ResultSet.getObject()} for the
* configured key column name or index.
* @param rs ResultSet to create a key from
* @return Object from the configured key column name/index
@@ -144,11 +144,11 @@ public class KeyedHandler<K> extends
AbstractKeyedHandler<K, Map<String, Object>
}
/**
- * This factory method is called by <code>handle()</code> to store the
- * current <code>ResultSet</code> row in some object. This
- * implementation returns a <code>Map</code> with case insensitive column
- * names as keys. Calls to <code>map.get("COL")</code> and
- * <code>map.get("col")</code> return the same value.
+ * This factory method is called by {@code handle()} to store the
+ * current {@code ResultSet} row in some object. This
+ * implementation returns a {@code Map} with case insensitive column
+ * names as keys. Calls to {@code map.get("COL")} and
+ * {@code map.get("col")} return the same value.
* @param rs ResultSet to create a row from
* @return Object typed Map containing column names to values
* @throws SQLException if a database access error occurs
diff --git a/src/main/java/org/apache/commons/dbutils/handlers/MapHandler.java
b/src/main/java/org/apache/commons/dbutils/handlers/MapHandler.java
index 3a2d391..ef064a0 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/MapHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/MapHandler.java
@@ -24,8 +24,8 @@ import org.apache.commons.dbutils.ResultSetHandler;
import org.apache.commons.dbutils.RowProcessor;
/**
- * <code>ResultSetHandler</code> implementation that converts the first
- * <code>ResultSet</code> row into a <code>Map</code>. This class is thread
+ * {@code ResultSetHandler} implementation that converts the first
+ * {@code ResultSet} row into a {@code Map}. This class is thread
* safe.
*
* @see org.apache.commons.dbutils.ResultSetHandler
@@ -40,7 +40,7 @@ public class MapHandler implements
ResultSetHandler<Map<String, Object>> {
/**
* Creates a new instance of MapHandler using a
- * <code>BasicRowProcessor</code> for conversion.
+ * {@code BasicRowProcessor} for conversion.
*/
public MapHandler() {
this(ArrayHandler.ROW_PROCESSOR);
@@ -49,7 +49,7 @@ public class MapHandler implements
ResultSetHandler<Map<String, Object>> {
/**
* Creates a new instance of MapHandler.
*
- * @param convert The <code>RowProcessor</code> implementation
+ * @param convert The {@code RowProcessor} implementation
* to use when converting rows into Maps.
*/
public MapHandler(final RowProcessor convert) {
@@ -58,11 +58,11 @@ public class MapHandler implements
ResultSetHandler<Map<String, Object>> {
}
/**
- * Converts the first row in the <code>ResultSet</code> into a
- * <code>Map</code>.
- * @param rs <code>ResultSet</code> to process.
- * @return A <code>Map</code> with the values from the first row or
- * <code>null</code> if there are no rows in the <code>ResultSet</code>.
+ * Converts the first row in the {@code ResultSet} into a
+ * {@code Map}.
+ * @param rs {@code ResultSet} to process.
+ * @return A {@code Map} with the values from the first row or
+ * {@code null} if there are no rows in the {@code ResultSet}.
*
* @throws SQLException if a database access error occurs
*
diff --git
a/src/main/java/org/apache/commons/dbutils/handlers/MapListHandler.java
b/src/main/java/org/apache/commons/dbutils/handlers/MapListHandler.java
index 443ba35..e5e614d 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/MapListHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/MapListHandler.java
@@ -23,8 +23,8 @@ import java.util.Map;
import org.apache.commons.dbutils.RowProcessor;
/**
- * <code>ResultSetHandler</code> implementation that converts a
- * <code>ResultSet</code> into a <code>List</code> of <code>Map</code>s.
+ * {@code ResultSetHandler} implementation that converts a
+ * {@code ResultSet} into a {@code List} of {@code Map}s.
* This class is thread safe.
*
* @see org.apache.commons.dbutils.ResultSetHandler
@@ -39,7 +39,7 @@ public class MapListHandler extends
AbstractListHandler<Map<String, Object>> {
/**
* Creates a new instance of MapListHandler using a
- * <code>BasicRowProcessor</code> for conversion.
+ * {@code BasicRowProcessor} for conversion.
*/
public MapListHandler() {
this(ArrayHandler.ROW_PROCESSOR);
@@ -48,7 +48,7 @@ public class MapListHandler extends
AbstractListHandler<Map<String, Object>> {
/**
* Creates a new instance of MapListHandler.
*
- * @param convert The <code>RowProcessor</code> implementation
+ * @param convert The {@code RowProcessor} implementation
* to use when converting rows into Maps.
*/
public MapListHandler(final RowProcessor convert) {
@@ -57,9 +57,9 @@ public class MapListHandler extends
AbstractListHandler<Map<String, Object>> {
}
/**
- * Converts the <code>ResultSet</code> row into a <code>Map</code> object.
- * @param rs <code>ResultSet</code> to process.
- * @return A <code>Map</code>, never null.
+ * Converts the {@code ResultSet} row into a {@code Map} object.
+ * @param rs {@code ResultSet} to process.
+ * @return A {@code Map}, never null.
*
* @throws SQLException if a database access error occurs
*
diff --git
a/src/main/java/org/apache/commons/dbutils/handlers/ScalarHandler.java
b/src/main/java/org/apache/commons/dbutils/handlers/ScalarHandler.java
index 4afc758..fdb30b3 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/ScalarHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/ScalarHandler.java
@@ -22,8 +22,8 @@ import java.sql.SQLException;
import org.apache.commons.dbutils.ResultSetHandler;
/**
- * <code>ResultSetHandler</code> implementation that converts one
- * <code>ResultSet</code> column into an Object. This class is thread safe.
+ * {@code ResultSetHandler} implementation that converts one
+ * {@code ResultSet} column into an Object. This class is thread safe.
*
* @param <T> The type of the scalar
* @see org.apache.commons.dbutils.ResultSetHandler
@@ -43,7 +43,7 @@ public class ScalarHandler<T> implements ResultSetHandler<T> {
/**
* Creates a new instance of ScalarHandler. The first column will
- * be returned from <code>handle()</code>.
+ * be returned from {@code handle()}.
*/
public ScalarHandler() {
this(1, null);
@@ -53,7 +53,7 @@ public class ScalarHandler<T> implements ResultSetHandler<T> {
* Creates a new instance of ScalarHandler.
*
* @param columnIndex The index of the column to retrieve from the
- * <code>ResultSet</code>.
+ * {@code ResultSet}.
*/
public ScalarHandler(final int columnIndex) {
this(columnIndex, null);
@@ -63,7 +63,7 @@ public class ScalarHandler<T> implements ResultSetHandler<T> {
* Creates a new instance of ScalarHandler.
*
* @param columnName The name of the column to retrieve from the
- * <code>ResultSet</code>.
+ * {@code ResultSet}.
*/
public ScalarHandler(final String columnName) {
this(1, columnName);
@@ -71,9 +71,9 @@ public class ScalarHandler<T> implements ResultSetHandler<T> {
/** Helper constructor
* @param columnIndex The index of the column to retrieve from the
- * <code>ResultSet</code>.
+ * {@code ResultSet}.
* @param columnName The name of the column to retrieve from the
- * <code>ResultSet</code>.
+ * {@code ResultSet}.
*/
private ScalarHandler(final int columnIndex, final String columnName) {
this.columnIndex = columnIndex;
@@ -81,12 +81,12 @@ public class ScalarHandler<T> implements
ResultSetHandler<T> {
}
/**
- * Returns one <code>ResultSet</code> column as an object via the
- * <code>ResultSet.getObject()</code> method that performs type
+ * Returns one {@code ResultSet} column as an object via the
+ * {@code ResultSet.getObject()} method that performs type
* conversions.
- * @param rs <code>ResultSet</code> to process.
- * @return The column or <code>null</code> if there are no rows in
- * the <code>ResultSet</code>.
+ * @param rs {@code ResultSet} to process.
+ * @return The column or {@code null} if there are no rows in
+ * the {@code ResultSet}.
*
* @throws SQLException if a database access error occurs
* @throws ClassCastException if the class datatype does not match the
column type
diff --git
a/src/main/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java
b/src/main/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java
index b617ca5..36d4421 100644
---
a/src/main/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java
+++
b/src/main/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java
@@ -35,11 +35,11 @@ import java.util.Map;
import org.apache.commons.dbutils.ProxyFactory;
/**
- * Decorates a <code>ResultSet</code> with checks for a SQL NULL value on each
- * <code>getXXX</code> method. If a column value obtained by a
- * <code>getXXX</code> method is not SQL NULL, the column value is returned. If
+ * Decorates a {@code ResultSet} with checks for a SQL NULL value on each
+ * {@code getXXX} method. If a column value obtained by a
+ * {@code getXXX} method is not SQL NULL, the column value is returned. If
* the column value is SQL null, an alternate value is returned. The alternate
- * value defaults to the Java <code>null</code> value, which can be overridden
+ * value defaults to the Java {@code null} value, which can be overridden
* for instances of the class.
*
* <p>
@@ -100,13 +100,13 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
private static final ProxyFactory factory = ProxyFactory.instance();
/**
- * Wraps the <code>ResultSet</code> in an instance of this class. This is
+ * Wraps the {@code ResultSet} in an instance of this class. This is
* equivalent to:
* <pre>
* ProxyFactory.instance().createResultSet(new
SqlNullCheckedResultSet(rs));
* </pre>
*
- * @param rs The <code>ResultSet</code> to wrap.
+ * @param rs The {@code ResultSet} to wrap.
* @return wrapped ResultSet
*/
public static ResultSet wrap(final ResultSet rs) {
@@ -142,8 +142,8 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Constructs a new instance of
- * <code>SqlNullCheckedResultSet</code>
- * to wrap the specified <code>ResultSet</code>.
+ * {@code SqlNullCheckedResultSet}
+ * to wrap the specified {@code ResultSet}.
* @param rs ResultSet to wrap
*/
public SqlNullCheckedResultSet(final ResultSet rs) {
@@ -153,7 +153,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getAsciiStream</code> method.
+ * invoking a {@code getAsciiStream} method.
*
* @return the value
*/
@@ -163,7 +163,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getBigDecimal</code> method.
+ * invoking a {@code getBigDecimal} method.
*
* @return the value
*/
@@ -173,7 +173,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getBinaryStream</code> method.
+ * invoking a {@code getBinaryStream} method.
*
* @return the value
*/
@@ -183,7 +183,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getBlob</code> method.
+ * invoking a {@code getBlob} method.
*
* @return the value
*/
@@ -193,7 +193,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getBoolean</code> method.
+ * invoking a {@code getBoolean} method.
*
* @return the value
*/
@@ -203,7 +203,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getByte</code> method.
+ * invoking a {@code getByte} method.
*
* @return the value
*/
@@ -213,7 +213,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getBytes</code> method.
+ * invoking a {@code getBytes} method.
*
* @return the value
*/
@@ -228,7 +228,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getCharacterStream</code> method.
+ * invoking a {@code getCharacterStream} method.
*
* @return the value
*/
@@ -238,7 +238,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getClob</code> method.
+ * invoking a {@code getClob} method.
*
* @return the value
*/
@@ -248,7 +248,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getDate</code> method.
+ * invoking a {@code getDate} method.
*
* @return the value
*/
@@ -258,7 +258,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getDouble</code> method.
+ * invoking a {@code getDouble} method.
*
* @return the value
*/
@@ -268,7 +268,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getFloat</code> method.
+ * invoking a {@code getFloat} method.
*
* @return the value
*/
@@ -278,7 +278,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getInt</code> method.
+ * invoking a {@code getInt} method.
*
* @return the value
*/
@@ -288,7 +288,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getLong</code> method.
+ * invoking a {@code getLong} method.
*
* @return the value
*/
@@ -298,7 +298,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getObject</code> method.
+ * invoking a {@code getObject} method.
*
* @return the value
*/
@@ -308,7 +308,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getRef</code> method.
+ * invoking a {@code getRef} method.
*
* @return the value
*/
@@ -318,7 +318,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getShort</code> method.
+ * invoking a {@code getShort} method.
*
* @return the value
*/
@@ -328,7 +328,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getString</code> method.
+ * invoking a {@code getString} method.
*
* @return the value
*/
@@ -338,7 +338,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getTime</code> method.
+ * invoking a {@code getTime} method.
*
* @return the value
*/
@@ -348,7 +348,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getTimestamp</code> method.
+ * invoking a {@code getTimestamp} method.
*
* @return the value
*/
@@ -364,7 +364,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Returns the value when a SQL null is encountered as the result of
- * invoking a <code>getURL</code> method.
+ * invoking a {@code getURL} method.
*
* @return the value
*/
@@ -373,9 +373,9 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
}
/**
- * Intercepts calls to <code>get*</code> methods and calls the appropriate
- * <code>getNull*</code> method if the <code>ResultSet</code> returned
- * <code>null</code>.
+ * Intercepts calls to {@code get*} methods and calls the appropriate
+ * {@code getNull*} method if the {@code ResultSet} returned
+ * {@code null}.
*
* @see java.lang.reflect.InvocationHandler#invoke(java.lang.Object,
java.lang.reflect.Method, java.lang.Object[])
* @param proxy Not used; all method calls go to the internal result set
@@ -401,7 +401,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getAsciiStream</code> method.
+ * invoking a {@code getAsciiStream} method.
*
* @param nullAsciiStream the value
*/
@@ -411,7 +411,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getBigDecimal</code> method.
+ * invoking a {@code getBigDecimal} method.
*
* @param nullBigDecimal the value
*/
@@ -421,7 +421,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getBinaryStream</code> method.
+ * invoking a {@code getBinaryStream} method.
*
* @param nullBinaryStream the value
*/
@@ -431,7 +431,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getBlob</code> method.
+ * invoking a {@code getBlob} method.
*
* @param nullBlob the value
*/
@@ -441,7 +441,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getBoolean</code> method.
+ * invoking a {@code getBoolean} method.
*
* @param nullBoolean the value
*/
@@ -451,7 +451,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getByte</code> method.
+ * invoking a {@code getByte} method.
*
* @param nullByte the value
*/
@@ -461,7 +461,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getBytes</code> method.
+ * invoking a {@code getBytes} method.
*
* @param nullBytes the value
*/
@@ -477,7 +477,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getCharacterStream</code> method.
+ * invoking a {@code getCharacterStream} method.
*
* @param nullCharacterStream the value
*/
@@ -487,7 +487,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getClob</code> method.
+ * invoking a {@code getClob} method.
*
* @param nullClob the value
*/
@@ -497,7 +497,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getDate</code> method.
+ * invoking a {@code getDate} method.
*
* @param nullDate the value
*/
@@ -507,7 +507,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getDouble</code> method.
+ * invoking a {@code getDouble} method.
*
* @param nullDouble the value
*/
@@ -517,7 +517,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getFloat</code> method.
+ * invoking a {@code getFloat} method.
*
* @param nullFloat the value
*/
@@ -527,7 +527,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getInt</code> method.
+ * invoking a {@code getInt} method.
*
* @param nullInt the value
*/
@@ -537,7 +537,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getLong</code> method.
+ * invoking a {@code getLong} method.
*
* @param nullLong the value
*/
@@ -547,7 +547,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getObject</code> method.
+ * invoking a {@code getObject} method.
*
* @param nullObject the value
*/
@@ -557,7 +557,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getRef</code> method.
+ * invoking a {@code getRef} method.
*
* @param nullRef the value
*/
@@ -567,7 +567,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getShort</code> method.
+ * invoking a {@code getShort} method.
*
* @param nullShort the value
*/
@@ -577,7 +577,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getString</code> method.
+ * invoking a {@code getString} method.
*
* @param nullString the value
*/
@@ -587,7 +587,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getTime</code> method.
+ * invoking a {@code getTime} method.
*
* @param nullTime the value
*/
@@ -597,7 +597,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getTimestamp</code> method.
+ * invoking a {@code getTimestamp} method.
*
* @param nullTimestamp the value
*/
@@ -612,7 +612,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
/**
* Sets the value to return when a SQL null is encountered as the result of
- * invoking a <code>getURL</code> method.
+ * invoking a {@code getURL} method.
*
* @param nullURL the value
*/
diff --git
a/src/main/java/org/apache/commons/dbutils/wrappers/StringTrimmedResultSet.java
b/src/main/java/org/apache/commons/dbutils/wrappers/StringTrimmedResultSet.java
index 929dbb3..c06c6b4 100644
---
a/src/main/java/org/apache/commons/dbutils/wrappers/StringTrimmedResultSet.java
+++
b/src/main/java/org/apache/commons/dbutils/wrappers/StringTrimmedResultSet.java
@@ -23,14 +23,14 @@ import java.sql.ResultSet;
import org.apache.commons.dbutils.ProxyFactory;
/**
- * Wraps a <code>ResultSet</code> to trim strings returned by the
- * <code>getString()</code> and <code>getObject()</code> methods.
+ * Wraps a {@code ResultSet} to trim strings returned by the
+ * {@code getString()} and {@code getObject()} methods.
*
* <p>
* Usage Example:
* This example shows how to decorate ResultSets so processing continues as
* normal but all Strings are trimmed before being returned from the
- * <code>ResultSet</code>.
+ * {@code ResultSet}.
* </p>
*
* <pre>
@@ -51,13 +51,13 @@ public class StringTrimmedResultSet implements
InvocationHandler {
private static final ProxyFactory factory = ProxyFactory.instance();
/**
- * Wraps the <code>ResultSet</code> in an instance of this class. This is
+ * Wraps the {@code ResultSet} in an instance of this class. This is
* equivalent to:
* <pre>
* ProxyFactory.instance().createResultSet(new StringTrimmedResultSet(rs));
* </pre>
*
- * @param rs The <code>ResultSet</code> to wrap.
+ * @param rs The {@code ResultSet} to wrap.
* @return wrapped ResultSet
*/
public static ResultSet wrap(final ResultSet rs) {
@@ -70,8 +70,8 @@ public class StringTrimmedResultSet implements
InvocationHandler {
private final ResultSet rs;
/**
- * Constructs a new instance of <code>StringTrimmedResultSet</code>
- * to wrap the specified <code>ResultSet</code>.
+ * Constructs a new instance of {@code StringTrimmedResultSet}
+ * to wrap the specified {@code ResultSet}.
* @param rs ResultSet to wrap
*/
public StringTrimmedResultSet(final ResultSet rs) {
@@ -80,8 +80,8 @@ public class StringTrimmedResultSet implements
InvocationHandler {
}
/**
- * Intercept calls to the <code>getString()</code> and
- * <code>getObject()</code> methods and trim any Strings before they're
+ * Intercept calls to the {@code getString()} and
+ * {@code getObject()} methods and trim any Strings before they're
* returned.
*
* @see java.lang.reflect.InvocationHandler#invoke(java.lang.Object,
java.lang.reflect.Method, java.lang.Object[])
diff --git a/src/test/java/org/apache/commons/dbutils/MockResultSet.java
b/src/test/java/org/apache/commons/dbutils/MockResultSet.java
index 9831fde..c3dd761 100644
--- a/src/test/java/org/apache/commons/dbutils/MockResultSet.java
+++ b/src/test/java/org/apache/commons/dbutils/MockResultSet.java
@@ -32,13 +32,13 @@ import java.util.List;
public class MockResultSet implements InvocationHandler {
/**
- * Create a <code>MockResultSet</code> proxy object. This is equivalent
to:
+ * Create a {@code MockResultSet} proxy object. This is equivalent to:
* <pre>
* ProxyFactory.instance().createResultSet(new MockResultSet(metaData,
rows));
* </pre>
*
* @param metaData
- * @param rows A null value indicates an empty <code>ResultSet</code>.
+ * @param rows A null value indicates an empty {@code ResultSet}.
*/
public static ResultSet create(final ResultSetMetaData metaData,
final Object[][] rows) {
@@ -57,7 +57,7 @@ public class MockResultSet implements InvocationHandler {
/**
* MockResultSet constructor.
* @param metaData
- * @param rows A null value indicates an empty <code>ResultSet</code>.
+ * @param rows A null value indicates an empty {@code ResultSet}.
*/
public MockResultSet(final ResultSetMetaData metaData, final Object[][]
rows) {
super();
diff --git
a/src/test/java/org/apache/commons/dbutils/MockResultSetMetaData.java
b/src/test/java/org/apache/commons/dbutils/MockResultSetMetaData.java
index 2208d33..0af2e80 100644
--- a/src/test/java/org/apache/commons/dbutils/MockResultSetMetaData.java
+++ b/src/test/java/org/apache/commons/dbutils/MockResultSetMetaData.java
@@ -30,7 +30,7 @@ public class MockResultSetMetaData implements
InvocationHandler {
private String[] columnLabels = null;
/**
- * Create a <code>MockResultSetMetaData</code> proxy object. This is
+ * Create a {@code MockResultSetMetaData} proxy object. This is
* equivalent to:
* <pre>
* ProxyFactory.instance().createResultSetMetaData(new
MockResultSetMetaData(columnNames));
diff --git
a/src/test/java/org/apache/commons/dbutils/StatementConfigurationTest.java
b/src/test/java/org/apache/commons/dbutils/StatementConfigurationTest.java
index 7361373..3007cfd 100644
--- a/src/test/java/org/apache/commons/dbutils/StatementConfigurationTest.java
+++ b/src/test/java/org/apache/commons/dbutils/StatementConfigurationTest.java
@@ -67,7 +67,7 @@ public class StatementConfigurationTest {
}
/**
- * Test that the constructor of <code>StatementConfiguration</code>
correctly sets all values.
+ * Test that the constructor of {@code StatementConfiguration} correctly
sets all values.
*/
@Test
public void testConstructor() {
diff --git
a/src/test/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSetTest.java
b/src/test/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSetTest.java
index d4b80be..1e06f38 100644
---
a/src/test/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSetTest.java
+++
b/src/test/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSetTest.java
@@ -45,7 +45,7 @@ import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
/**
- * Test cases for <code>SqlNullCheckedResultSet</code> class.
+ * Test cases for {@code SqlNullCheckedResultSet} class.
*/
public class SqlNullCheckedResultSetTest extends BaseTestCase {
