You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2018/07/13 00:26:26 UTC

[46/50] [abbrv] commons-dbcp git commit: Add missing Javadocs.

Add missing Javadocs.

Project: http://git-wip-us.apache.org/repos/asf/commons-dbcp/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-dbcp/commit/7b19b4cf
Tree: http://git-wip-us.apache.org/repos/asf/commons-dbcp/tree/7b19b4cf
Diff: http://git-wip-us.apache.org/repos/asf/commons-dbcp/diff/7b19b4cf

Branch: refs/heads/release
Commit: 7b19b4cf7db7c66dafc1fa739639167ff10fde9d
Parents: d6819f7
Author: Gary Gregory <ga...@gmail.com>
Authored: Thu Jul 12 09:49:21 2018 -0600
Committer: Gary Gregory <ga...@gmail.com>
Committed: Thu Jul 12 09:49:21 2018 -0600

----------------------------------------------------------------------
 .../commons/dbcp2/cpdsadapter/PStmtKeyCPDS.java | 60 ++++++++++++++++++++
 1 file changed, 60 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-dbcp/blob/7b19b4cf/src/main/java/org/apache/commons/dbcp2/cpdsadapter/PStmtKeyCPDS.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/dbcp2/cpdsadapter/PStmtKeyCPDS.java b/src/main/java/org/apache/commons/dbcp2/cpdsadapter/PStmtKeyCPDS.java
index 56153d8..1653a2b 100644
--- a/src/main/java/org/apache/commons/dbcp2/cpdsadapter/PStmtKeyCPDS.java
+++ b/src/main/java/org/apache/commons/dbcp2/cpdsadapter/PStmtKeyCPDS.java
@@ -26,27 +26,87 @@ import org.apache.commons.dbcp2.PStmtKey;
  */
 @Deprecated
 public class PStmtKeyCPDS extends PStmtKey {
+
+    /**
+     * Constructs a key to uniquely identify a prepared statement.
+     * 
+     * @param sql
+     *            The SQL statement.
+     */
     public PStmtKeyCPDS(final String sql) {
         super(sql);
     }
 
+    /**
+     * Constructs a key to uniquely identify a prepared statement.
+     * 
+     * @param sql
+     *            The SQL statement.
+     * @param autoGeneratedKeys
+     *            A flag indicating whether auto-generated keys should be returned; one of
+     *            <code>Statement.RETURN_GENERATED_KEYS</code> or <code>Statement.NO_GENERATED_KEYS</code>.
+     */
     public PStmtKeyCPDS(final String sql, final int autoGeneratedKeys) {
         super(sql, null, autoGeneratedKeys);
     }
 
+    /**
+     * Constructs a key to uniquely identify a prepared statement.
+     * 
+     * @param sql
+     *            The SQL statement.
+     * @param resultSetType
+     *            A result set type; one of <code>ResultSet.TYPE_FORWARD_ONLY</code>,
+     *            <code>ResultSet.TYPE_SCROLL_INSENSITIVE</code>, or <code>ResultSet.TYPE_SCROLL_SENSITIVE</code>.
+     * @param resultSetConcurrency
+     *            A concurrency type; one of <code>ResultSet.CONCUR_READ_ONLY</code> or
+     *            <code>ResultSet.CONCUR_UPDATABLE</code>.
+     */
     public PStmtKeyCPDS(final String sql, final int resultSetType, final int resultSetConcurrency) {
         super(sql, resultSetType, resultSetConcurrency);
     }
 
+    /**
+     * Constructs a key to uniquely identify a prepared statement.
+     * 
+     * @param sql
+     *            The SQL statement.
+     * @param resultSetType
+     *            a result set type; one of <code>ResultSet.TYPE_FORWARD_ONLY</code>,
+     *            <code>ResultSet.TYPE_SCROLL_INSENSITIVE</code>, or <code>ResultSet.TYPE_SCROLL_SENSITIVE</code>.
+     * @param resultSetConcurrency
+     *            A concurrency type; one of <code>ResultSet.CONCUR_READ_ONLY</code> or
+     *            <code>ResultSet.CONCUR_UPDATABLE</code>
+     * @param resultSetHoldability
+     *            One of the following <code>ResultSet</code> constants: <code>ResultSet.HOLD_CURSORS_OVER_COMMIT</code>
+     *            or <code>ResultSet.CLOSE_CURSORS_AT_COMMIT</code>.
+     */
     public PStmtKeyCPDS(final String sql, final int resultSetType, final int resultSetConcurrency,
             final int resultSetHoldability) {
         super(sql, null, resultSetType, resultSetConcurrency, resultSetHoldability);
     }
 
+    /**
+     * Constructs a key to uniquely identify a prepared statement.
+     * 
+     * @param sql
+     *            The SQL statement.
+     * @param columnIndexes
+     *            An array of column indexes indicating the columns that should be returned from the inserted row or
+     *            rows.
+     */
     public PStmtKeyCPDS(final String sql, final int columnIndexes[]) {
         super(sql, null, columnIndexes);
     }
 
+    /**
+     * Constructs a key to uniquely identify a prepared statement.
+     * 
+     * @param sql
+     *            The SQL statement.
+     * @param columnNames
+     *            An array of column names indicating the columns that should be returned from the inserted row or rows.
+     */
     public PStmtKeyCPDS(final String sql, final String columnNames[]) {
         super(sql, null, columnNames);
     }