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-dbcp.git
The following commit(s) were added to refs/heads/master by this push:
new 133e941 Javadoc.
133e941 is described below
commit 133e9410920c558e21b4f2471cedc856f0c1c214
Author: Gary Gregory <gardgreg...@gmail.com>
AuthorDate: Tue Jul 30 15:59:51 2019 -0400
Javadoc.
---
.../dbcp2/cpdsadapter/PooledConnectionImpl.java | 81 ++++++++++++++++++++++
1 file changed, 81 insertions(+)
diff --git
a/src/main/java/org/apache/commons/dbcp2/cpdsadapter/PooledConnectionImpl.java
b/src/main/java/org/apache/commons/dbcp2/cpdsadapter/PooledConnectionImpl.java
index 4849e2e..1f74af4 100644
---
a/src/main/java/org/apache/commons/dbcp2/cpdsadapter/PooledConnectionImpl.java
+++
b/src/main/java/org/apache/commons/dbcp2/cpdsadapter/PooledConnectionImpl.java
@@ -181,6 +181,10 @@ class PooledConnectionImpl
/**
* Creates a {@link PStmtKey} for the given arguments.
+ *
+ * @param sql
+ * The SQL statement.
+ * @return a {@link PStmtKey} for the given arguments.
*/
protected PStmtKey createKey(final String sql) {
return new PStmtKey(normalizeSQL(sql), getCatalogOrNull(),
getSchemaOrNull());
@@ -188,6 +192,13 @@ class PooledConnectionImpl
/**
* Creates a {@link PStmtKey} for the given arguments.
+ *
+ * @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>.
+ * @return a key to uniquely identify a prepared statement.
*/
protected PStmtKey createKey(final String sql, final int
autoGeneratedKeys) {
return new PStmtKey(normalizeSQL(sql), getCatalogOrNull(),
getSchemaOrNull(), autoGeneratedKeys);
@@ -195,6 +206,13 @@ class PooledConnectionImpl
/**
* Creates a {@link PStmtKey} for the given arguments.
+ *
+ * @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.
+ * @return a key to uniquely identify a prepared statement.
*/
protected PStmtKey createKey(final String sql, final int columnIndexes[]) {
return new PStmtKey(normalizeSQL(sql), getCatalogOrNull(),
getSchemaOrNull(), columnIndexes);
@@ -202,6 +220,16 @@ class PooledConnectionImpl
/**
* Creates a {@link PStmtKey} for the given arguments.
+ *
+ * @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>.
+ * @return a key to uniquely identify a prepared statement.
*/
protected PStmtKey createKey(final String sql, final int resultSetType,
final int resultSetConcurrency) {
return new PStmtKey(normalizeSQL(sql), getCatalogOrNull(),
getSchemaOrNull(), resultSetType,
@@ -210,6 +238,19 @@ class PooledConnectionImpl
/**
* Creates a {@link PStmtKey} for the given arguments.
+ *
+ * @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>.
+ * @return a key to uniquely identify a prepared statement.
*/
protected PStmtKey createKey(final String sql, final int resultSetType,
final int resultSetConcurrency,
final int resultSetHoldability) {
@@ -220,6 +261,20 @@ class PooledConnectionImpl
/**
* Creates a {@link PStmtKey} for the given arguments.
*
+ * @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>.
+ * @param statementType
+ * The SQL statement type, prepared or callable.
+ * @return a key to uniquely identify a prepared statement.
* @since 2.4.0
*/
protected PStmtKey createKey(final String sql, final int resultSetType,
final int resultSetConcurrency,
@@ -231,6 +286,17 @@ class PooledConnectionImpl
/**
* Creates a {@link PStmtKey} for the given arguments.
*
+ * @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 statementType
+ * The SQL statement type, prepared or callable.
+ * @return a key to uniquely identify a prepared statement.
* @since 2.4.0
*/
protected PStmtKey createKey(final String sql, final int resultSetType,
final int resultSetConcurrency,
@@ -241,6 +307,12 @@ class PooledConnectionImpl
/**
* Creates a {@link PStmtKey} for the given arguments.
+ *
+ * @param sql
+ * The SQL statement.
+ * @param statementType
+ * The SQL statement type, prepared or callable.
+ * @return a key to uniquely identify a prepared statement.
*/
protected PStmtKey createKey(final String sql, final StatementType
statementType) {
return new PStmtKey(normalizeSQL(sql), getCatalogOrNull(),
getSchemaOrNull(), statementType);
@@ -248,6 +320,12 @@ class PooledConnectionImpl
/**
* Creates a {@link PStmtKey} for the given arguments.
+ *
+ * @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.
+ * @return a key to uniquely identify a prepared statement.
*/
protected PStmtKey createKey(final String sql, final String columnNames[])
{
return new PStmtKey(normalizeSQL(sql), getCatalogOrNull(),
getSchemaOrNull(), columnNames);
@@ -361,6 +439,9 @@ class PooledConnectionImpl
/**
* Normalizes the given SQL statement, producing a canonical form that is
semantically equivalent to the original.
+ * @param sql
+ * The SQL statement.
+ * @return the normalized SQL statement.
*/
protected String normalizeSQL(final String sql) {
return sql.trim();
