Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polishing

Browse Source 
Issue: SPR-12476
This commit is contained in:
Juergen Hoeller
2014-11-27 18:01:19 +01:00
parent 2bf6d5b8eb
commit 3b1584904f
4 changed files with 42 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
spring-jdbc/src/main/java/org/springframework/jdbc/support/rowset/ResultSetWrappingSqlRowSet.java
View File

@@ -29,14 +29,14 @@ import java.util.HashMap;
import java.util.Map; import java.util.Map;
import org.springframework.jdbc.InvalidResultSetAccessException; import org.springframework.jdbc.InvalidResultSetAccessException;
import org.springframework.lang.UsesJava7;
/** /**
* Default implementation of Spring's {@link SqlRowSet} interface. * The default implementation of Spring's {@link SqlRowSet} interface, wrapping a
* {@link java.sql.ResultSet}, catching any {@link SQLException}s and translating
* them to a corresponding Spring {@link InvalidResultSetAccessException}.
* *
* <p>This implementation wraps a {@code javax.sql.ResultSet}, catching any SQLExceptions * <p>The passed-in ResultSet should already be disconnected if the SqlRowSet is supposed
* and translating them to the appropriate Spring {@link InvalidResultSetAccessException}.
*
* <p>The passed-in ResultSets should already be disconnected if the SqlRowSet is supposed
* to be usable in a disconnected fashion. This means that you will usually pass in a * to be usable in a disconnected fashion. This means that you will usually pass in a
* {@code javax.sql.rowset.CachedRowSet}, which implements the ResultSet interface. * {@code javax.sql.rowset.CachedRowSet}, which implements the ResultSet interface.
* *
@@ -412,6 +412,7 @@ public class ResultSetWrappingSqlRowSet implements SqlRowSet {
/** /**
* @see java.sql.ResultSet#getObject(int, Class) * @see java.sql.ResultSet#getObject(int, Class)
*/ */
@UsesJava7
@Override @Override
public <T> T getObject(int columnIndex, Class<T> type) throws InvalidResultSetAccessException { public <T> T getObject(int columnIndex, Class<T> type) throws InvalidResultSetAccessException {
try { try {

13
spring-jdbc/src/main/java/org/springframework/jdbc/support/rowset/ResultSetWrappingSqlRowSetMetaData.java
View File

@@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2012 the original author or authors. * Copyright 2002-2014 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -22,17 +22,16 @@ import java.sql.SQLException;
import org.springframework.jdbc.InvalidResultSetAccessException; import org.springframework.jdbc.InvalidResultSetAccessException;
/** /**
* Default implementation of Spring's SqlRowSetMetaData interface. * The default implementation of Spring's {@link SqlRowSetMetaData} interface, wrapping
* Used by ResultSetWrappingSqlRowSet. * a {@link java.sql.ResultSetMetaData} instance, catching any {@link SQLException}s
* and translating them to a corresponding Spring {@link InvalidResultSetAccessException}.
* *
* <p>This implementation wraps a {@code javax.sql.ResultSetMetaData} * <p>Used by {@link ResultSetWrappingSqlRowSet}.
* instance, catching any SQLExceptions and translating them to the
* appropriate Spring DataAccessException.
* *
* @author Thomas Risberg * @author Thomas Risberg
* @author Juergen Hoeller * @author Juergen Hoeller
* @since 1.2 * @since 1.2
* @see ResultSetWrappingSqlRowSet#getMetaData * @see ResultSetWrappingSqlRowSet#getMetaData()
*/ */
public class ResultSetWrappingSqlRowSetMetaData implements SqlRowSetMetaData { public class ResultSetWrappingSqlRowSetMetaData implements SqlRowSetMetaData {

12
spring-jdbc/src/main/java/org/springframework/jdbc/support/rowset/SqlRowSet.java
View File

@@ -30,14 +30,14 @@ import org.springframework.jdbc.InvalidResultSetAccessException;
* Mirror interface for {@link javax.sql.RowSet}, representing * Mirror interface for {@link javax.sql.RowSet}, representing
* disconnected {@link java.sql.ResultSet} data. * disconnected {@link java.sql.ResultSet} data.
* *
* <p>The main difference to the standard JDBC RowSet is that an SQLException * <p>The main difference to the standard JDBC RowSet is that a
* is never thrown here. This allows a SqlRowSet to be used without having * {@link java.sql.SQLException} is never thrown here. This allows a
* to deal with checked exceptions. A SqlRowSet will throw Spring's * SqlRowSet to be used without having to deal with checked exceptions.
* {@code org.springframework.jdbc.InvalidResultSetAccessException} * A SqlRowSet will throw Spring's {@link InvalidResultSetAccessException}
* instead (when appropriate). * instead (when appropriate).
* *
* <p>Note: This interface extends the {@code java.io.Serializable} * <p>Note: This interface extends the {@code java.io.Serializable} marker
* marker interface. Implementations, which typically hold disconnected data, * interface. Implementations, which typically hold disconnected data,
* are encouraged to be actually serializable (as far as possible). * are encouraged to be actually serializable (as far as possible).
* *
* @author Thomas Risberg * @author Thomas Risberg

44
spring-jdbc/src/main/java/org/springframework/jdbc/support/rowset/SqlRowSetMetaData.java
View File

@@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2012 the original author or authors. * Copyright 2002-2014 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -19,25 +19,27 @@ package org.springframework.jdbc.support.rowset;
import org.springframework.jdbc.InvalidResultSetAccessException; import org.springframework.jdbc.InvalidResultSetAccessException;
/** /**
* Meta data interface for Spring's SqlRowSet, * Metadata interface for Spring's {@link SqlRowSet}, analogous to JDBC's
* analogous to {@code javax.sql.ResultSetMetaData} * {@link java.sql.ResultSetMetaData}.
* *
* <p>The main difference to the standard JDBC RowSetMetaData is that an SQLException * <p>The main difference to the standard JDBC ResultSetMetaData is that a
* is never thrown here. This allows a SqlRowSetMetaData to be used without having * {@link java.sql.SQLException} is never thrown here. This allows
* to deal with checked exceptions. A SqlRowSetMetaData will throw Spring's * SqlRowSetMetaData to be used without having to deal with checked exceptions.
* {@code org.springframework.jdbc.InvalidResultSetAccessException} * SqlRowSetMetaData will throw Spring's {@link InvalidResultSetAccessException}
* instead (when appropriate). * instead (when appropriate).
* *
* @author Thomas Risberg * @author Thomas Risberg
* @author Juergen Hoeller
* @since 1.2 * @since 1.2
* @see SqlRowSet#getMetaData * @see SqlRowSet#getMetaData()
* @see java.sql.ResultSetMetaData * @see java.sql.ResultSetMetaData
* @see org.springframework.jdbc.InvalidResultSetAccessException * @see org.springframework.jdbc.InvalidResultSetAccessException
*/ */
public interface SqlRowSetMetaData { public interface SqlRowSetMetaData {
/** /**
* Retrieves the catalog name of the table that served as the source for the specified column. * Retrieve the catalog name of the table that served as the source for the
* specified column.
* @param columnIndex the index of the column * @param columnIndex the index of the column
* @return the catalog name * @return the catalog name
* @see java.sql.ResultSetMetaData#getCatalogName(int) * @see java.sql.ResultSetMetaData#getCatalogName(int)
@@ -45,7 +47,7 @@ public interface SqlRowSetMetaData {
String getCatalogName(int columnIndex) throws InvalidResultSetAccessException; String getCatalogName(int columnIndex) throws InvalidResultSetAccessException;
/** /**
* Retrieves the fully qualified class that the specified column will be mapped to. * Retrieve the fully qualified class that the specified column will be mapped to.
* @param columnIndex the index of the column * @param columnIndex the index of the column
* @return the class name as a String * @return the class name as a String
* @see java.sql.ResultSetMetaData#getColumnClassName(int) * @see java.sql.ResultSetMetaData#getColumnClassName(int)
@@ -53,7 +55,7 @@ public interface SqlRowSetMetaData {
String getColumnClassName(int columnIndex) throws InvalidResultSetAccessException; String getColumnClassName(int columnIndex) throws InvalidResultSetAccessException;
/** /**
* Retrives the number of columns in the RowSet. * Retrieve the number of columns in the RowSet.
* @return the number of columns * @return the number of columns
* @see java.sql.ResultSetMetaData#getColumnCount() * @see java.sql.ResultSetMetaData#getColumnCount()
*/ */
@@ -66,7 +68,7 @@ public interface SqlRowSetMetaData {
String[] getColumnNames() throws InvalidResultSetAccessException; String[] getColumnNames() throws InvalidResultSetAccessException;
/** /**
* Retrieves the maximum width of the designated column. * Retrieve the maximum width of the designated column.
* @param columnIndex the index of the column * @param columnIndex the index of the column
* @return the width of the column * @return the width of the column
* @see java.sql.ResultSetMetaData#getColumnDisplaySize(int) * @see java.sql.ResultSetMetaData#getColumnDisplaySize(int)
@@ -99,7 +101,7 @@ public interface SqlRowSetMetaData {
int getColumnType(int columnIndex) throws InvalidResultSetAccessException; int getColumnType(int columnIndex) throws InvalidResultSetAccessException;
/** /**
* Retrieves the DBMS-specific type name for the indicated column. * Retrieve the DBMS-specific type name for the indicated column.
* @param columnIndex the index of the column * @param columnIndex the index of the column
* @return the type name * @return the type name
* @see java.sql.ResultSetMetaData#getColumnTypeName(int) * @see java.sql.ResultSetMetaData#getColumnTypeName(int)
@@ -107,7 +109,7 @@ public interface SqlRowSetMetaData {
String getColumnTypeName(int columnIndex) throws InvalidResultSetAccessException; String getColumnTypeName(int columnIndex) throws InvalidResultSetAccessException;
/** /**
* Retrieves the precision for the indicated column. * Retrieve the precision for the indicated column.
* @param columnIndex the index of the column * @param columnIndex the index of the column
* @return the precision * @return the precision
* @see java.sql.ResultSetMetaData#getPrecision(int) * @see java.sql.ResultSetMetaData#getPrecision(int)
@@ -115,7 +117,7 @@ public interface SqlRowSetMetaData {
int getPrecision(int columnIndex) throws InvalidResultSetAccessException; int getPrecision(int columnIndex) throws InvalidResultSetAccessException;
/** /**
* Retrieves the scale of the indicated column. * Retrieve the scale of the indicated column.
* @param columnIndex the index of the column * @param columnIndex the index of the column
* @return the scale * @return the scale
* @see java.sql.ResultSetMetaData#getScale(int) * @see java.sql.ResultSetMetaData#getScale(int)
@@ -123,7 +125,8 @@ public interface SqlRowSetMetaData {
int getScale(int columnIndex) throws InvalidResultSetAccessException; int getScale(int columnIndex) throws InvalidResultSetAccessException;
/** /**
* Retrieves the schema name of the table that served as the source for the specified column. * Retrieve the schema name of the table that served as the source for the
* specified column.
* @param columnIndex the index of the column * @param columnIndex the index of the column
* @return the schema name * @return the schema name
* @see java.sql.ResultSetMetaData#getSchemaName(int) * @see java.sql.ResultSetMetaData#getSchemaName(int)
@@ -131,7 +134,8 @@ public interface SqlRowSetMetaData {
String getSchemaName(int columnIndex) throws InvalidResultSetAccessException; String getSchemaName(int columnIndex) throws InvalidResultSetAccessException;
/** /**
* Retrieves the name of the table that served as the source for the specified column. * Retrieve the name of the table that served as the source for the
* specified column.
* @param columnIndex the index of the column * @param columnIndex the index of the column
* @return the name of the table * @return the name of the table
* @see java.sql.ResultSetMetaData#getTableName(int) * @see java.sql.ResultSetMetaData#getTableName(int)
@@ -139,7 +143,7 @@ public interface SqlRowSetMetaData {
String getTableName(int columnIndex) throws InvalidResultSetAccessException; String getTableName(int columnIndex) throws InvalidResultSetAccessException;
/** /**
* Indicates whether the case of the designated column is significant. * Indicate whether the case of the designated column is significant.
* @param columnIndex the index of the column * @param columnIndex the index of the column
* @return true if the case sensitive, false otherwise * @return true if the case sensitive, false otherwise
* @see java.sql.ResultSetMetaData#isCaseSensitive(int) * @see java.sql.ResultSetMetaData#isCaseSensitive(int)
@@ -147,7 +151,7 @@ public interface SqlRowSetMetaData {
boolean isCaseSensitive(int columnIndex) throws InvalidResultSetAccessException; boolean isCaseSensitive(int columnIndex) throws InvalidResultSetAccessException;
/** /**
* Indicates whether the designated column contains a currency value. * Indicate whether the designated column contains a currency value.
* @param columnIndex the index of the column * @param columnIndex the index of the column
* @return true if the value is a currency value, false otherwise * @return true if the value is a currency value, false otherwise
* @see java.sql.ResultSetMetaData#isCurrency(int) * @see java.sql.ResultSetMetaData#isCurrency(int)
@@ -155,7 +159,7 @@ public interface SqlRowSetMetaData {
boolean isCurrency(int columnIndex) throws InvalidResultSetAccessException; boolean isCurrency(int columnIndex) throws InvalidResultSetAccessException;
/** /**
* Indicates whether the designated column contains a signed number. * Indicate whether the designated column contains a signed number.
* @param columnIndex the index of the column * @param columnIndex the index of the column
* @return true if the column contains a signed number, false otherwise * @return true if the column contains a signed number, false otherwise
* @see java.sql.ResultSetMetaData#isSigned(int) * @see java.sql.ResultSetMetaData#isSigned(int)