summaryrefslogtreecommitdiff
path: root/spring-jdbc/src/main/java/org/springframework/jdbc/core/JdbcOperations.java
diff options
context:
space:
mode:
authorAndrej Shadura <andrew.shadura@collabora.co.uk>2019-03-09 12:38:16 +0000
committerAndrej Shadura <andrew.shadura@collabora.co.uk>2019-03-09 12:38:16 +0000
commit673684ec2c6cac26840588b958de098f0c54dd53 (patch)
treec59a0c2767a9ccfa80ca84b30e33d7e39ab1cbcc /spring-jdbc/src/main/java/org/springframework/jdbc/core/JdbcOperations.java
parentf0e4dab77c149a3dd88691ae95b448a5a7819a32 (diff)
parent139a199c595da36850738b73ee65310ed0a4a94d (diff)
Update upstream source from tag 'upstream/4.3.23_git20190308'
Update to upstream version '4.3.23~git20190308' with Debian dir 6d5a5b12f9bb323cd3b6fb67329b6f998e2ff19a
Diffstat (limited to 'spring-jdbc/src/main/java/org/springframework/jdbc/core/JdbcOperations.java')
-rw-r--r--spring-jdbc/src/main/java/org/springframework/jdbc/core/JdbcOperations.java399
1 files changed, 196 insertions, 203 deletions
diff --git a/spring-jdbc/src/main/java/org/springframework/jdbc/core/JdbcOperations.java b/spring-jdbc/src/main/java/org/springframework/jdbc/core/JdbcOperations.java
index 64aa2a82..cba33bac 100644
--- a/spring-jdbc/src/main/java/org/springframework/jdbc/core/JdbcOperations.java
+++ b/spring-jdbc/src/main/java/org/springframework/jdbc/core/JdbcOperations.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2018 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -53,10 +53,10 @@ public interface JdbcOperations {
* data access operations, within Spring's managed JDBC environment:
* that is, participating in Spring-managed transactions and converting
* JDBC SQLExceptions into Spring's DataAccessException hierarchy.
- * <p>The callback action can return a result object, for example a
- * domain object or a collection of domain objects.
- * @param action the callback object that specifies the action
- * @return a result object returned by the action, or {@code null}
+ * <p>The callback action can return a result object, for example a domain
+ * object or a collection of domain objects.
+ * @param action a callback object that specifies the action
+ * @return a result object returned by the action, or {@code null} if none
* @throws DataAccessException if there is any problem
*/
<T> T execute(ConnectionCallback<T> action) throws DataAccessException;
@@ -72,10 +72,10 @@ public interface JdbcOperations {
* access operations on a single Statement, within Spring's managed JDBC
* environment: that is, participating in Spring-managed transactions and
* converting JDBC SQLExceptions into Spring's DataAccessException hierarchy.
- * <p>The callback action can return a result object, for example a
- * domain object or a collection of domain objects.
- * @param action callback object that specifies the action
- * @return a result object returned by the action, or {@code null}
+ * <p>The callback action can return a result object, for example a domain
+ * object or a collection of domain objects.
+ * @param action a callback that specifies the action
+ * @return a result object returned by the action, or {@code null} if none
* @throws DataAccessException if there is any problem
*/
<T> T execute(StatementCallback<T> action) throws DataAccessException;
@@ -93,8 +93,8 @@ public interface JdbcOperations {
* <p>Uses a JDBC Statement, not a PreparedStatement. If you want to
* execute a static query with a PreparedStatement, use the overloaded
* {@code query} method with {@code null} as argument array.
- * @param sql SQL query to execute
- * @param rse object that will extract all rows of results
+ * @param sql the SQL query to execute
+ * @param rse a callback that will extract all rows of results
* @return an arbitrary result object, as returned by the ResultSetExtractor
* @throws DataAccessException if there is any problem executing the query
* @see #query(String, Object[], ResultSetExtractor)
@@ -107,21 +107,21 @@ public interface JdbcOperations {
* <p>Uses a JDBC Statement, not a PreparedStatement. If you want to
* execute a static query with a PreparedStatement, use the overloaded
* {@code query} method with {@code null} as argument array.
- * @param sql SQL query to execute
- * @param rch object that will extract results, one row at a time
+ * @param sql the SQL query to execute
+ * @param rch a callback that will extract results, one row at a time
* @throws DataAccessException if there is any problem executing the query
* @see #query(String, Object[], RowCallbackHandler)
*/
void query(String sql, RowCallbackHandler rch) throws DataAccessException;
/**
- * Execute a query given static SQL, mapping each row to a Java object
+ * Execute a query given static SQL, mapping each row to a result object
* via a RowMapper.
* <p>Uses a JDBC Statement, not a PreparedStatement. If you want to
* execute a static query with a PreparedStatement, use the overloaded
* {@code query} method with {@code null} as argument array.
- * @param sql SQL query to execute
- * @param rowMapper object that will map one object per row
+ * @param sql the SQL query to execute
+ * @param rowMapper a callback that will map one object per row
* @return the result List, containing mapped objects
* @throws DataAccessException if there is any problem executing the query
* @see #query(String, Object[], RowMapper)
@@ -129,14 +129,14 @@ public interface JdbcOperations {
<T> List<T> query(String sql, RowMapper<T> rowMapper) throws DataAccessException;
/**
- * Execute a query given static SQL, mapping a single result row to a Java
- * object via a RowMapper.
+ * Execute a query given static SQL, mapping a single result row to a
+ * result object via a RowMapper.
* <p>Uses a JDBC Statement, not a PreparedStatement. If you want to
* execute a static query with a PreparedStatement, use the overloaded
* {@link #queryForObject(String, RowMapper, Object...)} method with
* {@code null} as argument array.
- * @param sql SQL query to execute
- * @param rowMapper object that will map one object per row
+ * @param sql the SQL query to execute
+ * @param rowMapper a callback that will map one object per row
* @return the single mapped object (may be {@code null} if the given
* {@link RowMapper} returned {@code} null)
* @throws IncorrectResultSizeDataAccessException if the query does not
@@ -155,7 +155,7 @@ public interface JdbcOperations {
* <p>This method is useful for running static SQL with a known outcome.
* The query is expected to be a single row/single column query; the returned
* result will be directly mapped to the corresponding object type.
- * @param sql SQL query to execute
+ * @param sql the SQL query to execute
* @param requiredType the type that the result object is expected to match
* @return the result object of the required type, or {@code null} in case of SQL NULL
* @throws IncorrectResultSizeDataAccessException if the query does not return
@@ -166,16 +166,15 @@ public interface JdbcOperations {
<T> T queryForObject(String sql, Class<T> requiredType) throws DataAccessException;
/**
- * Execute a query for a result Map, given static SQL.
+ * Execute a query for a result map, given static SQL.
* <p>Uses a JDBC Statement, not a PreparedStatement. If you want to
* execute a static query with a PreparedStatement, use the overloaded
* {@link #queryForMap(String, Object...)} method with {@code null}
* as argument array.
* <p>The query is expected to be a single row query; the result row will be
* mapped to a Map (one entry for each column, using the column name as the key).
- * @param sql SQL query to execute
- * @return the result Map (one entry for each column, using the
- * column name as the key)
+ * @param sql the SQL query to execute
+ * @return the result Map (one entry per column, with column name as key)
* @throws IncorrectResultSizeDataAccessException if the query does not
* return exactly one row
* @throws DataAccessException if there is any problem executing the query
@@ -191,7 +190,7 @@ public interface JdbcOperations {
* {@code queryForList} method with {@code null} as argument array.
* <p>The results will be mapped to a List (one entry for each row) of
* result objects, each of them matching the specified element type.
- * @param sql SQL query to execute
+ * @param sql the SQL query to execute
* @param elementType the required type of element in the result list
* (for example, {@code Integer.class})
* @return a List of objects that match the specified element type
@@ -209,8 +208,8 @@ public interface JdbcOperations {
* <p>The results will be mapped to a List (one entry for each row) of
* Maps (one entry for each column using the column name as the key).
* Each element in the list will be of the form returned by this interface's
- * queryForMap() methods.
- * @param sql SQL query to execute
+ * {@code queryForMap} methods.
+ * @param sql the SQL query to execute
* @return an List that contains a Map per row
* @throws DataAccessException if there is any problem executing the query
* @see #queryForList(String, Object[])
@@ -228,7 +227,7 @@ public interface JdbcOperations {
* be available at runtime: by default, Sun's {@code com.sun.rowset.CachedRowSetImpl}
* class is used, which is part of JDK 1.5+ and also available separately as part of
* Sun's JDBC RowSet Implementations download (rowset.jar).
- * @param sql SQL query to execute
+ * @param sql the SQL query to execute
* @return a SqlRowSet representation (possibly a wrapper around a
* {@code javax.sql.rowset.CachedRowSet})
* @throws DataAccessException if there is any problem executing the query
@@ -264,14 +263,14 @@ public interface JdbcOperations {
/**
* Execute a JDBC data access operation, implemented as callback action
* working on a JDBC PreparedStatement. This allows for implementing arbitrary
- * data access operations on a single Statement, within Spring's managed
- * JDBC environment: that is, participating in Spring-managed transactions
- * and converting JDBC SQLExceptions into Spring's DataAccessException hierarchy.
- * <p>The callback action can return a result object, for example a
- * domain object or a collection of domain objects.
- * @param psc object that can create a PreparedStatement given a Connection
- * @param action callback object that specifies the action
- * @return a result object returned by the action, or {@code null}
+ * data access operations on a single Statement, within Spring's managed JDBC
+ * environment: that is, participating in Spring-managed transactions and
+ * converting JDBC SQLExceptions into Spring's DataAccessException hierarchy.
+ * <p>The callback action can return a result object, for example a domain
+ * object or a collection of domain objects.
+ * @param psc a callback that creates a PreparedStatement given a Connection
+ * @param action a callback that specifies the action
+ * @return a result object returned by the action, or {@code null} if none
* @throws DataAccessException if there is any problem
*/
<T> T execute(PreparedStatementCreator psc, PreparedStatementCallback<T> action) throws DataAccessException;
@@ -279,25 +278,24 @@ public interface JdbcOperations {
/**
* Execute a JDBC data access operation, implemented as callback action
* working on a JDBC PreparedStatement. This allows for implementing arbitrary
- * data access operations on a single Statement, within Spring's managed
- * JDBC environment: that is, participating in Spring-managed transactions
- * and converting JDBC SQLExceptions into Spring's DataAccessException hierarchy.
- * <p>The callback action can return a result object, for example a
- * domain object or a collection of domain objects.
- * @param sql SQL to execute
- * @param action callback object that specifies the action
- * @return a result object returned by the action, or {@code null}
+ * data access operations on a single Statement, within Spring's managed JDBC
+ * environment: that is, participating in Spring-managed transactions and
+ * converting JDBC SQLExceptions into Spring's DataAccessException hierarchy.
+ * <p>The callback action can return a result object, for example a domain
+ * object or a collection of domain objects.
+ * @param sql the SQL to execute
+ * @param action a callback that specifies the action
+ * @return a result object returned by the action, or {@code null} if none
* @throws DataAccessException if there is any problem
*/
<T> T execute(String sql, PreparedStatementCallback<T> action) throws DataAccessException;
/**
- * Query using a prepared statement, reading the ResultSet with a
- * ResultSetExtractor.
+ * Query using a prepared statement, reading the ResultSet with a ResultSetExtractor.
* <p>A PreparedStatementCreator can either be implemented directly or
* configured through a PreparedStatementCreatorFactory.
- * @param psc object that can create a PreparedStatement given a Connection
- * @param rse object that will extract results
+ * @param psc a callback that creates a PreparedStatement given a Connection
+ * @param rse a callback that will extract results
* @return an arbitrary result object, as returned by the ResultSetExtractor
* @throws DataAccessException if there is any problem
* @see PreparedStatementCreatorFactory
@@ -305,28 +303,26 @@ public interface JdbcOperations {
<T> T query(PreparedStatementCreator psc, ResultSetExtractor<T> rse) throws DataAccessException;
/**
- * Query using a prepared statement, reading the ResultSet with a
- * ResultSetExtractor.
- * @param sql SQL query to execute
- * @param pss object that knows how to set values on the prepared statement.
+ * Query using a prepared statement, reading the ResultSet with a ResultSetExtractor.
+ * @param sql the SQL query to execute
+ * @param pss a callback that knows how to set values on the prepared statement.
* If this is {@code null}, the SQL will be assumed to contain no bind parameters.
- * Even if there are no bind parameters, this object may be used to
- * set fetch size and other performance options.
- * @param rse object that will extract results
+ * Even if there are no bind parameters, this callback may be used to set the
+ * fetch size and other performance options.
+ * @param rse a callback that will extract results
* @return an arbitrary result object, as returned by the ResultSetExtractor
* @throws DataAccessException if there is any problem
*/
<T> T query(String sql, PreparedStatementSetter pss, ResultSetExtractor<T> rse) throws DataAccessException;
/**
- * Query given SQL to create a prepared statement from SQL and a list
- * of arguments to bind to the query, reading the ResultSet with a
- * ResultSetExtractor.
- * @param sql SQL query to execute
+ * Query given SQL to create a prepared statement from SQL and a list of arguments
+ * to bind to the query, reading the ResultSet with a ResultSetExtractor.
+ * @param sql the SQL query to execute
* @param args arguments to bind to the query
- * @param argTypes SQL types of the arguments
+ * @param argTypes the SQL types of the arguments
* (constants from {@code java.sql.Types})
- * @param rse object that will extract results
+ * @param rse a callback that will extract results
* @return an arbitrary result object, as returned by the ResultSetExtractor
* @throws DataAccessException if the query fails
* @see java.sql.Types
@@ -334,26 +330,24 @@ public interface JdbcOperations {
<T> T query(String sql, Object[] args, int[] argTypes, ResultSetExtractor<T> rse) throws DataAccessException;
/**
- * Query given SQL to create a prepared statement from SQL and a list
- * of arguments to bind to the query, reading the ResultSet with a
- * ResultSetExtractor.
- * @param sql SQL query to execute
+ * Query given SQL to create a prepared statement from SQL and a list of arguments
+ * to bind to the query, reading the ResultSet with a ResultSetExtractor.
+ * @param sql the SQL query to execute
* @param args arguments to bind to the query
* (leaving it to the PreparedStatement to guess the corresponding SQL type);
* may also contain {@link SqlParameterValue} objects which indicate not
* only the argument value but also the SQL type and optionally the scale
- * @param rse object that will extract results
+ * @param rse a callback that will extract results
* @return an arbitrary result object, as returned by the ResultSetExtractor
* @throws DataAccessException if the query fails
*/
<T> T query(String sql, Object[] args, ResultSetExtractor<T> rse) throws DataAccessException;
/**
- * Query given SQL to create a prepared statement from SQL and a list
- * of arguments to bind to the query, reading the ResultSet with a
- * ResultSetExtractor.
- * @param sql SQL query to execute
- * @param rse object that will extract results
+ * Query given SQL to create a prepared statement from SQL and a list of arguments
+ * to bind to the query, reading the ResultSet with a ResultSetExtractor.
+ * @param sql the SQL query to execute
+ * @param rse a callback that will extract results
* @param args arguments to bind to the query
* (leaving it to the PreparedStatement to guess the corresponding SQL type);
* may also contain {@link SqlParameterValue} objects which indicate not
@@ -365,12 +359,12 @@ public interface JdbcOperations {
<T> T query(String sql, ResultSetExtractor<T> rse, Object... args) throws DataAccessException;
/**
- * Query using a prepared statement, reading the ResultSet on a per-row
- * basis with a RowCallbackHandler.
+ * Query using a prepared statement, reading the ResultSet on a per-row basis
+ * with a RowCallbackHandler.
* <p>A PreparedStatementCreator can either be implemented directly or
* configured through a PreparedStatementCreatorFactory.
- * @param psc object that can create a PreparedStatement given a Connection
- * @param rch object that will extract results, one row at a time
+ * @param psc a callback that creates a PreparedStatement given a Connection
+ * @param rch a callback that will extract results, one row at a time
* @throws DataAccessException if there is any problem
* @see PreparedStatementCreatorFactory
*/
@@ -378,15 +372,14 @@ public interface JdbcOperations {
/**
* Query given SQL to create a prepared statement from SQL and a
- * PreparedStatementSetter implementation that knows how to bind values
- * to the query, reading the ResultSet on a per-row basis with a
- * RowCallbackHandler.
- * @param sql SQL query to execute
- * @param pss object that knows how to set values on the prepared statement.
+ * PreparedStatementSetter implementation that knows how to bind values to the
+ * query, reading the ResultSet on a per-row basis with a RowCallbackHandler.
+ * @param sql the SQL query to execute
+ * @param pss a callback that knows how to set values on the prepared statement.
* If this is {@code null}, the SQL will be assumed to contain no bind parameters.
- * Even if there are no bind parameters, this object may be used to
- * set fetch size and other performance options.
- * @param rch object that will extract results, one row at a time
+ * Even if there are no bind parameters, this callback may be used to set the
+ * fetch size and other performance options.
+ * @param rch a callback that will extract results, one row at a time
* @throws DataAccessException if the query fails
*/
void query(String sql, PreparedStatementSetter pss, RowCallbackHandler rch) throws DataAccessException;
@@ -395,11 +388,11 @@ public interface JdbcOperations {
* Query given SQL to create a prepared statement from SQL and a list of
* arguments to bind to the query, reading the ResultSet on a per-row basis
* with a RowCallbackHandler.
- * @param sql SQL query to execute
+ * @param sql the SQL query to execute
* @param args arguments to bind to the query
- * @param argTypes SQL types of the arguments
+ * @param argTypes the SQL types of the arguments
* (constants from {@code java.sql.Types})
- * @param rch object that will extract results, one row at a time
+ * @param rch a callback that will extract results, one row at a time
* @throws DataAccessException if the query fails
* @see java.sql.Types
*/
@@ -409,12 +402,12 @@ public interface JdbcOperations {
* Query given SQL to create a prepared statement from SQL and a list of
* arguments to bind to the query, reading the ResultSet on a per-row basis
* with a RowCallbackHandler.
- * @param sql SQL query to execute
+ * @param sql the SQL query to execute
* @param args arguments to bind to the query
* (leaving it to the PreparedStatement to guess the corresponding SQL type);
* may also contain {@link SqlParameterValue} objects which indicate not
* only the argument value but also the SQL type and optionally the scale
- * @param rch object that will extract results, one row at a time
+ * @param rch a callback that will extract results, one row at a time
* @throws DataAccessException if the query fails
*/
void query(String sql, Object[] args, RowCallbackHandler rch) throws DataAccessException;
@@ -423,8 +416,8 @@ public interface JdbcOperations {
* Query given SQL to create a prepared statement from SQL and a list of
* arguments to bind to the query, reading the ResultSet on a per-row basis
* with a RowCallbackHandler.
- * @param sql SQL query to execute
- * @param rch object that will extract results, one row at a time
+ * @param sql the SQL query to execute
+ * @param rch a callback that will extract results, one row at a time
* @param args arguments to bind to the query
* (leaving it to the PreparedStatement to guess the corresponding SQL type);
* may also contain {@link SqlParameterValue} objects which indicate not
@@ -435,12 +428,12 @@ public interface JdbcOperations {
void query(String sql, RowCallbackHandler rch, Object... args) throws DataAccessException;
/**
- * Query using a prepared statement, mapping each row to a Java object
+ * Query using a prepared statement, mapping each row to a result object
* via a RowMapper.
* <p>A PreparedStatementCreator can either be implemented directly or
* configured through a PreparedStatementCreatorFactory.
- * @param psc object that can create a PreparedStatement given a Connection
- * @param rowMapper object that will map one object per row
+ * @param psc a callback that creates a PreparedStatement given a Connection
+ * @param rowMapper a callback that will map one object per row
* @return the result List, containing mapped objects
* @throws DataAccessException if there is any problem
* @see PreparedStatementCreatorFactory
@@ -450,27 +443,27 @@ public interface JdbcOperations {
/**
* Query given SQL to create a prepared statement from SQL and a
* PreparedStatementSetter implementation that knows how to bind values
- * to the query, mapping each row to a Java object via a RowMapper.
- * @param sql SQL query to execute
- * @param pss object that knows how to set values on the prepared statement.
+ * to the query, mapping each row to a result object via a RowMapper.
+ * @param sql the SQL query to execute
+ * @param pss a callback that knows how to set values on the prepared statement.
* If this is {@code null}, the SQL will be assumed to contain no bind parameters.
- * Even if there are no bind parameters, this object may be used to
- * set fetch size and other performance options.
- * @param rowMapper object that will map one object per row
+ * Even if there are no bind parameters, this callback may be used to set the
+ * fetch size and other performance options.
+ * @param rowMapper a callback that will map one object per row
* @return the result List, containing mapped objects
* @throws DataAccessException if the query fails
*/
<T> List<T> query(String sql, PreparedStatementSetter pss, RowMapper<T> rowMapper) throws DataAccessException;
/**
- * Query given SQL to create a prepared statement from SQL and a list
- * of arguments to bind to the query, mapping each row to a Java object
+ * Query given SQL to create a prepared statement from SQL and a list of
+ * arguments to bind to the query, mapping each row to a result object
* via a RowMapper.
- * @param sql SQL query to execute
+ * @param sql the SQL query to execute
* @param args arguments to bind to the query
- * @param argTypes SQL types of the arguments
+ * @param argTypes the SQL types of the arguments
* (constants from {@code java.sql.Types})
- * @param rowMapper object that will map one object per row
+ * @param rowMapper a callback that will map one object per row
* @return the result List, containing mapped objects
* @throws DataAccessException if the query fails
* @see java.sql.Types
@@ -478,26 +471,26 @@ public interface JdbcOperations {
<T> List<T> query(String sql, Object[] args, int[] argTypes, RowMapper<T> rowMapper) throws DataAccessException;
/**
- * Query given SQL to create a prepared statement from SQL and a list
- * of arguments to bind to the query, mapping each row to a Java object
+ * Query given SQL to create a prepared statement from SQL and a list of
+ * arguments to bind to the query, mapping each row to a result object
* via a RowMapper.
- * @param sql SQL query to execute
+ * @param sql the SQL query to execute
* @param args arguments to bind to the query
* (leaving it to the PreparedStatement to guess the corresponding SQL type);
* may also contain {@link SqlParameterValue} objects which indicate not
* only the argument value but also the SQL type and optionally the scale
- * @param rowMapper object that will map one object per row
+ * @param rowMapper a callback that will map one object per row
* @return the result List, containing mapped objects
* @throws DataAccessException if the query fails
*/
<T> List<T> query(String sql, Object[] args, RowMapper<T> rowMapper) throws DataAccessException;
/**
- * Query given SQL to create a prepared statement from SQL and a list
- * of arguments to bind to the query, mapping each row to a Java object
+ * Query given SQL to create a prepared statement from SQL and a list of
+ * arguments to bind to the query, mapping each row to a result object
* via a RowMapper.
- * @param sql SQL query to execute
- * @param rowMapper object that will map one object per row
+ * @param sql the SQL query to execute
+ * @param rowMapper a callback that will map one object per row
* @param args arguments to bind to the query
* (leaving it to the PreparedStatement to guess the corresponding SQL type);
* may also contain {@link SqlParameterValue} objects which indicate not
@@ -511,13 +504,13 @@ public interface JdbcOperations {
/**
* Query given SQL to create a prepared statement from SQL and a list
* of arguments to bind to the query, mapping a single result row to a
- * Java object via a RowMapper.
- * @param sql SQL query to execute
+ * result object via a RowMapper.
+ * @param sql the SQL query to execute
* @param args arguments to bind to the query
* (leaving it to the PreparedStatement to guess the corresponding SQL type)
- * @param argTypes SQL types of the arguments
+ * @param argTypes the SQL types of the arguments
* (constants from {@code java.sql.Types})
- * @param rowMapper object that will map one object per row
+ * @param rowMapper a callback that will map one object per row
* @return the single mapped object (may be {@code null} if the given
* {@link RowMapper} returned {@code} null)
* @throws IncorrectResultSizeDataAccessException if the query does not
@@ -530,13 +523,13 @@ public interface JdbcOperations {
/**
* Query given SQL to create a prepared statement from SQL and a list
* of arguments to bind to the query, mapping a single result row to a
- * Java object via a RowMapper.
- * @param sql SQL query to execute
+ * result object via a RowMapper.
+ * @param sql the SQL query to execute
* @param args arguments to bind to the query
* (leaving it to the PreparedStatement to guess the corresponding SQL type);
* may also contain {@link SqlParameterValue} objects which indicate not
* only the argument value but also the SQL type and optionally the scale
- * @param rowMapper object that will map one object per row
+ * @param rowMapper a callback that will map one object per row
* @return the single mapped object (may be {@code null} if the given
* {@link RowMapper} returned {@code} null)
* @throws IncorrectResultSizeDataAccessException if the query does not
@@ -548,9 +541,9 @@ public interface JdbcOperations {
/**
* Query given SQL to create a prepared statement from SQL and a list
* of arguments to bind to the query, mapping a single result row to a
- * Java object via a RowMapper.
- * @param sql SQL query to execute
- * @param rowMapper object that will map one object per row
+ * result object via a RowMapper.
+ * @param sql the SQL query to execute
+ * @param rowMapper a callback that will map one object per row
* @param args arguments to bind to the query
* (leaving it to the PreparedStatement to guess the corresponding SQL type);
* may also contain {@link SqlParameterValue} objects which indicate not
@@ -565,13 +558,13 @@ public interface JdbcOperations {
<T> T queryForObject(String sql, RowMapper<T> rowMapper, Object... args) throws DataAccessException;
/**
- * Query given SQL to create a prepared statement from SQL and a
- * list of arguments to bind to the query, expecting a result object.
+ * Query given SQL to create a prepared statement from SQL and a list of
+ * arguments to bind to the query, expecting a result object.
* <p>The query is expected to be a single row/single column query; the returned
* result will be directly mapped to the corresponding object type.
- * @param sql SQL query to execute
+ * @param sql the SQL query to execute
* @param args arguments to bind to the query
- * @param argTypes SQL types of the arguments
+ * @param argTypes the SQL types of the arguments
* (constants from {@code java.sql.Types})
* @param requiredType the type that the result object is expected to match
* @return the result object of the required type, or {@code null} in case of SQL NULL
@@ -585,11 +578,11 @@ public interface JdbcOperations {
throws DataAccessException;
/**
- * Query given SQL to create a prepared statement from SQL and a
- * list of arguments to bind to the query, expecting a result object.
+ * Query given SQL to create a prepared statement from SQL and a list of
+ * arguments to bind to the query, expecting a result object.
* <p>The query is expected to be a single row/single column query; the returned
* result will be directly mapped to the corresponding object type.
- * @param sql SQL query to execute
+ * @param sql the SQL query to execute
* @param args arguments to bind to the query
* (leaving it to the PreparedStatement to guess the corresponding SQL type);
* may also contain {@link SqlParameterValue} objects which indicate not
@@ -604,11 +597,11 @@ public interface JdbcOperations {
<T> T queryForObject(String sql, Object[] args, Class<T> requiredType) throws DataAccessException;
/**
- * Query given SQL to create a prepared statement from SQL and a
- * list of arguments to bind to the query, expecting a result object.
+ * Query given SQL to create a prepared statement from SQL and a list of
+ * arguments to bind to the query, expecting a result object.
* <p>The query is expected to be a single row/single column query; the returned
* result will be directly mapped to the corresponding object type.
- * @param sql SQL query to execute
+ * @param sql the SQL query to execute
* @param requiredType the type that the result object is expected to match
* @param args arguments to bind to the query
* (leaving it to the PreparedStatement to guess the corresponding SQL type);
@@ -624,16 +617,15 @@ public interface JdbcOperations {
<T> T queryForObject(String sql, Class<T> requiredType, Object... args) throws DataAccessException;
/**
- * Query given SQL to create a prepared statement from SQL and a
- * list of arguments to bind to the query, expecting a result Map.
+ * Query given SQL to create a prepared statement from SQL and a list of
+ * arguments to bind to the query, expecting a result map.
* <p>The query is expected to be a single row query; the result row will be
* mapped to a Map (one entry for each column, using the column name as the key).
- * @param sql SQL query to execute
+ * @param sql the SQL query to execute
* @param args arguments to bind to the query
- * @param argTypes SQL types of the arguments
+ * @param argTypes the SQL types of the arguments
* (constants from {@code java.sql.Types})
- * @return the result Map (one entry for each column, using the
- * column name as the key)
+ * @return the result Map (one entry per column, with column name as key)
* @throws IncorrectResultSizeDataAccessException if the query does not
* return exactly one row
* @throws DataAccessException if the query fails
@@ -644,14 +636,14 @@ public interface JdbcOperations {
Map<String, Object> queryForMap(String sql, Object[] args, int[] argTypes) throws DataAccessException;
/**
- * Query given SQL to create a prepared statement from SQL and a
- * list of arguments to bind to the query, expecting a result Map.
- * The queryForMap() methods defined by this interface are appropriate
- * when you don't have a domain model. Otherwise, consider using
- * one of the queryForObject() methods.
+ * Query given SQL to create a prepared statement from SQL and a list of
+ * arguments to bind to the query, expecting a result map.
+ * <p>The {@code queryForMap} methods defined by this interface are appropriate
+ * when you don't have a domain model. Otherwise, consider using one of the
+ * {@code queryForObject} methods.
* <p>The query is expected to be a single row query; the result row will be
* mapped to a Map (one entry for each column, using the column name as the key).
- * @param sql SQL query to execute
+ * @param sql the SQL query to execute
* @param args arguments to bind to the query
* (leaving it to the PreparedStatement to guess the corresponding SQL type);
* may also contain {@link SqlParameterValue} objects which indicate not
@@ -667,13 +659,13 @@ public interface JdbcOperations {
Map<String, Object> queryForMap(String sql, Object... args) throws DataAccessException;
/**
- * Query given SQL to create a prepared statement from SQL and a
- * list of arguments to bind to the query, expecting a result list.
+ * Query given SQL to create a prepared statement from SQL and a list of
+ * arguments to bind to the query, expecting a result list.
* <p>The results will be mapped to a List (one entry for each row) of
* result objects, each of them matching the specified element type.
- * @param sql SQL query to execute
+ * @param sql the SQL query to execute
* @param args arguments to bind to the query
- * @param argTypes SQL types of the arguments
+ * @param argTypes the SQL types of the arguments
* (constants from {@code java.sql.Types})
* @param elementType the required type of element in the result list
* (for example, {@code Integer.class})
@@ -682,15 +674,15 @@ public interface JdbcOperations {
* @see #queryForList(String, Class)
* @see SingleColumnRowMapper
*/
- <T>List<T> queryForList(String sql, Object[] args, int[] argTypes, Class<T> elementType)
+ <T> List<T> queryForList(String sql, Object[] args, int[] argTypes, Class<T> elementType)
throws DataAccessException;
/**
- * Query given SQL to create a prepared statement from SQL and a
- * list of arguments to bind to the query, expecting a result list.
+ * Query given SQL to create a prepared statement from SQL and a list of
+ * arguments to bind to the query, expecting a result list.
* <p>The results will be mapped to a List (one entry for each row) of
* result objects, each of them matching the specified element type.
- * @param sql SQL query to execute
+ * @param sql the SQL query to execute
* @param args arguments to bind to the query
* (leaving it to the PreparedStatement to guess the corresponding SQL type);
* may also contain {@link SqlParameterValue} objects which indicate not
@@ -705,11 +697,11 @@ public interface JdbcOperations {
<T> List<T> queryForList(String sql, Object[] args, Class<T> elementType) throws DataAccessException;
/**
- * Query given SQL to create a prepared statement from SQL and a
- * list of arguments to bind to the query, expecting a result list.
+ * Query given SQL to create a prepared statement from SQL and a list of
+ * arguments to bind to the query, expecting a result list.
* <p>The results will be mapped to a List (one entry for each row) of
* result objects, each of them matching the specified element type.
- * @param sql SQL query to execute
+ * @param sql the SQL query to execute
* @param elementType the required type of element in the result list
* (for example, {@code Integer.class})
* @param args arguments to bind to the query
@@ -725,15 +717,15 @@ public interface JdbcOperations {
<T> List<T> queryForList(String sql, Class<T> elementType, Object... args) throws DataAccessException;
/**
- * Query given SQL to create a prepared statement from SQL and a
- * list of arguments to bind to the query, expecting a result list.
+ * Query given SQL to create a prepared statement from SQL and a list of
+ * arguments to bind to the query, expecting a result list.
* <p>The results will be mapped to a List (one entry for each row) of
* Maps (one entry for each column, using the column name as the key).
- * Thus Each element in the list will be of the form returned by this interface's
- * queryForMap() methods.
- * @param sql SQL query to execute
+ * Each element in the list will be of the form returned by this interface's
+ * {@code queryForMap} methods.
+ * @param sql the SQL query to execute
* @param args arguments to bind to the query
- * @param argTypes SQL types of the arguments
+ * @param argTypes the SQL types of the arguments
* (constants from {@code java.sql.Types})
* @return a List that contains a Map per row
* @throws DataAccessException if the query fails
@@ -743,13 +735,13 @@ public interface JdbcOperations {
List<Map<String, Object>> queryForList(String sql, Object[] args, int[] argTypes) throws DataAccessException;
/**
- * Query given SQL to create a prepared statement from SQL and a
- * list of arguments to bind to the query, expecting a result list.
+ * Query given SQL to create a prepared statement from SQL and a list of
+ * arguments to bind to the query, expecting a result list.
* <p>The results will be mapped to a List (one entry for each row) of
* Maps (one entry for each column, using the column name as the key).
* Each element in the list will be of the form returned by this interface's
- * queryForMap() methods.
- * @param sql SQL query to execute
+ * {@code queryForMap} methods.
+ * @param sql the SQL query to execute
* @param args arguments to bind to the query
* (leaving it to the PreparedStatement to guess the corresponding SQL type);
* may also contain {@link SqlParameterValue} objects which indicate not
@@ -761,17 +753,17 @@ public interface JdbcOperations {
List<Map<String, Object>> queryForList(String sql, Object... args) throws DataAccessException;
/**
- * Query given SQL to create a prepared statement from SQL and a
- * list of arguments to bind to the query, expecting a SqlRowSet.
+ * Query given SQL to create a prepared statement from SQL and a list of
+ * arguments to bind to the query, expecting a SqlRowSet.
* <p>The results will be mapped to an SqlRowSet which holds the data in a
* disconnected fashion. This wrapper will translate any SQLExceptions thrown.
* <p>Note that, for the default implementation, JDBC RowSet support needs to
* be available at runtime: by default, Sun's {@code com.sun.rowset.CachedRowSetImpl}
* class is used, which is part of JDK 1.5+ and also available separately as part of
* Sun's JDBC RowSet Implementations download (rowset.jar).
- * @param sql SQL query to execute
+ * @param sql the SQL query to execute
* @param args arguments to bind to the query
- * @param argTypes SQL types of the arguments
+ * @param argTypes the SQL types of the arguments
* (constants from {@code java.sql.Types})
* @return a SqlRowSet representation (possibly a wrapper around a
* {@code javax.sql.rowset.CachedRowSet})
@@ -784,15 +776,15 @@ public interface JdbcOperations {
SqlRowSet queryForRowSet(String sql, Object[] args, int[] argTypes) throws DataAccessException;
/**
- * Query given SQL to create a prepared statement from SQL and a
- * list of arguments to bind to the query, expecting a SqlRowSet.
+ * Query given SQL to create a prepared statement from SQL and a list of
+ * arguments to bind to the query, expecting a SqlRowSet.
* <p>The results will be mapped to an SqlRowSet which holds the data in a
* disconnected fashion. This wrapper will translate any SQLExceptions thrown.
* <p>Note that, for the default implementation, JDBC RowSet support needs to
* be available at runtime: by default, Sun's {@code com.sun.rowset.CachedRowSetImpl}
* class is used, which is part of JDK 1.5+ and also available separately as part of
* Sun's JDBC RowSet Implementations download (rowset.jar).
- * @param sql SQL query to execute
+ * @param sql the SQL query to execute
* @param args arguments to bind to the query
* (leaving it to the PreparedStatement to guess the corresponding SQL type);
* may also contain {@link SqlParameterValue} objects which indicate not
@@ -807,11 +799,12 @@ public interface JdbcOperations {
SqlRowSet queryForRowSet(String sql, Object... args) throws DataAccessException;
/**
- * Issue a single SQL update operation (such as an insert, update or delete statement)
- * using a PreparedStatementCreator to provide SQL and any required parameters.
+ * Issue a single SQL update operation (such as an insert, update or delete
+ * statement) using a PreparedStatementCreator to provide SQL and any
+ * required parameters.
* <p>A PreparedStatementCreator can either be implemented directly or
* configured through a PreparedStatementCreatorFactory.
- * @param psc object that provides SQL and any necessary parameters
+ * @param psc a callback that provides SQL and any necessary parameters
* @return the number of rows affected
* @throws DataAccessException if there is any problem issuing the update
* @see PreparedStatementCreatorFactory
@@ -824,8 +817,8 @@ public interface JdbcOperations {
* <p>Note that the given PreparedStatementCreator has to create a statement
* with activated extraction of generated keys (a JDBC 3.0 feature). This can
* either be done directly or through using a PreparedStatementCreatorFactory.
- * @param psc object that provides SQL and any necessary parameters
- * @param generatedKeyHolder KeyHolder that will hold the generated keys
+ * @param psc a callback that provides SQL and any necessary parameters
+ * @param generatedKeyHolder a KeyHolder that will hold the generated keys
* @return the number of rows affected
* @throws DataAccessException if there is any problem issuing the update
* @see PreparedStatementCreatorFactory
@@ -838,7 +831,7 @@ public interface JdbcOperations {
* with given SQL. Simpler than using a PreparedStatementCreator as this method
* will create the PreparedStatement: The PreparedStatementSetter just needs to
* set parameters.
- * @param sql SQL containing bind parameters
+ * @param sql the SQL containing bind parameters
* @param pss helper that sets bind parameters. If this is {@code null}
* we run an update with static SQL.
* @return the number of rows affected
@@ -849,9 +842,9 @@ public interface JdbcOperations {
/**
* Issue a single SQL update operation (such as an insert, update or delete statement)
* via a prepared statement, binding the given arguments.
- * @param sql SQL containing bind parameters
+ * @param sql the SQL containing bind parameters
* @param args arguments to bind to the query
- * @param argTypes SQL types of the arguments
+ * @param argTypes the SQL types of the arguments
* (constants from {@code java.sql.Types})
* @return the number of rows affected
* @throws DataAccessException if there is any problem issuing the update
@@ -862,7 +855,7 @@ public interface JdbcOperations {
/**
* Issue a single SQL update operation (such as an insert, update or delete statement)
* via a prepared statement, binding the given arguments.
- * @param sql SQL containing bind parameters
+ * @param sql the SQL containing bind parameters
* @param args arguments to bind to the query
* (leaving it to the PreparedStatement to guess the corresponding SQL type);
* may also contain {@link SqlParameterValue} objects which indicate not
@@ -898,7 +891,7 @@ public interface JdbcOperations {
* Execute a batch using the supplied SQL statement with the batch of supplied arguments.
* @param sql the SQL statement to execute.
* @param batchArgs the List of Object arrays containing the batch of arguments for the query
- * @param argTypes SQL types of the arguments
+ * @param argTypes the SQL types of the arguments
* (constants from {@code java.sql.Types})
* @return an array containing the numbers of rows affected by each update in the batch
*/
@@ -911,7 +904,7 @@ public interface JdbcOperations {
* @param sql the SQL statement to execute.
* @param batchArgs the List of Object arrays containing the batch of arguments for the query
* @param batchSize batch size
- * @param pss ParameterizedPreparedStatementSetter to use
+ * @param pss the ParameterizedPreparedStatementSetter to use
* @return an array containing for each batch another array containing the numbers of rows affected
* by each update in the batch
* @since 3.1
@@ -927,14 +920,14 @@ public interface JdbcOperations {
/**
* Execute a JDBC data access operation, implemented as callback action
* working on a JDBC CallableStatement. This allows for implementing arbitrary
- * data access operations on a single Statement, within Spring's managed
- * JDBC environment: that is, participating in Spring-managed transactions
- * and converting JDBC SQLExceptions into Spring's DataAccessException hierarchy.
- * <p>The callback action can return a result object, for example a
- * domain object or a collection of domain objects.
- * @param csc object that can create a CallableStatement given a Connection
- * @param action callback object that specifies the action
- * @return a result object returned by the action, or {@code null}
+ * data access operations on a single Statement, within Spring's managed JDBC
+ * environment: that is, participating in Spring-managed transactions and
+ * converting JDBC SQLExceptions into Spring's DataAccessException hierarchy.
+ * <p>The callback action can return a result object, for example a domain
+ * object or a collection of domain objects.
+ * @param csc a callback that creates a CallableStatement given a Connection
+ * @param action a callback that specifies the action
+ * @return a result object returned by the action, or {@code null} if none
* @throws DataAccessException if there is any problem
*/
<T> T execute(CallableStatementCreator csc, CallableStatementCallback<T> action) throws DataAccessException;
@@ -942,24 +935,24 @@ public interface JdbcOperations {
/**
* Execute a JDBC data access operation, implemented as callback action
* working on a JDBC CallableStatement. This allows for implementing arbitrary
- * data access operations on a single Statement, within Spring's managed
- * JDBC environment: that is, participating in Spring-managed transactions
- * and converting JDBC SQLExceptions into Spring's DataAccessException hierarchy.
- * <p>The callback action can return a result object, for example a
- * domain object or a collection of domain objects.
+ * data access operations on a single Statement, within Spring's managed JDBC
+ * environment: that is, participating in Spring-managed transactions and
+ * converting JDBC SQLExceptions into Spring's DataAccessException hierarchy.
+ * <p>The callback action can return a result object, for example a domain
+ * object or a collection of domain objects.
* @param callString the SQL call string to execute
- * @param action callback object that specifies the action
- * @return a result object returned by the action, or {@code null}
+ * @param action a callback that specifies the action
+ * @return a result object returned by the action, or {@code null} if none
* @throws DataAccessException if there is any problem
*/
<T> T execute(String callString, CallableStatementCallback<T> action) throws DataAccessException;
/**
- * Execute a SQL call using a CallableStatementCreator to provide SQL and any
- * required parameters.
- * @param csc object that provides SQL and any necessary parameters
+ * Execute a SQL call using a CallableStatementCreator to provide SQL and
+ * any required parameters.
+ * @param csc a callback that provides SQL and any necessary parameters
* @param declaredParameters list of declared SqlParameter objects
- * @return Map of extracted out parameters
+ * @return a Map of extracted out parameters
* @throws DataAccessException if there is any problem issuing the update
*/
Map<String, Object> call(CallableStatementCreator csc, List<SqlParameter> declaredParameters)