Browse Source

Polish Javadoc for ColumnMapRowMapper

See gh-26823
pull/26836/head
Sam Brannen 5 years ago
parent
commit
1f477a5c1c
  1. 13
      spring-jdbc/src/main/java/org/springframework/jdbc/core/ColumnMapRowMapper.java

13
spring-jdbc/src/main/java/org/springframework/jdbc/core/ColumnMapRowMapper.java

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
/*
* Copyright 2002-2018 the original author or authors.
* Copyright 2002-2021 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.
@ -31,8 +31,8 @@ import org.springframework.util.LinkedCaseInsensitiveMap; @@ -31,8 +31,8 @@ import org.springframework.util.LinkedCaseInsensitiveMap;
* entry for each column, with the column name as key.
*
* <p>The Map implementation to use and the key to use for each column
* in the column Map can be customized through overriding
* {@link #createColumnMap} and {@link #getColumnKey}, respectively.
* in the column Map can be customized by overriding {@link #createColumnMap}
* and {@link #getColumnKey}, respectively.
*
* <p><b>Note:</b> By default, {@code ColumnMapRowMapper} will try to build a linked Map
* with case-insensitive keys, to preserve column order as well as allow any
@ -71,6 +71,7 @@ public class ColumnMapRowMapper implements RowMapper<Map<String, Object>> { @@ -71,6 +71,7 @@ public class ColumnMapRowMapper implements RowMapper<Map<String, Object>> {
/**
* Determine the key to use for the given column in the column Map.
* <p>By default, the supplied column name will be returned unmodified.
* @param columnName the column name as returned by the ResultSet
* @return the column key to use
* @see java.sql.ResultSetMetaData#getColumnName
@ -83,9 +84,9 @@ public class ColumnMapRowMapper implements RowMapper<Map<String, Object>> { @@ -83,9 +84,9 @@ public class ColumnMapRowMapper implements RowMapper<Map<String, Object>> {
* Retrieve a JDBC object value for the specified column.
* <p>The default implementation uses the {@code getObject} method.
* Additionally, this implementation includes a "hack" to get around Oracle
* returning a non standard object for their TIMESTAMP datatype.
* @param rs is the ResultSet holding the data
* @param index is the column index
* returning a non standard object for their TIMESTAMP data type.
* @param rs the ResultSet holding the data
* @param index the column index
* @return the Object returned
* @see org.springframework.jdbc.support.JdbcUtils#getResultSetValue
*/

Loading…
Cancel
Save