commons-commits mailing list archives

Author: simonetripodi
Date: Sat Sep 17 10:17:59 2011
New Revision: 1171937

URL: http://svn.apache.org/viewvc?rev=1171937&view=rev
Log:
added missing javadocs

Modified:
    commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/AsyncQueryRunner.java

Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/AsyncQueryRunner.java
URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/AsyncQueryRunner.java?rev=1171937&r1=1171936&r2=1171937&view=diff
==============================================================================
--- commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/AsyncQueryRunner.java
(original)
+++ commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/AsyncQueryRunner.java
Sat Sep 17 10:17:59 2011
@@ -400,6 +400,16 @@ public class AsyncQueryRunner extends Ab
         private boolean closeConn;
         private PreparedStatement ps;
 
+        /**
+         *
+         *
+         * @param conn The connection to use for the batch call.
+         * @param closeConn True if the connection should be closed, false otherwise.
+         * @param ps The {@link PreparedStatement} to be executed.
+         * @param sql The SQL statement to execute.
+         * @param params An array of query replacement parameters.  Each row in
+         *        this array is one set of batch replacement values.
+         */
         public UpdateCallableStatement(Connection conn, boolean closeConn, PreparedStatement
ps, String sql, Object... params) {
             this.sql = sql;
             this.params = params;
@@ -408,6 +418,14 @@ public class AsyncQueryRunner extends Ab
             this.ps = ps;
         }
 
+        /**
+         * The actual call to {@code executeUpdate()} method.
+         *
+         * @return either (1) the row count for SQL Data Manipulation Language (DML) statements
or
+         *                (2) 0 for SQL statements that return nothing
+         * @throws Exception if a database access error occurs.
+         * @see PreparedStatement#executeUpdate()
+         */
         public Integer call() throws Exception {
             int rows = 0;