Author: dfabulich Date: Sat Nov 7 21:51:22 2009 New Revision: 833771 URL: http://svn.apache.org/viewvc?rev=833771&view=rev Log: Fixing CheckStyle errors
Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BasicRowProcessor.java commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BeanProcessor.java commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryLoader.java commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryRunner.java commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ResultSetIterator.java commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/RowProcessor.java commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/AbstractKeyedHandler.java commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/AbstractListHandler.java commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayHandler.java commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayListHandler.java commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/BeanHandler.java commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ColumnListHandler.java commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/KeyedHandler.java commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapHandler.java commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapListHandler.java commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ScalarHandler.java commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/StringTrimmedResultSet.java Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BasicRowProcessor.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BasicRowProcessor.java?rev=833771&r1=833770&r2=833771&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BasicRowProcessor.java (original) +++ commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BasicRowProcessor.java Sat Nov 7 21:51:22 2009 @@ -87,6 +87,9 @@ * will be set to <code>null</code> if the column was SQL NULL. * * @see org.apache.commons.dbutils.RowProcessor#toArray(java.sql.ResultSet) + * @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 { ResultSetMetaData meta = rs.getMetaData(); @@ -104,7 +107,12 @@ * Convert a <code>ResultSet</code> row into a JavaBean. This * implementation delegates to a BeanProcessor instance. * @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) + * @see org.apache.commons.dbutils.BeanProcessor#toBean(java.sql.ResultSet, java.lang.Class) + * @param <T> The type of bean to create + * @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 <T> T toBean(ResultSet rs, Class<T> type) throws SQLException { return this.convert.toBean(rs, type); @@ -115,6 +123,12 @@ * This implementation delegates to a BeanProcessor instance. * @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) + * @param <T> The type of bean to create + * @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>. */ public <T> List<T> toBeanList(ResultSet rs, Class<T> type) throws SQLException { return this.convert.toBeanList(rs, type); @@ -126,6 +140,9 @@ * names as keys. Calls to <code>map.get("COL")</code> and * <code>map.get("col")</code> return the same value. * @see org.apache.commons.dbutils.RowProcessor#toMap(java.sql.ResultSet) + * @param rs ResultSet that supplies the map data + * @throws SQLException if a database access error occurs + * @return the newly created Map */ public Map<String, Object> toMap(ResultSet rs) throws SQLException { Map<String, Object> result = new CaseInsensitiveHashMap(); @@ -155,7 +172,7 @@ * </pre> */ private static class CaseInsensitiveHashMap extends HashMap<String, Object> { - /** + /** * The internal mapping from lowercase keys to the real keys. * * <p> @@ -178,9 +195,7 @@ */ private static final long serialVersionUID = -2848100435296897392L; - /** - * @see java.util.Map#containsKey(java.lang.Object) - */ + /** {...@inheritdoc} */ @Override public boolean containsKey(Object key) { Object realKey = lowerCaseMap.get(key.toString().toLowerCase()); @@ -191,18 +206,14 @@ // return lowerCaseMap.containsKey(key.toString().toLowerCase()); } - /** - * @see java.util.Map#get(java.lang.Object) - */ + /** {...@inheritdoc} */ @Override public Object get(Object key) { Object realKey = lowerCaseMap.get(key.toString().toLowerCase()); return super.get(realKey); } - /** - * @see java.util.Map#put(java.lang.Object, java.lang.Object) - */ + /** {...@inheritdoc} */ @Override public Object put(String key, Object value) { /* @@ -218,9 +229,7 @@ return oldValue; } - /** - * @see java.util.Map#putAll(java.util.Map) - */ + /** {...@inheritdoc} */ @Override public void putAll(Map<? extends String,?> m) { for (Map.Entry<? extends String, ?> entry : m.entrySet()) { @@ -230,9 +239,7 @@ } } - /** - * @see java.util.Map#remove(java.lang.Object) - */ + /** {...@inheritdoc} */ @Override public Object remove(Object key) { Object realKey = lowerCaseMap.remove(key.toString().toLowerCase()); Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BeanProcessor.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BeanProcessor.java?rev=833771&r1=833770&r2=833771&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BeanProcessor.java (original) +++ commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/BeanProcessor.java Sat Nov 7 21:51:22 2009 @@ -109,7 +109,7 @@ * <code>null</code> when SQL NULL is returned. This is the same behavior * as the <code>ResultSet</code> get* methods. * </p> - * + * @param <T> The type of bean to create * @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 @@ -152,7 +152,7 @@ * <code>null</code> when SQL NULL is returned. This is the same behavior * as the <code>ResultSet</code> get* methods. * </p> - * + * @param <T> The type of bean to create * @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 @@ -178,7 +178,7 @@ /** * Creates a new object and initializes its fields from the ResultSet. - * + * @param <T> The type of bean to create * @param rs The result set. * @param type The bean type (the return type of the object). * @param props The property descriptors. @@ -324,7 +324,7 @@ * is called at the start of the bean creation process and may be * overridden to provide custom behavior like returning a cached bean * instance. - * + * @param <T> The type of object to create * @param c The Class to create an object from. * @return A newly created object of the Class. * @throws SQLException if creation failed. @@ -435,11 +435,11 @@ */ protected Object processColumn(ResultSet rs, int index, Class<?> propType) throws SQLException { - - if ( !propType.isPrimitive() && rs.getObject(index) == null ) { - return null; - } - + + if ( !propType.isPrimitive() && rs.getObject(index) == null ) { + return null; + } + if ( !propType.isPrimitive() && rs.getObject(index) == null ) { return null; } Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryLoader.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryLoader.java?rev=833771&r1=833770&r2=833771&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryLoader.java (original) +++ commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryLoader.java Sat Nov 7 21:51:22 2009 @@ -93,7 +93,7 @@ */ @SuppressWarnings("unchecked") protected Map<String,String> loadQueries(String path) throws IOException { - // Findbugs flags getClass().getResource as a bad practice; maybe we should change the API? + // Findbugs flags getClass().getResource as a bad practice; maybe we should change the API? InputStream in = getClass().getResourceAsStream(path); if (in == null) { Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryRunner.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryRunner.java?rev=833771&r1=833770&r2=833771&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryRunner.java (original) +++ commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/QueryRunner.java Sat Nov 7 21:51:22 2009 @@ -173,7 +173,7 @@ ParameterMetaData pmd = null; if (!pmdKnownBroken) { - pmd = stmt.getParameterMetaData(); + pmd = stmt.getParameterMetaData(); if (pmd.getParameterCount() < params.length) { throw new SQLException("Too many parameters: expected " + pmd.getParameterCount() + ", was given " + params.length); @@ -340,14 +340,14 @@ /** * Execute an SQL SELECT query with a single replacement parameter. The * caller is responsible for closing the connection. - * + * @param <T> The type of object that the handler returns * @param conn The connection to execute the query in. * @param sql The query to execute. * @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 - * @deprecated Use {...@link #query(Connection,String,ResultSetHandler<T>,Object...)} instead + * @deprecated Use {...@link #query(Connection, String, ResultSetHandler, Object...)} */ public <T> T query(Connection conn, String sql, Object param, ResultSetHandler<T> rsh) throws SQLException { @@ -358,14 +358,14 @@ /** * Execute an SQL SELECT query with replacement parameters. The * caller is responsible for closing the connection. - * + * @param <T> The type of object that the handler returns * @param conn The connection to execute the query in. * @param sql The query to execute. * @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 - * @deprecated Use {...@link #query(Connection,String,ResultSetHandler<T>,Object...)} instead + * @deprecated Use {...@link #query(Connection,String,ResultSetHandler,Object...)} instead */ public <T> T query(Connection conn, String sql, Object[] params, ResultSetHandler<T> rsh) throws SQLException { @@ -374,7 +374,7 @@ /** * Execute an SQL SELECT query with replacement parameters. The * caller is responsible for closing the connection. - * + * @param <T> The type of object that the handler returns * @param conn The connection to execute the query in. * @param sql The query to execute. * @param rsh The handler that converts the results into an object. @@ -412,7 +412,7 @@ /** * Execute an SQL SELECT query without any replacement parameters. The * caller is responsible for closing the connection. - * + * @param <T> The type of object that the handler returns * @param conn The connection to execute the query in. * @param sql The query to execute. * @param rsh The handler that converts the results into an object. @@ -429,7 +429,7 @@ * Executes the given SELECT SQL with a single replacement parameter. * The <code>Connection</code> is retrieved from the * <code>DataSource</code> set in the constructor. - * + * @param <T> The type of object that the handler returns * @param sql The SQL statement to execute. * @param param The replacement parameter. * @param rsh The handler used to create the result object from @@ -449,7 +449,7 @@ * Executes the given SELECT SQL query and returns a result object. * The <code>Connection</code> is retrieved from the * <code>DataSource</code> set in the constructor. - * + * @param <T> The type of object that the handler returns * @param sql The SQL statement to execute. * @param params Initialize the PreparedStatement's IN parameters with * this array. @@ -470,7 +470,7 @@ * Executes the given SELECT SQL query and returns a result object. * The <code>Connection</code> is retrieved from the * <code>DataSource</code> set in the constructor. - * + * @param <T> The type of object that the handler returns * @param sql The SQL statement to execute. * @param rsh The handler used to create the result object from * the <code>ResultSet</code>. @@ -495,7 +495,7 @@ * Executes the given SELECT SQL without any replacement parameters. * The <code>Connection</code> is retrieved from the * <code>DataSource</code> set in the constructor. - * + * @param <T> The type of object that the handler returns * @param sql The SQL statement to execute. * @param rsh The handler used to create the result object from * the <code>ResultSet</code>. Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ResultSetIterator.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ResultSetIterator.java?rev=833771&r1=833770&r2=833771&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ResultSetIterator.java (original) +++ commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/ResultSetIterator.java Sat Nov 7 21:51:22 2009 @@ -120,9 +120,7 @@ /** Generates an <code>Iterable</code>, suitable for use in for-each loops. * - * @param <T> the type of the bean to create * @param rs Wrap this <code>ResultSet</code> in an <code>Iterator</code>. - * @param type The type of bean to create * @return an <code>Iterable</code>, suitable for use in for-each loops. */ public static Iterable<Object[]> iterable(final ResultSet rs) { Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/RowProcessor.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/RowProcessor.java?rev=833771&r1=833770&r2=833771&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/RowProcessor.java (original) +++ commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/RowProcessor.java Sat Nov 7 21:51:22 2009 @@ -49,7 +49,7 @@ * 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 <T> The type of bean to create * @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 @@ -61,7 +61,7 @@ * Create a <code>List</code> of JavaBeans from the column values in all * <code>ResultSet</code> rows. <code>ResultSet.next()</code> should * <strong>not</strong> be called before passing it to this method. - * + * @param <T> The type of bean to create * @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 Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/AbstractKeyedHandler.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/AbstractKeyedHandler.java?rev=833771&r1=833770&r2=833771&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/AbstractKeyedHandler.java (original) +++ commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/AbstractKeyedHandler.java Sat Nov 7 21:51:22 2009 @@ -39,7 +39,7 @@ /** * Convert each row's columns into a Map and store then * in a <code>Map</code> under <code>ResultSet.getObject(key)</code> key. - * + * @param rs <code>ResultSet</code> to process. * @return A <code>Map</code>, never <code>null</code>. * @throws SQLException if a database access error occurs * @see org.apache.commons.dbutils.ResultSetHandler#handle(java.sql.ResultSet) Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/AbstractListHandler.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/AbstractListHandler.java?rev=833771&r1=833770&r2=833771&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/AbstractListHandler.java (original) +++ commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/AbstractListHandler.java Sat Nov 7 21:51:22 2009 @@ -36,6 +36,9 @@ * <code>handleRow(ResultSet)</code> method. * * @see #handleRow(ResultSet) + * @param rs <code>ResultSet</code> to process. + * @return a list of all rows in the result set + * @throws SQLException error occurs */ public List<T> handle(ResultSet rs) throws SQLException { List<T> rows = new ArrayList<T>(); Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayHandler.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayHandler.java?rev=833771&r1=833770&r2=833771&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayHandler.java (original) +++ commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayHandler.java Sat Nov 7 21:51:22 2009 @@ -66,7 +66,7 @@ /** * Places the column values from the first row in an <code>Object[]</code>. - * + * @param rs <code>ResultSet</code> to process. * @return An Object[] or <code>null</code> if there are no rows in the * <code>ResultSet</code>. * Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayListHandler.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayListHandler.java?rev=833771&r1=833770&r2=833771&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayListHandler.java (original) +++ commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ArrayListHandler.java Sat Nov 7 21:51:22 2009 @@ -58,7 +58,7 @@ /** * Convert row's columns into an <code>Object[]</code>. - * + * @param rs <code>ResultSet</code> to process. * @return <code>Object[]</code>, never <code>null</code>. * * @throws SQLException if a database access error occurs Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/BeanHandler.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/BeanHandler.java?rev=833771&r1=833770&r2=833771&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/BeanHandler.java (original) +++ commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/BeanHandler.java Sat Nov 7 21:51:22 2009 @@ -67,7 +67,7 @@ /** * Convert the first row of the <code>ResultSet</code> into a bean with the * <code>Class</code> given in the constructor. - * + * @param rs <code>ResultSet</code> to process. * @return An initialized JavaBean or <code>null</code> if there were no * rows in the <code>ResultSet</code>. * Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ColumnListHandler.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ColumnListHandler.java?rev=833771&r1=833770&r2=833771&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ColumnListHandler.java (original) +++ commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ColumnListHandler.java Sat Nov 7 21:51:22 2009 @@ -68,7 +68,12 @@ this(1, columnName); } - // Helper + /** Private Helper + * @param columnIndex The index of the column to retrieve from the + * <code>ResultSet</code>. + * @param columnName The name of the column to retrieve from the + * <code>ResultSet</code>. + */ private ColumnListHandler(int columnIndex, String columnName) { super(); this.columnIndex = columnIndex; @@ -77,7 +82,7 @@ /** * Returns one <code>ResultSet</code> column value as <code>Object</code>. - * + * @param rs <code>ResultSet</code> to process. * @return <code>Object</code>, never <code>null</code>. * * @throws SQLException if a database access error occurs Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/KeyedHandler.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/KeyedHandler.java?rev=833771&r1=833770&r2=833771&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/KeyedHandler.java (original) +++ commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/KeyedHandler.java Sat Nov 7 21:51:22 2009 @@ -106,7 +106,14 @@ this(ArrayHandler.ROW_PROCESSOR, 1, columnName); } - // Helper + /** Private Helper + * @param convert The <code>RowProcessor</code> implementation + * to use when converting rows into Maps + * @param columnIndex The values to use as keys in the Map are + * retrieved from the column at this index. + * @param columnName The values to use as keys in the Map are + * retrieved from the column with this name. + */ private KeyedHandler(RowProcessor convert, int columnIndex, String columnName) { super(); Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapHandler.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapHandler.java?rev=833771&r1=833770&r2=833771&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapHandler.java (original) +++ commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapHandler.java Sat Nov 7 21:51:22 2009 @@ -60,7 +60,7 @@ /** * Converts the first row in the <code>ResultSet</code> into a * <code>Map</code>. - * + * @param rs <code>ResultSet</code> to process. * @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>. * Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapListHandler.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapListHandler.java?rev=833771&r1=833770&r2=833771&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapListHandler.java (original) +++ commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/MapListHandler.java Sat Nov 7 21:51:22 2009 @@ -58,7 +58,7 @@ /** * Converts the <code>ResultSet</code> row into a <code>Map</code> object. - * + * @param rs <code>ResultSet</code> to process. * @return A <code>Map</code>, never null. * * @throws SQLException if a database access error occurs Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ScalarHandler.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ScalarHandler.java?rev=833771&r1=833770&r2=833771&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ScalarHandler.java (original) +++ commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/handlers/ScalarHandler.java Sat Nov 7 21:51:22 2009 @@ -68,7 +68,12 @@ this(1, columnName); } - // Helper constructor + /** Helper constructor + * @param columnIndex The index of the column to retrieve from the + * <code>ResultSet</code>. + * @param columnName The name of the column to retrieve from the + * <code>ResultSet</code>. + */ private ScalarHandler(int columnIndex, String columnName){ this.columnIndex = columnIndex; this.columnName = columnName; @@ -78,7 +83,7 @@ * Returns one <code>ResultSet</code> column as an object via the * <code>ResultSet.getObject()</code> method that performs type * conversions. - * + * @param rs <code>ResultSet</code> to process. * @return The column or <code>null</code> if there are no rows in * the <code>ResultSet</code>. * Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java?rev=833771&r1=833770&r2=833771&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java (original) +++ commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java Sat Nov 7 21:51:22 2009 @@ -360,9 +360,13 @@ * Intercepts calls to <code>get*</code> methods and calls the appropriate * <code>getNull*</code> method if the <code>ResultSet</code> returned * <code>null</code>. - * - * @throws Throwable - * @see java.lang.reflect.InvocationHandler#invoke(java.lang.Object, java.lang.reflect.Method, java.lang.Object[]) + * + * @see java.lang.reflect.InvocationHandler#invoke(java.lang.Object, java.lang.reflect.Method, java.lang.Object[]) + * @param proxy Not used; all method calls go to the internal result set + * @param method The method to invoke on the result set + * @param args The arguments to pass to the result set + * @return null checked result + * @throws Throwable error */ public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { Modified: commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/StringTrimmedResultSet.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/StringTrimmedResultSet.java?rev=833771&r1=833770&r2=833771&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/StringTrimmedResultSet.java (original) +++ commons/proper/dbutils/trunk/src/java/org/apache/commons/dbutils/wrappers/StringTrimmedResultSet.java Sat Nov 7 21:51:22 2009 @@ -84,8 +84,12 @@ * <code>getObject()</code> methods and trim any Strings before they're * returned. * - * @throws Throwable * @see java.lang.reflect.InvocationHandler#invoke(java.lang.Object, java.lang.reflect.Method, java.lang.Object[]) + * @param proxy Not used; all method calls go to the internal result set + * @param method The method to invoke on the result set + * @param args The arguments to pass to the result set + * @return string trimmed result + * @throws Throwable error */ public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {