Author: bayard
Date: Tue Nov 28 15:46:07 2006
New Revision: 480288
URL: http://svn.apache.org/viewvc?view=rev&rev=480288
Log:
Fixed the rest of the Checkstyle Javadoc issues except for the ones where
Checkstyle is being dumb and not understanding the fall-through nature of the
@see tag
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BasicRowProcessor.java
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BeanProcessor.java
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/DbUtils.java
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ProxyFactory.java
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryLoader.java
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryRunner.java
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ResultSetHandler.java
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ResultSetIterator.java
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/RowProcessor.java
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayHandler.java
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayListHandler.java
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/BeanHandler.java
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/BeanListHandler.java
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ColumnListHandler.java
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/KeyedHandler.java
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapHandler.java
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapListHandler.java
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ScalarHandler.java
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/StringTrimmedResultSet.java
jakarta/commons/proper/dbutils/trunk/src/test/org/apache/commons/dbutils/MockResultSet.java
jakarta/commons/proper/dbutils/trunk/src/test/org/apache/commons/dbutils/wrappers/StringTrimmedResultSetTest.java
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BasicRowProcessor.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BasicRowProcessor.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BasicRowProcessor.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BasicRowProcessor.java
Tue Nov 28 15:46:07 2006
@@ -104,8 +104,8 @@
/**
* Convert a <code>ResultSet</code> row into a JavaBean. This
* implementation delegates to a BeanProcessor instance.
- * @see
org.apache.commons.dbutils.BeanProcessor#toBean(java.sql.ResultSet,
java.lang.Class)
* @see org.apache.commons.dbutils.RowProcessor#toBean(java.sql.ResultSet,
java.lang.Class)
+ * @see
org.apache.commons.dbutils.BeanProcessor#toBean(java.sql.ResultSet,
java.lang.Class)
*/
public Object toBean(ResultSet rs, Class type) throws SQLException {
return this.convert.toBean(rs, type);
@@ -114,8 +114,8 @@
/**
* Convert a <code>ResultSet</code> into a <code>List</code> of JavaBeans.
* This implementation delegates to a BeanProcessor instance.
- * @see
org.apache.commons.dbutils.BeanProcessor#toBeanList(java.sql.ResultSet,
java.lang.Class)
* @see
org.apache.commons.dbutils.RowProcessor#toBeanList(java.sql.ResultSet,
java.lang.Class)
+ * @see
org.apache.commons.dbutils.BeanProcessor#toBeanList(java.sql.ResultSet,
java.lang.Class)
*/
public List toBeanList(ResultSet rs, Class type) throws SQLException {
return this.convert.toBeanList(rs, type);
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BeanProcessor.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BeanProcessor.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BeanProcessor.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BeanProcessor.java
Tue Nov 28 15:46:07 2006
@@ -112,7 +112,7 @@
*
* @param rs ResultSet that supplies the bean data
* @param type Class from which to create the bean instance
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
* @return the newly created bean
*/
public Object toBean(ResultSet rs, Class type) throws SQLException {
@@ -155,7 +155,7 @@
*
* @param rs ResultSet that supplies the bean data
* @param type Class from which to create the bean instance
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
* @return the newly created List of beans
*/
public List toBeanList(ResultSet rs, Class type) throws SQLException {
@@ -184,7 +184,7 @@
* @param props The property descriptors.
* @param columnToProperty The column indices in the result set.
* @return An initialized object.
- * @throws SQLException - if a database error occurs.
+ * @throws SQLException if a database error occurs.
*/
private Object createBean(ResultSet rs, Class type,
PropertyDescriptor[] props, int[] columnToProperty)
@@ -377,7 +377,7 @@
*
* @param props The bean property descriptors.
*
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*
* @return An int[] with column index to property index mappings. The 0th
* element is meaningless because JDBC column indexing starts at 1.
@@ -424,7 +424,7 @@
* @param propType The bean property type that this column needs to be
* converted into.
*
- * @throws SQLException- if a database access error occurs
+ * @throws SQLException if a database access error occurs
*
* @return The object from the <code>ResultSet</code> at the given column
* index after optional type processing or <code>null</code> if the column
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/DbUtils.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/DbUtils.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/DbUtils.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/DbUtils.java
Tue Nov 28 15:46:07 2006
@@ -29,6 +29,9 @@
/**
* Close a <code>Connection</code>, avoid closing if null.
+ *
+ * @param conn Connection to close.
+ * @throws SQLException if a database access error occurs
*/
public static void close(Connection conn) throws SQLException {
if (conn != null) {
@@ -38,6 +41,9 @@
/**
* Close a <code>ResultSet</code>, avoid closing if null.
+ *
+ * @param rs ResultSet to close.
+ * @throws SQLException if a database access error occurs
*/
public static void close(ResultSet rs) throws SQLException {
if (rs != null) {
@@ -47,6 +53,9 @@
/**
* Close a <code>Statement</code>, avoid closing if null.
+ *
+ * @param stmt Statement to close.
+ * @throws SQLException if a database access error occurs
*/
public static void close(Statement stmt) throws SQLException {
if (stmt != null) {
@@ -57,6 +66,8 @@
/**
* Close a <code>Connection</code>, avoid closing if null and hide
* any SQLExceptions that occur.
+ *
+ * @param conn Connection to close.
*/
public static void closeQuietly(Connection conn) {
try {
@@ -70,6 +81,10 @@
* Close a <code>Connection</code>, <code>Statement</code> and
* <code>ResultSet</code>. Avoid closing if null and hide any
* SQLExceptions that occur.
+ *
+ * @param conn Connection to close.
+ * @param stmt Statement to close.
+ * @param rs ResultSet to close.
*/
public static void closeQuietly(Connection conn, Statement stmt,
ResultSet rs) {
@@ -89,6 +104,8 @@
/**
* Close a <code>ResultSet</code>, avoid closing if null and hide any
* SQLExceptions that occur.
+ *
+ * @param rs ResultSet to close.
*/
public static void closeQuietly(ResultSet rs) {
try {
@@ -101,6 +118,8 @@
/**
* Close a <code>Statement</code>, avoid closing if null and hide
* any SQLExceptions that occur.
+ *
+ * @param stmt Statement to close.
*/
public static void closeQuietly(Statement stmt) {
try {
@@ -112,6 +131,9 @@
/**
* Commits a <code>Connection</code> then closes it, avoid closing if null.
+ *
+ * @param conn Connection to close.
+ * @throws SQLException if a database access error occurs
*/
public static void commitAndClose(Connection conn) throws SQLException {
if (conn != null) {
@@ -126,6 +148,8 @@
/**
* Commits a <code>Connection</code> then closes it, avoid closing if null
* and hide any SQLExceptions that occur.
+ *
+ * @param conn Connection to close.
*/
public static void commitAndCloseQuietly(Connection conn) {
try {
@@ -138,6 +162,9 @@
/**
* Loads and registers a database driver class.
* If this succeeds, it returns true, else it returns false.
+ *
+ * @param driverClassName of driver to load
+ * @return boolean <code>true</code> if the driver was found, otherwise
<code>false</code>
*/
public static boolean loadDriver(String driverClassName) {
try {
@@ -214,8 +241,8 @@
/**
* Rollback any changes made on the given connection.
- * @param conn The database Connection to rollback. A null value is legal.
- * @throws SQLException - if a database access error occurs
+ * @param conn Connection to rollback. A null value is legal.
+ * @throws SQLException if a database access error occurs
*/
public static void rollback(Connection conn) throws SQLException {
if (conn != null) {
@@ -226,6 +253,9 @@
/**
* Performs a rollback on the <code>Connection</code> then closes it,
* avoid closing if null.
+ *
+ * @param conn Connection to rollback. A null value is legal.
+ * @throws SQLException if a database access error occurs
* @since DbUtils 1.1
*/
public static void rollbackAndClose(Connection conn) throws SQLException {
@@ -241,6 +271,8 @@
/**
* Performs a rollback on the <code>Connection</code> then closes it,
* avoid closing if null and hide any SQLExceptions that occur.
+ *
+ * @param conn Connection to rollback. A null value is legal.
* @since DbUtils 1.1
*/
public static void rollbackAndCloseQuietly(Connection conn) {
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ProxyFactory.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ProxyFactory.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ProxyFactory.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ProxyFactory.java
Tue Nov 28 15:46:07 2006
@@ -84,6 +84,8 @@
/**
* Returns the Singleton instance of this class.
+ *
+ * @return singleton instance
*/
public static ProxyFactory instance() {
return instance;
@@ -99,6 +101,7 @@
/**
* Creates a new proxy <code>CallableStatement</code> object.
* @param handler The handler that intercepts/overrides method calls.
+ * @return proxied CallableStatement
*/
public CallableStatement createCallableStatement(InvocationHandler
handler) {
return (CallableStatement) Proxy.newProxyInstance(
@@ -110,6 +113,7 @@
/**
* Creates a new proxy <code>Connection</code> object.
* @param handler The handler that intercepts/overrides method calls.
+ * @return proxied Connection
*/
public Connection createConnection(InvocationHandler handler) {
return (Connection) Proxy.newProxyInstance(
@@ -121,6 +125,7 @@
/**
* Creates a new proxy <code>Driver</code> object.
* @param handler The handler that intercepts/overrides method calls.
+ * @return proxied Driver
*/
public Driver createDriver(InvocationHandler handler) {
return (Driver) Proxy.newProxyInstance(
@@ -132,6 +137,7 @@
/**
* Creates a new proxy <code>PreparedStatement</code> object.
* @param handler The handler that intercepts/overrides method calls.
+ * @return proxied PreparedStatement
*/
public PreparedStatement createPreparedStatement(InvocationHandler
handler) {
return (PreparedStatement) Proxy.newProxyInstance(
@@ -143,6 +149,7 @@
/**
* Creates a new proxy <code>ResultSet</code> object.
* @param handler The handler that intercepts/overrides method calls.
+ * @return proxied ResultSet
*/
public ResultSet createResultSet(InvocationHandler handler) {
return (ResultSet) Proxy.newProxyInstance(
@@ -154,6 +161,7 @@
/**
* Creates a new proxy <code>ResultSetMetaData</code> object.
* @param handler The handler that intercepts/overrides method calls.
+ * @return proxied ResultSetMetaData
*/
public ResultSetMetaData createResultSetMetaData(InvocationHandler
handler) {
return (ResultSetMetaData) Proxy.newProxyInstance(
@@ -165,6 +173,7 @@
/**
* Creates a new proxy <code>Statement</code> object.
* @param handler The handler that intercepts/overrides method calls.
+ * @return proxied Statement
*/
public Statement createStatement(InvocationHandler handler) {
return (Statement) Proxy.newProxyInstance(
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryLoader.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryLoader.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryLoader.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryLoader.java
Tue Nov 28 15:46:07 2006
@@ -64,9 +64,10 @@
* This is <strong>not</strong> a file system path. If you had a jarred
* Queries.properties file in the com.yourcorp.app.jdbc package you would
* pass "/com/yourcorp/app/jdbc/Queries.properties" to this method.
- * @throws IOException
+ * @throws IOException if a file access error occurs
* @throws IllegalArgumentException if the ClassLoader can't find a file at
* the given path.
+ * @return Map of query names to SQL values
*/
public synchronized Map load(String path) throws IOException {
@@ -84,10 +85,11 @@
* Loads a set of named queries into a Map object. This implementation
* reads a properties file at the given path.
* @param path The path that the ClassLoader will use to find the file.
- * @throws IOException
+ * @throws IOException if a file access error occurs
* @throws IllegalArgumentException if the ClassLoader can't find a file at
* the given path.
* @since DbUtils 1.1
+ * @return Map of query names to SQL values
*/
protected Map loadQueries(String path) throws IOException {
InputStream in = getClass().getResourceAsStream(path);
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryRunner.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryRunner.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryRunner.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryRunner.java
Tue Nov 28 15:46:07 2006
@@ -67,7 +67,7 @@
* @param params An array of query replacement parameters. Each row in
* this array is one set of batch replacement values.
* @return The number of rows updated per statement.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
* @since DbUtils 1.1
*/
public int[] batch(Connection conn, String sql, Object[][] params)
@@ -103,7 +103,7 @@
* @param params An array of query replacement parameters. Each row in
* this array is one set of batch replacement values.
* @return The number of rows updated per statement.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
* @since DbUtils 1.1
*/
public int[] batch(String sql, Object[][] params) throws SQLException {
@@ -119,10 +119,10 @@
/**
* Fill the <code>PreparedStatement</code> replacement parameters with
* the given objects.
- * @param stmt
+ * @param stmt PreparedStatement to fill
* @param params Query replacement parameters; <code>null</code> is a valid
* value to pass in.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
protected void fillStatement(PreparedStatement stmt, Object[] params)
throws SQLException {
@@ -148,6 +148,8 @@
* <code>QueryRunner</code> methods always call this method to get the
* <code>DataSource</code> so subclasses can provide specialized
* behavior.
+ *
+ * @return DataSource the runner is using
*/
public DataSource getDataSource() {
return this.ds;
@@ -165,7 +167,7 @@
* <code>PreparedStatement</code>
* @param sql The SQL statement to prepare.
* @return An initialized <code>PreparedStatement</code>.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
protected PreparedStatement prepareStatement(Connection conn, String sql)
throws SQLException {
@@ -182,7 +184,7 @@
* implementation simply calls <code>ds.getConnection()</code>.
*
* @return An initialized <code>Connection</code>.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
* @since DbUtils 1.1
*/
protected Connection prepareConnection() throws SQLException {
@@ -202,7 +204,7 @@
* @param param The replacement parameter.
* @param rsh The handler that converts the results into an object.
* @return The object returned by the handler.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
public Object query(Connection conn, String sql, Object param,
ResultSetHandler rsh) throws SQLException {
@@ -219,7 +221,7 @@
* @param params The replacement parameters.
* @param rsh The handler that converts the results into an object.
* @return The object returned by the handler.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
public Object query(Connection conn, String sql, Object[] params,
ResultSetHandler rsh) throws SQLException {
@@ -256,7 +258,7 @@
* @param sql The query to execute.
* @param rsh The handler that converts the results into an object.
* @return The object returned by the handler.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
public Object query(Connection conn, String sql, ResultSetHandler rsh)
throws SQLException {
@@ -275,7 +277,7 @@
* the <code>ResultSet</code>.
*
* @return An object generated by the handler.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
public Object query(String sql, Object param, ResultSetHandler rsh)
throws SQLException {
@@ -296,7 +298,7 @@
* the <code>ResultSet</code>.
*
* @return An object generated by the handler.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
public Object query(String sql, Object[] params, ResultSetHandler rsh)
throws SQLException {
@@ -320,7 +322,7 @@
* the <code>ResultSet</code>.
*
* @return An object generated by the handler.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
public Object query(String sql, ResultSetHandler rsh) throws SQLException {
return this.query(sql, (Object[]) null, rsh);
@@ -337,7 +339,7 @@
* @param params The query replacement parameters; <code>null</code> is a
* valid value to pass in.
*
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
protected void rethrow(SQLException cause, String sql, Object[] params)
throws SQLException {
@@ -380,7 +382,7 @@
* @param conn The connection to use to run the query.
* @param sql The SQL to execute.
* @return The number of rows updated.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
public int update(Connection conn, String sql) throws SQLException {
return this.update(conn, sql, (Object[]) null);
@@ -394,7 +396,7 @@
* @param sql The SQL to execute.
* @param param The replacement parameter.
* @return The number of rows updated.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
public int update(Connection conn, String sql, Object param)
throws SQLException {
@@ -409,7 +411,7 @@
* @param sql The SQL to execute.
* @param params The query replacement parameters.
* @return The number of rows updated.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
public int update(Connection conn, String sql, Object[] params)
throws SQLException {
@@ -440,7 +442,7 @@
* not be saved.
*
* @param sql The SQL statement to execute.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
* @return The number of rows updated.
*/
public int update(String sql) throws SQLException {
@@ -456,7 +458,7 @@
*
* @param sql The SQL statement to execute.
* @param param The replacement parameter.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
* @return The number of rows updated.
*/
public int update(String sql, Object param) throws SQLException {
@@ -472,7 +474,7 @@
* @param sql The SQL statement to execute.
* @param params Initializes the PreparedStatement's IN (i.e. '?')
* parameters.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
* @return The number of rows updated.
*/
public int update(String sql, Object[] params) throws SQLException {
@@ -514,7 +516,8 @@
* Close a <code>Connection</code>. This implementation avoids closing if
* null and does <strong>not</strong> suppress any exceptions. Subclasses
* can override to provide special handling like logging.
- * @throws SQLException - if a database access error occurs
+ * @param conn Connection to close
+ * @throws SQLException if a database access error occurs
* @since DbUtils 1.1
*/
protected void close(Connection conn) throws SQLException {
@@ -525,7 +528,8 @@
* Close a <code>Statement</code>. This implementation avoids closing if
* null and does <strong>not</strong> suppress any exceptions. Subclasses
* can override to provide special handling like logging.
- * @throws SQLException - if a database access error occurs
+ * @param stmt Statement to close
+ * @throws SQLException if a database access error occurs
* @since DbUtils 1.1
*/
protected void close(Statement stmt) throws SQLException {
@@ -536,7 +540,8 @@
* Close a <code>ResultSet</code>. This implementation avoids closing if
* null and does <strong>not</strong> suppress any exceptions. Subclasses
* can override to provide special handling like logging.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
+ * @param rs ResultSet to close
* @since DbUtils 1.1
*/
protected void close(ResultSet rs) throws SQLException {
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ResultSetHandler.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ResultSetHandler.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ResultSetHandler.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ResultSetHandler.java
Tue Nov 28 15:46:07 2006
@@ -34,7 +34,7 @@
* legal for implementations to return <code>null</code> if the
* <code>ResultSet</code> contained 0 rows.
*
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
public Object handle(ResultSet rs) throws SQLException;
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ResultSetIterator.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ResultSetIterator.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ResultSetIterator.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ResultSetIterator.java
Tue Nov 28 15:46:07 2006
@@ -66,6 +66,7 @@
/**
* Returns true if there are more rows in the ResultSet.
+ * @return boolean <code>true</code> if there are more rows
* @throws RuntimeException if an SQLException occurs.
*/
public boolean hasNext() {
@@ -110,10 +111,11 @@
/**
* Rethrow the SQLException as a RuntimeException. This implementation
* creates a new RuntimeException with the SQLException's error message.
+ * @param e SQLException to rethrow
* @since DbUtils 1.1
*/
protected void rethrow(SQLException e) {
throw new RuntimeException(e.getMessage());
}
-}
\ No newline at end of file
+}
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/RowProcessor.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/RowProcessor.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/RowProcessor.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/RowProcessor.java
Tue Nov 28 15:46:07 2006
@@ -37,6 +37,10 @@
* positioned on a valid row before passing it to this method.
* Implementations of this method must not alter the row position of
* the <code>ResultSet</code>.
+ *
+ * @param rs ResultSet that supplies the array data
+ * @throws SQLException if a database access error occurs
+ * @return the newly created array
*/
public Object[] toArray(ResultSet rs) throws SQLException;
@@ -45,6 +49,11 @@
* row. The <code>ResultSet</code> should be positioned on a valid row
before
* passing it to this method. Implementations of this method must not
* alter the row position of the <code>ResultSet</code>.
+ *
+ * @param rs ResultSet that supplies the bean data
+ * @param type Class from which to create the bean instance
+ * @throws SQLException if a database access error occurs
+ * @return the newly created bean
*/
public Object toBean(ResultSet rs, Class type) throws SQLException;
@@ -53,6 +62,9 @@
* <code>ResultSet</code> rows. <code>ResultSet.next()</code> should
* <strong>not</strong> be called before passing it to this method.
*
+ * @param rs ResultSet that supplies the bean data
+ * @param type Class from which to create the bean instance
+ * @throws SQLException if a database access error occurs
* @return A <code>List</code> of beans with the given type in the order
* they were returned by the <code>ResultSet</code>.
*/
@@ -64,6 +76,10 @@
* positioned on a valid row before
* passing it to this method. Implementations of this method must not
* alter the row position of the <code>ResultSet</code>.
+ *
+ * @param rs ResultSet that supplies the map data
+ * @throws SQLException if a database access error occurs
+ * @return the newly created Map
*/
public Map toMap(ResultSet rs) throws SQLException;
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayHandler.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayHandler.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayHandler.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayHandler.java
Tue Nov 28 15:46:07 2006
@@ -70,7 +70,7 @@
* @return An Object[] or <code>null</code> if there are no rows in the
* <code>ResultSet</code>.
*
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
* @see
org.apache.commons.dbutils.ResultSetHandler#handle(java.sql.ResultSet)
*/
public Object handle(ResultSet rs) throws SQLException {
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayListHandler.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayListHandler.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayListHandler.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayListHandler.java
Tue Nov 28 15:46:07 2006
@@ -61,7 +61,7 @@
*
* @return <code>Object[]</code>, never <code>null</code>.
*
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
* @see
org.apache.commons.dbutils.handlers.GenericListHandler#handle(ResultSet)
*/
protected Object handleRow(ResultSet rs) throws SQLException {
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/BeanHandler.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/BeanHandler.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/BeanHandler.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/BeanHandler.java
Tue Nov 28 15:46:07 2006
@@ -71,7 +71,7 @@
* @return An initialized JavaBean or <code>null</code> if there were no
* rows in the <code>ResultSet</code>.
*
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
* @see
org.apache.commons.dbutils.ResultSetHandler#handle(java.sql.ResultSet)
*/
public Object handle(ResultSet rs) throws SQLException {
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/BeanListHandler.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/BeanListHandler.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/BeanListHandler.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/BeanListHandler.java
Tue Nov 28 15:46:07 2006
@@ -70,7 +70,7 @@
*
* @return A bean, never <code>null</code>.
*
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
* @see
org.apache.commons.dbutils.handlers.GenericListHandler#handle(ResultSet)
*/
protected Object handleRow(ResultSet rs) throws SQLException {
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ColumnListHandler.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ColumnListHandler.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ColumnListHandler.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ColumnListHandler.java
Tue Nov 28 15:46:07 2006
@@ -73,7 +73,7 @@
*
* @return <code>Object</code>, never <code>null</code>.
*
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*
* @see
org.apache.commons.dbutils.handlers.GenericListHandler#handle(ResultSet)
*/
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/KeyedHandler.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/KeyedHandler.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/KeyedHandler.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/KeyedHandler.java
Tue Nov 28 15:46:07 2006
@@ -123,7 +123,7 @@
* in a <code>Map</code> under <code>ResultSet.getObject(key)</code> key.
*
* @return A <code>Map</code> of Maps, never <code>null</code>.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
* @see
org.apache.commons.dbutils.ResultSetHandler#handle(java.sql.ResultSet)
*/
public Object handle(ResultSet rs) throws SQLException {
@@ -138,6 +138,8 @@
* This factory method is called by <code>handle()</code> to create the Map
* to store records in. This implementation returns a <code>HashMap</code>
* instance.
+ *
+ * @return Map to store records in
*/
protected Map createMap() {
return new HashMap();
@@ -148,7 +150,9 @@
* key value from the current <code>ResultSet</code> row. This
* implementation returns <code>ResultSet.getObject()</code> for the
* configured key column name or index.
- * @throws SQLException - if a database access error occurs
+ * @param rs ResultSet to create a key from
+ * @return Object from the configured key column name/index
+ * @throws SQLException if a database access error occurs
*/
protected Object createKey(ResultSet rs) throws SQLException {
return (columnName == null) ? rs.getObject(columnIndex) : rs
@@ -161,7 +165,9 @@
* implementation returns a <code>Map</code> with case insensitive column
* names as keys. Calls to <code>map.get("COL")</code> and
* <code>map.get("col")</code> return the same value.
- * @throws SQLException - if a database access error occurs
+ * @param rs ResultSet to create a row from
+ * @return Object typed Map containing column names to values
+ * @throws SQLException if a database access error occurs
*/
protected Object createRow(ResultSet rs) throws SQLException {
return this.convert.toMap(rs);
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapHandler.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapHandler.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapHandler.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapHandler.java
Tue Nov 28 15:46:07 2006
@@ -63,7 +63,7 @@
* @return A <code>Map</code> with the values from the first row or
* <code>null</code> if there are no rows in the <code>ResultSet</code>.
*
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*
* @see
org.apache.commons.dbutils.ResultSetHandler#handle(java.sql.ResultSet)
*/
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapListHandler.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapListHandler.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapListHandler.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapListHandler.java
Tue Nov 28 15:46:07 2006
@@ -60,7 +60,7 @@
*
* @return A <code>Map</code>, never null.
*
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*
* @see
org.apache.commons.dbutils.handlers.GenericListHandler#handle(ResultSet)
*/
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ScalarHandler.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ScalarHandler.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ScalarHandler.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ScalarHandler.java
Tue Nov 28 15:46:07 2006
@@ -76,7 +76,7 @@
* @return The column or <code>null</code> if there are no rows in
* the <code>ResultSet</code>.
*
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*
* @see
org.apache.commons.dbutils.ResultSetHandler#handle(java.sql.ResultSet)
*/
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java
Tue Nov 28 15:46:07 2006
@@ -100,6 +100,7 @@
* </pre>
*
* @param rs The <code>ResultSet</code> to wrap.
+ * @return wrapped ResultSet
*/
public static ResultSet wrap(ResultSet rs) {
return factory.createResultSet(new SqlNullCheckedResultSet(rs));
@@ -136,6 +137,7 @@
* Constructs a new instance of
* <code>SqlNullCheckedResultSet</code>
* to wrap the specified <code>ResultSet</code>.
+ * @param rs ResultSet to wrap
*/
public SqlNullCheckedResultSet(ResultSet rs) {
super();
Modified:
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/StringTrimmedResultSet.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/StringTrimmedResultSet.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/StringTrimmedResultSet.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/StringTrimmedResultSet.java
Tue Nov 28 15:46:07 2006
@@ -58,6 +58,7 @@
* </pre>
*
* @param rs The <code>ResultSet</code> to wrap.
+ * @return wrapped ResultSet
*/
public static ResultSet wrap(ResultSet rs) {
return factory.createResultSet(new StringTrimmedResultSet(rs));
@@ -71,6 +72,7 @@
/**
* Constructs a new instance of <code>StringTrimmedResultSet</code>
* to wrap the specified <code>ResultSet</code>.
+ * @param rs ResultSet to wrap
*/
public StringTrimmedResultSet(ResultSet rs) {
super();
Modified:
jakarta/commons/proper/dbutils/trunk/src/test/org/apache/commons/dbutils/MockResultSet.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/test/org/apache/commons/dbutils/MockResultSet.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/test/org/apache/commons/dbutils/MockResultSet.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/test/org/apache/commons/dbutils/MockResultSet.java
Tue Nov 28 15:46:07 2006
@@ -72,7 +72,7 @@
* index that the client is trying to get at.
* @param args
* @return A column index.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
private int columnIndex(Object[] args) throws SQLException {
@@ -106,7 +106,7 @@
/**
* Gets the boolean value at the given column index.
* @param columnIndex A 1 based index.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
protected Object getBoolean(int columnIndex) throws SQLException {
Object obj = this.currentRow[columnIndex - 1];
@@ -125,7 +125,7 @@
/**
* Gets the byte value at the given column index.
* @param columnIndex A 1 based index.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
protected Object getByte(int columnIndex) throws SQLException {
Object obj = this.currentRow[columnIndex - 1];
@@ -144,7 +144,7 @@
/**
* Gets the double value at the given column index.
* @param columnIndex A 1 based index.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
protected Object getDouble(int columnIndex) throws SQLException {
Object obj = this.currentRow[columnIndex - 1];
@@ -163,7 +163,7 @@
/**
* Gets the float value at the given column index.
* @param columnIndex A 1 based index.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
protected Object getFloat(int columnIndex) throws SQLException {
Object obj = this.currentRow[columnIndex - 1];
@@ -180,7 +180,7 @@
/**
* Gets the int value at the given column index.
* @param columnIndex A 1 based index.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
protected Object getInt(int columnIndex) throws SQLException {
Object obj = this.currentRow[columnIndex - 1];
@@ -199,7 +199,7 @@
/**
* Gets the long value at the given column index.
* @param columnIndex A 1 based index.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
protected Object getLong(int columnIndex) throws SQLException {
Object obj = this.currentRow[columnIndex - 1];
@@ -220,7 +220,7 @@
/**
* Gets the object at the given column index.
* @param columnIndex A 1 based index.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
protected Object getObject(int columnIndex) throws SQLException {
Object obj = this.currentRow[columnIndex - 1];
@@ -231,7 +231,7 @@
/**
* Gets the short value at the given column index.
* @param columnIndex A 1 based index.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
protected Object getShort(int columnIndex) throws SQLException {
Object obj = this.currentRow[columnIndex - 1];
@@ -250,7 +250,7 @@
/**
* Gets the String at the given column index.
* @param columnIndex A 1 based index.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
protected String getString(int columnIndex) throws SQLException {
Object obj = this.getObject(columnIndex);
Modified:
jakarta/commons/proper/dbutils/trunk/src/test/org/apache/commons/dbutils/wrappers/StringTrimmedResultSetTest.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/dbutils/trunk/src/test/org/apache/commons/dbutils/wrappers/StringTrimmedResultSetTest.java?view=diff&rev=480288&r1=480287&r2=480288
==============================================================================
---
jakarta/commons/proper/dbutils/trunk/src/test/org/apache/commons/dbutils/wrappers/StringTrimmedResultSetTest.java
(original)
+++
jakarta/commons/proper/dbutils/trunk/src/test/org/apache/commons/dbutils/wrappers/StringTrimmedResultSetTest.java
Tue Nov 28 15:46:07 2006
@@ -49,7 +49,7 @@
/**
* Make sure 2 wrappers work together.
- * @throws SQLException - if a database access error occurs
+ * @throws SQLException if a database access error occurs
*/
public void testMultipleWrappers() throws Exception {
// Create a ResultSet with data
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
