Polishing

Author: jhoeller

spring-jdbc/src/main/java/org/springframework/jdbc/core/JdbcOperations.java

@@ -166,14 +166,14 @@ 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
+	 * @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 {
 	 * <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.
+	 * {@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 @@ <T> T queryForObject(String sql, Object[] args, int[] argTypes, RowMapper<T> row
 	<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 the SQL query to execute
@@ -578,8 +578,8 @@ <T> T queryForObject(String sql, Object[] args, int[] argTypes, Class<T> require
 			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 the SQL query to execute
@@ -597,8 +597,8 @@ <T> T queryForObject(String sql, Object[] args, int[] argTypes, Class<T> require
 	<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 the SQL query to execute
@@ -617,8 +617,8 @@ <T> T queryForObject(String sql, Object[] args, int[] argTypes, Class<T> require
 	<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 the SQL query to execute
@@ -636,11 +636,11 @@ <T> T queryForObject(String sql, Object[] args, int[] argTypes, Class<T> require
 	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 the SQL query to execute
@@ -659,8 +659,8 @@ <T> T queryForObject(String sql, Object[] args, int[] argTypes, Class<T> require
 	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 the SQL query to execute
@@ -674,12 +674,12 @@ <T> T queryForObject(String sql, Object[] args, int[] argTypes, Class<T> require
 	 * @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 the SQL query to execute
@@ -697,8 +697,8 @@ <T>List<T> queryForList(String sql, Object[] args, int[] argTypes, Class<T> elem
 	<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 the SQL query to execute
@@ -717,12 +717,12 @@ <T>List<T> queryForList(String sql, Object[] args, int[] argTypes, Class<T> elem
 	<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.
+	 * 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 @@ <T>List<T> queryForList(String sql, Object[] args, int[] argTypes, Class<T> elem
 	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.
+	 * {@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 @@ <T>List<T> queryForList(String sql, Object[] args, int[] argTypes, Class<T> elem
 	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
@@ -776,8 +776,8 @@ <T>List<T> queryForList(String sql, Object[] args, int[] argTypes, Class<T> elem
 	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
@@ -799,8 +799,9 @@ <T>List<T> queryForList(String sql, Object[] args, int[] argTypes, Class<T> elem
 	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 a callback that provides SQL and any necessary parameters

spring-jdbc/src/main/java/org/springframework/jdbc/core/JdbcTemplate.java

@@ -1145,12 +1145,12 @@ public Map<String, Object> doInCallableStatement(CallableStatement cs) throws SQ
 					logger.debug("CallableStatement.execute() returned '" + retVal + "'");
 					logger.debug("CallableStatement.getUpdateCount() returned " + updateCount);
 				}
-				Map<String, Object> returnedResults = createResultsMap();
+				Map<String, Object> 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 @@ protected Map<String, Object> processResultSet(ResultSet rs, ResultSetSupporting
 				}
 				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 @@ else if (param.getRowCallbackHandler() != null) {
 							(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 {