You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by th...@apache.org on 2017/07/21 04:01:22 UTC
[05/10] commons-dbutils git commit: Update javadoc based on results
of mvn javadoc:javadoc
Update javadoc based on results of mvn javadoc:javadoc
Project: http://git-wip-us.apache.org/repos/asf/commons-dbutils/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-dbutils/commit/0446d3f4
Tree: http://git-wip-us.apache.org/repos/asf/commons-dbutils/tree/0446d3f4
Diff: http://git-wip-us.apache.org/repos/asf/commons-dbutils/diff/0446d3f4
Branch: refs/heads/master
Commit: 0446d3f44b6b70bba8a64d1e278ac9bc6ea7dd56
Parents: dd54896
Author: Carl Hall <th...@apache.org>
Authored: Sun Jul 9 00:25:18 2017 -0700
Committer: Carl Hall <th...@apache.org>
Committed: Thu Jul 20 20:59:49 2017 -0700
----------------------------------------------------------------------
.../commons/dbutils/AbstractQueryRunner.java | 2 +-
.../commons/dbutils/AsyncQueryRunner.java | 33 +++++++++++++++++++
.../commons/dbutils/BaseResultSetHandler.java | 2 +-
.../apache/commons/dbutils/BeanProcessor.java | 34 ++++++++++----------
.../apache/commons/dbutils/OutParameter.java | 2 +-
.../commons/dbutils/ResultSetIterator.java | 2 +-
.../dbutils/handlers/BeanMapHandler.java | 4 +--
.../commons/dbutils/handlers/KeyedHandler.java | 2 +-
.../wrappers/SqlNullCheckedResultSet.java | 2 +-
9 files changed, 58 insertions(+), 25 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/0446d3f4/src/main/java/org/apache/commons/dbutils/AbstractQueryRunner.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/dbutils/AbstractQueryRunner.java b/src/main/java/org/apache/commons/dbutils/AbstractQueryRunner.java
index a85c78b..961aa68 100644
--- a/src/main/java/org/apache/commons/dbutils/AbstractQueryRunner.java
+++ b/src/main/java/org/apache/commons/dbutils/AbstractQueryRunner.java
@@ -35,7 +35,7 @@ import java.util.Arrays;
import javax.sql.DataSource;
/**
- * The base class for QueryRunner & AsyncQueryRunner. This class is thread safe.
+ * The base class for QueryRunner & AsyncQueryRunner. This class is thread safe.
*
* @since 1.4 (mostly extracted from QueryRunner)
*/
http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/0446d3f4/src/main/java/org/apache/commons/dbutils/AsyncQueryRunner.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/dbutils/AsyncQueryRunner.java b/src/main/java/org/apache/commons/dbutils/AsyncQueryRunner.java
index ce140b5..4625695 100644
--- a/src/main/java/org/apache/commons/dbutils/AsyncQueryRunner.java
+++ b/src/main/java/org/apache/commons/dbutils/AsyncQueryRunner.java
@@ -555,6 +555,10 @@ public class AsyncQueryRunner extends AbstractQueryRunner {
/**
* Executes {@link QueryRunner#insert(String, ResultSetHandler)} asynchronously.
*
+ * @param <T> Return type expected
+ * @param sql SQL insert statement to execute
+ * @param rsh {@link ResultSetHandler} for handling the results
+ * @return {@link Future} that executes a query runner insert
* @see QueryRunner#insert(String, ResultSetHandler)
* @throws SQLException if a database access error occurs
* @since 1.6
@@ -573,6 +577,11 @@ public class AsyncQueryRunner extends AbstractQueryRunner {
/**
* Executes {@link QueryRunner#insert(String, ResultSetHandler, Object...)} asynchronously.
*
+ * @param <T> Return type expected
+ * @param sql SQL insert statement to execute
+ * @param rsh {@link ResultSetHandler} for handling the results
+ * @param params Parameter values for substitution in the SQL statement
+ * @return {@link Future} that executes a query runner insert
* @see QueryRunner#insert(String, ResultSetHandler, Object...)
* @throws SQLException if a database access error occurs
* @since 1.6
@@ -590,6 +599,11 @@ public class AsyncQueryRunner extends AbstractQueryRunner {
/**
* Executes {@link QueryRunner#insert(Connection, String, ResultSetHandler)} asynchronously.
*
+ * @param <T> Return type expected
+ * @param conn {@link Connection} to use to execute the SQL statement
+ * @param sql SQL insert statement to execute
+ * @param rsh {@link ResultSetHandler} for handling the results
+ * @return {@link Future} that executes a query runner insert
* @see QueryRunner#insert(Connection, String, ResultSetHandler)
* @throws SQLException if a database access error occurs
* @since 1.6
@@ -607,6 +621,12 @@ public class AsyncQueryRunner extends AbstractQueryRunner {
/**
* Executes {@link QueryRunner#insert(Connection, String, ResultSetHandler, Object...)} asynchronously.
*
+ * @param <T> Return type expected
+ * @param conn {@link Connection} to use to execute the SQL statement
+ * @param sql SQL insert statement to execute
+ * @param rsh {@link ResultSetHandler} for handling the results
+ * @param params Parameter values for substitution in the SQL statement
+ * @return {@link Future} that executes a query runner insert
* @see QueryRunner#insert(Connection, String, ResultSetHandler, Object...)
* @throws SQLException if a database access error occurs
* @since 1.6
@@ -624,6 +644,12 @@ public class AsyncQueryRunner extends AbstractQueryRunner {
/**
* {@link QueryRunner#insertBatch(String, ResultSetHandler, Object[][])} asynchronously.
*
+ * @param <T> Return type expected
+ * @param sql SQL insert statement to execute
+ * @param rsh {@link ResultSetHandler} for handling the results
+ * @param params An array of query replacement parameters. Each row in
+ * this array is one set of batch replacement values.
+ * @return {@link Future} that executes a query runner batch insert
* @see QueryRunner#insertBatch(String, ResultSetHandler, Object[][])
* @throws SQLException if a database access error occurs
* @since 1.6
@@ -641,6 +667,13 @@ public class AsyncQueryRunner extends AbstractQueryRunner {
/**
* {@link QueryRunner#insertBatch(Connection, String, ResultSetHandler, Object[][])} asynchronously.
*
+ * @param <T> Return type expected
+ * @param conn {@link Connection} to use to execute the SQL statement
+ * @param sql SQL insert statement to execute
+ * @param rsh {@link ResultSetHandler} for handling the results
+ * @param params An array of query replacement parameters. Each row in
+ * this array is one set of batch replacement values.
+ * @return {@link Future} that executes a query runner batch insert
* @see QueryRunner#insertBatch(Connection, String, ResultSetHandler, Object[][])
* @throws SQLException if a database access error occurs
* @since 1.6
http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/0446d3f4/src/main/java/org/apache/commons/dbutils/BaseResultSetHandler.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/dbutils/BaseResultSetHandler.java b/src/main/java/org/apache/commons/dbutils/BaseResultSetHandler.java
index 853a117..7cbf131 100644
--- a/src/main/java/org/apache/commons/dbutils/BaseResultSetHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/BaseResultSetHandler.java
@@ -81,7 +81,7 @@ public abstract class BaseResultSetHandler<T> implements ResultSetHandler<T> {
*
* @return An Object initialized with <code>ResultSet</code> data
* @throws SQLException if a database access error occurs
- * @see {@link ResultSetHandler#handle(ResultSet)}
+ * @see ResultSetHandler#handle(ResultSet)
*/
protected abstract T handle() throws SQLException;
http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/0446d3f4/src/main/java/org/apache/commons/dbutils/BeanProcessor.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/dbutils/BeanProcessor.java b/src/main/java/org/apache/commons/dbutils/BeanProcessor.java
index ce1098a..74de18a 100644
--- a/src/main/java/org/apache/commons/dbutils/BeanProcessor.java
+++ b/src/main/java/org/apache/commons/dbutils/BeanProcessor.java
@@ -121,28 +121,28 @@ public class BeanProcessor {
* implementation uses reflection and <code>BeanInfo</code> classes to
* match column names to bean property names. Properties are matched to
* columns based on several factors:
- * <br/>
- * <ol>
- * <li>
+ * <br/>
+ * <ol>
+ * <li>
* The class has a writable property with the same name as a column.
* The name comparison is case insensitive.
- * </li>
+ * </li>
*
- * <li>
+ * <li>
* The column type can be converted to the property's set method
* parameter type with a ResultSet.get* method. If the conversion fails
* (ie. the property was an int and the column was a Timestamp) an
* SQLException is thrown.
- * </li>
- * </ol>
+ * </li>
+ * </ol>
*
- * <p>
+ * <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
* 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.
- * </p>
+ * </p>
* @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
@@ -159,20 +159,20 @@ public class BeanProcessor {
* This implementation uses reflection and <code>BeanInfo</code> classes to
* match column names to bean property names. Properties are matched to
* columns based on several factors:
- * <br/>
- * <ol>
- * <li>
+ * <br/>
+ * <ol>
+ * <li>
* The class has a writable property with the same name as a column.
* The name comparison is case insensitive.
- * </li>
+ * </li>
*
- * <li>
+ * <li>
* The column type can be converted to the property's set method
* parameter type with a ResultSet.get* method. If the conversion fails
* (ie. the property was an int and the column was a Timestamp) an
* SQLException is thrown.
- * </li>
- * </ol>
+ * </li>
+ * </ol>
*
* <p>
* Primitive bean properties are set to their defaults when SQL NULL is
@@ -180,7 +180,7 @@ public class BeanProcessor {
* 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.
- * </p>
+ * </p>
* @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
http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/0446d3f4/src/main/java/org/apache/commons/dbutils/OutParameter.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/dbutils/OutParameter.java b/src/main/java/org/apache/commons/dbutils/OutParameter.java
index 0abf84d..d49b474 100644
--- a/src/main/java/org/apache/commons/dbutils/OutParameter.java
+++ b/src/main/java/org/apache/commons/dbutils/OutParameter.java
@@ -21,7 +21,7 @@ import java.sql.SQLException;
/**
* Represents an OUT parameter for a stored procedure. When running a stored
- * procedure with {@link ProcedureRunner}, pass an instance of
+ * procedure with {@link QueryRunner}, pass an instance of
* <code>OutParameter</code> 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() }.
http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/0446d3f4/src/main/java/org/apache/commons/dbutils/ResultSetIterator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/dbutils/ResultSetIterator.java b/src/main/java/org/apache/commons/dbutils/ResultSetIterator.java
index 0eeda4a..50e2a12 100644
--- a/src/main/java/org/apache/commons/dbutils/ResultSetIterator.java
+++ b/src/main/java/org/apache/commons/dbutils/ResultSetIterator.java
@@ -22,7 +22,7 @@ import java.util.Iterator;
/**
* <p>
- * Wraps a <code>ResultSet</code> in an <code>Iterator<Object[]></code>. This is useful
+ * Wraps a <code>ResultSet</code> in an <code>Iterator<Object[]></code>. This is useful
* when you want to present a non-database application layer with domain
* neutral data.
* </p>
http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/0446d3f4/src/main/java/org/apache/commons/dbutils/handlers/BeanMapHandler.java
----------------------------------------------------------------------
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 4f5ba48..79cfbb4 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/BeanMapHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/BeanMapHandler.java
@@ -43,10 +43,10 @@ import org.apache.commons.dbutils.RowProcessor;
* returned for id is dependent upon how your JDBC driver converts SQL column
* types from the Person table into Java types. The "name" and "age" columns are
* converted according to their property descriptors by DbUtils.
- * </p>
+ * </p>
* <p>
* This class is thread safe.
- * </p>
+ * </p>
*
* @param <K>
* the type of keys maintained by the returned map
http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/0446d3f4/src/main/java/org/apache/commons/dbutils/handlers/KeyedHandler.java
----------------------------------------------------------------------
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 6ef9bbe..ed79290 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/KeyedHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/KeyedHandler.java
@@ -42,7 +42,7 @@ import org.apache.commons.dbutils.RowProcessor;
* returned Map's get() method can be in any case. The data types returned for
* name and age are dependent upon how your JDBC driver converts SQL column
* types from the Person table into Java types.
- * </p>
+ * </p>
* <p>This class is thread safe.</p>
*
* @param <K> The type of the key
http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/0446d3f4/src/main/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java
----------------------------------------------------------------------
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 f8d1d3f..85f273c 100644
--- a/src/main/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java
+++ b/src/main/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java
@@ -65,7 +65,7 @@ import org.apache.commons.dbutils.ProxyFactory;
* rs.close();
* </pre>
* </blockquote>
- * </p>
+ * </p>
* <p>Unlike some other classes in DbUtils, this class is NOT thread-safe.</p>
*/
public class SqlNullCheckedResultSet implements InvocationHandler {