From bc283ed7d70570bffba0f2a8c82b8e666a87d9f4 Mon Sep 17 00:00:00 2001 From: Juergen Hoeller Date: Thu, 28 Feb 2019 15:48:14 +0100 Subject: [PATCH] Polishing --- .../jdbc/core/JdbcOperations.java | 73 ++++++++++--------- .../jdbc/core/JdbcTemplate.java | 16 ++-- 2 files changed, 45 insertions(+), 44 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 ff0fbd33d5..cba33bace0 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 @@ -166,14 +166,14 @@ public interface JdbcOperations { T queryForObject(String sql, Class requiredType) throws DataAccessException; /** - * Execute a query for a result Map, given static SQL. + * Execute a query for a result map, given static SQL. *

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. *

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 * @return the result Map (one entry per column, with column name as key) * @throws IncorrectResultSizeDataAccessException if the query does not * return exactly one row @@ -208,7 +208,7 @@ public interface JdbcOperations { *

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. + * {@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 @@ -558,8 +558,8 @@ public interface JdbcOperations { T queryForObject(String sql, RowMapper 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. *

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 the SQL query to execute @@ -578,8 +578,8 @@ 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. *

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 the SQL query to execute @@ -597,8 +597,8 @@ public interface JdbcOperations { T queryForObject(String sql, Object[] args, Class 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. *

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 the SQL query to execute @@ -617,8 +617,8 @@ public interface JdbcOperations { T queryForObject(String sql, Class 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. *

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 the SQL query to execute @@ -636,11 +636,11 @@ public interface JdbcOperations { Map 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. + *

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. *

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 the SQL query to execute @@ -659,8 +659,8 @@ public interface JdbcOperations { Map 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. *

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 the SQL query to execute @@ -674,12 +674,12 @@ public interface JdbcOperations { * @see #queryForList(String, Class) * @see SingleColumnRowMapper */ - List queryForList(String sql, Object[] args, int[] argTypes, Class elementType) + List queryForList(String sql, Object[] args, int[] argTypes, Class 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. *

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 the SQL query to execute @@ -697,8 +697,8 @@ public interface JdbcOperations { List queryForList(String sql, Object[] args, Class 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. *

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 the SQL query to execute @@ -717,12 +717,12 @@ public interface JdbcOperations { List queryForList(String sql, Class 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. *

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. + * 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 the SQL types of the arguments @@ -735,12 +735,12 @@ public interface JdbcOperations { List> 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. *

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. + * {@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); @@ -753,8 +753,8 @@ public interface JdbcOperations { List> 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. *

The results will be mapped to an SqlRowSet which holds the data in a * disconnected fashion. This wrapper will translate any SQLExceptions thrown. *

Note that, for the default implementation, JDBC RowSet support needs to @@ -776,8 +776,8 @@ 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. *

The results will be mapped to an SqlRowSet which holds the data in a * disconnected fashion. This wrapper will translate any SQLExceptions thrown. *

Note that, for the default implementation, JDBC RowSet support needs to @@ -799,8 +799,9 @@ 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. *

A PreparedStatementCreator can either be implemented directly or * configured through a PreparedStatementCreatorFactory. * @param psc a callback that provides SQL and any necessary parameters diff --git a/spring-jdbc/src/main/java/org/springframework/jdbc/core/JdbcTemplate.java b/spring-jdbc/src/main/java/org/springframework/jdbc/core/JdbcTemplate.java index c3d0ec3886..951e944198 100644 --- a/spring-jdbc/src/main/java/org/springframework/jdbc/core/JdbcTemplate.java +++ b/spring-jdbc/src/main/java/org/springframework/jdbc/core/JdbcTemplate.java @@ -1145,12 +1145,12 @@ public class JdbcTemplate extends JdbcAccessor implements JdbcOperations { logger.debug("CallableStatement.execute() returned '" + retVal + "'"); logger.debug("CallableStatement.getUpdateCount() returned " + updateCount); } - Map returnedResults = createResultsMap(); + Map resultsMap = createResultsMap(); if (retVal || updateCount != -1) { - returnedResults.putAll(extractReturnedResults(cs, updateCountParameters, resultSetParameters, updateCount)); + resultsMap.putAll(extractReturnedResults(cs, updateCountParameters, resultSetParameters, updateCount)); } - returnedResults.putAll(extractOutputParameters(cs, callParameters)); - return returnedResults; + resultsMap.putAll(extractOutputParameters(cs, callParameters)); + return resultsMap; } }); } @@ -1283,8 +1283,8 @@ public class JdbcTemplate extends JdbcAccessor implements JdbcOperations { } if (param.getRowMapper() != null) { RowMapper rowMapper = param.getRowMapper(); - Object result = (new RowMapperResultSetExtractor(rowMapper)).extractData(rsToUse); - return Collections.singletonMap(param.getName(), result); + Object data = (new RowMapperResultSetExtractor(rowMapper)).extractData(rsToUse); + return Collections.singletonMap(param.getName(), data); } else if (param.getRowCallbackHandler() != null) { RowCallbackHandler rch = param.getRowCallbackHandler(); @@ -1293,8 +1293,8 @@ public class JdbcTemplate extends JdbcAccessor implements JdbcOperations { (Object) "ResultSet returned from stored procedure was processed"); } else if (param.getResultSetExtractor() != null) { - Object result = param.getResultSetExtractor().extractData(rsToUse); - return Collections.singletonMap(param.getName(), result); + Object data = param.getResultSetExtractor().extractData(rsToUse); + return Collections.singletonMap(param.getName(), data); } } finally {