Added a blank line before the lists of javadoc parameters Removed the unnecessary @inheritDoc tags
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/dbutils/branches/2_0@1481740 13f79535-47bb-0310-9956-ffa450edef68 Project: http://git-wip-us.apache.org/repos/asf/commons-dbutils/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-dbutils/commit/f1e96c2c Tree: http://git-wip-us.apache.org/repos/asf/commons-dbutils/tree/f1e96c2c Diff: http://git-wip-us.apache.org/repos/asf/commons-dbutils/diff/f1e96c2c Branch: refs/heads/2_0 Commit: f1e96c2cac5da05c9ce1ca38d18ae555cc26a45b Parents: 1761b74 Author: Emmanuel Bourg <[email protected]> Authored: Mon May 13 09:10:16 2013 +0000 Committer: Emmanuel Bourg <[email protected]> Committed: Mon May 13 09:10:16 2013 +0000 ---------------------------------------------------------------------- .../commons/dbutils2/AbstractExecutor.java | 8 ++++++++ .../apache/commons/dbutils2/AsyncExecutor.java | 5 +++++ .../commons/dbutils2/BaseResultSetHandler.java | 3 --- .../commons/dbutils2/BasicRowProcessor.java | 12 +++++------- .../apache/commons/dbutils2/BatchExecutor.java | 6 ++++++ .../apache/commons/dbutils2/BeanProcessor.java | 9 ++++++--- .../org/apache/commons/dbutils2/DbUtils.java | 19 +------------------ .../apache/commons/dbutils2/InsertExecutor.java | 2 ++ .../apache/commons/dbutils2/ProxyFactory.java | 7 +++++++ .../apache/commons/dbutils2/QueryExecutor.java | 1 + .../org/apache/commons/dbutils2/QueryLoader.java | 3 +++ .../commons/dbutils2/ResultSetIterator.java | 6 ++++++ .../apache/commons/dbutils2/RowProcessor.java | 2 ++ .../apache/commons/dbutils2/UpdateExecutor.java | 2 ++ .../dbutils2/handlers/AbstractKeyedHandler.java | 3 +++ .../commons/dbutils2/handlers/ArrayHandler.java | 1 + .../dbutils2/handlers/ArrayListHandler.java | 1 + .../commons/dbutils2/handlers/BeanHandler.java | 1 + .../dbutils2/handlers/BeanMapHandler.java | 1 + .../dbutils2/handlers/ColumnListHandler.java | 5 ++++- .../commons/dbutils2/handlers/KeyedHandler.java | 6 +++++- .../commons/dbutils2/handlers/MapHandler.java | 1 + .../dbutils2/handlers/MapListHandler.java | 1 + .../commons/dbutils2/handlers/ScalarHandler.java | 5 ++++- .../wrappers/StringTrimmedResultSet.java | 1 + 25 files changed, 77 insertions(+), 34 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/AbstractExecutor.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/AbstractExecutor.java b/src/main/java/org/apache/commons/dbutils2/AbstractExecutor.java index b1ac3f8..839bc10 100644 --- a/src/main/java/org/apache/commons/dbutils2/AbstractExecutor.java +++ b/src/main/java/org/apache/commons/dbutils2/AbstractExecutor.java @@ -84,6 +84,7 @@ abstract class AbstractExecutor<T extends AbstractExecutor<T>> { /** * Gets the SQL statement that was passed into the constructor. + * * @return the SQL statement passed into the constructor. */ protected String getSql() { @@ -92,6 +93,7 @@ abstract class AbstractExecutor<T extends AbstractExecutor<T>> { /** * Returns the underlying prepared statement. + * * @return the underlying prepared statement. */ protected PreparedStatement getStatement() { @@ -100,6 +102,7 @@ abstract class AbstractExecutor<T extends AbstractExecutor<T>> { /** * Returns the underlying connection. + * * @return the underlying connection. */ protected Connection getConnection() { @@ -108,6 +111,7 @@ abstract class AbstractExecutor<T extends AbstractExecutor<T>> { /** * Throws an exception if there are unmapped params. + * * @throws SQLException if there are unmapped params. */ protected void throwIfUnmappedParams() throws SQLException { @@ -144,6 +148,7 @@ abstract class AbstractExecutor<T extends AbstractExecutor<T>> { * Binds null to a parameter. * Types.VARCHAR is used as the type's parameter. * This usually works, but fails with some Oracle and MS SQL drivers. + * * @param name the name of the parameter. * @return this execution object to provide the fluent style. * @throws SQLException throw if the parameter is not found, already bound, or there is an issue binding null. @@ -154,6 +159,7 @@ abstract class AbstractExecutor<T extends AbstractExecutor<T>> { /** * Binds null to a parameter, specifying the parameter's type. + * * @param name the name of the parameter. * @param sqlType the type of the parameter. * @return this execution object to provide the fluent style. @@ -165,6 +171,7 @@ abstract class AbstractExecutor<T extends AbstractExecutor<T>> { /** * Given a param name and sqlType, binds a null to that parameter. + * * @param name the name of the parameter. * @param sqlType the type of the parameter. * @param removeFromPosMap if the param should be removed from the pos map. @@ -197,6 +204,7 @@ abstract class AbstractExecutor<T extends AbstractExecutor<T>> { /** * Binds value to name, but does not do the bookkeeping. + * * @param name the parameter name. * @param value the value. * @param removeFromPosMap if the param should be removed from the pos map. http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/AsyncExecutor.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/AsyncExecutor.java b/src/main/java/org/apache/commons/dbutils2/AsyncExecutor.java index afcfdb2..dcc58cf 100644 --- a/src/main/java/org/apache/commons/dbutils2/AsyncExecutor.java +++ b/src/main/java/org/apache/commons/dbutils2/AsyncExecutor.java @@ -41,6 +41,7 @@ public class AsyncExecutor { /** * Execute a {@link org.apache.commons.dbutils2.BatchExecutor}. + * * @param executor The executor for this SQL statement. * @return A <code>Future</code> which returns the result of the batch call. * @throws SQLException if a database access error occurs @@ -58,6 +59,7 @@ public class AsyncExecutor { /** * Execute a {@link org.apache.commons.dbutils2.QueryExecutor} given a handler. + * * @param <T> The type of object that the handler returns * @param executor The executor for this SQL statement. * @param handler The handler that converts the results into an object. @@ -77,6 +79,7 @@ public class AsyncExecutor { /** * Execute a {@link org.apache.commons.dbutils2.UpdateExecutor}. + * * @param executor The executor for this SQL statement. * @return A <code>Future</code> which returns the result of the query call. * @throws SQLException if a database access error occurs @@ -94,6 +97,7 @@ public class AsyncExecutor { /** * Execute a {@link org.apache.commons.dbutils2.InsertExecutor} given a handler. + * * @param <T> The type of object that the handler returns * @param executor The executor for this SQL statement. * @param handler The handler that converts the results into an object. @@ -113,6 +117,7 @@ public class AsyncExecutor { /** * Execute a {@link org.apache.commons.dbutils2.InsertExecutor} given a handler. + * * @param executor The executor for this SQL statement. * @return A <code>Future</code> which returns the number of rows inserted. * @throws SQLException if a database access error occurs http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/BaseResultSetHandler.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/BaseResultSetHandler.java b/src/main/java/org/apache/commons/dbutils2/BaseResultSetHandler.java index 1c32b40..8cf2673 100644 --- a/src/main/java/org/apache/commons/dbutils2/BaseResultSetHandler.java +++ b/src/main/java/org/apache/commons/dbutils2/BaseResultSetHandler.java @@ -58,9 +58,6 @@ public abstract class BaseResultSetHandler<T> implements ResultSetHandler<T> { */ private ResultSet rs; - /** - * {@inheritDoc} - */ @Override public final T handle(ResultSet rs) throws SQLException { if (this.rs != null) { http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/BasicRowProcessor.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/BasicRowProcessor.java b/src/main/java/org/apache/commons/dbutils2/BasicRowProcessor.java index c8cc899..1b66dc9 100644 --- a/src/main/java/org/apache/commons/dbutils2/BasicRowProcessor.java +++ b/src/main/java/org/apache/commons/dbutils2/BasicRowProcessor.java @@ -56,8 +56,8 @@ public class BasicRowProcessor implements RowProcessor { /** * BasicRowProcessor constructor. - * @param convert The BeanProcessor to use when converting columns to - * bean properties. + * + * @param convert The BeanProcessor to use when converting columns to bean properties. * @since 1.1 */ public BasicRowProcessor(BeanProcessor convert) { @@ -92,6 +92,7 @@ public class BasicRowProcessor implements RowProcessor { /** * Convert a <code>ResultSet</code> row into a JavaBean. This * implementation delegates to a BeanProcessor instance. + * * @see org.apache.commons.dbutils2.RowProcessor#toBean(java.sql.ResultSet, java.lang.Class) * @see org.apache.commons.dbutils2.BeanProcessor#toBean(java.sql.ResultSet, java.lang.Class) * @param <T> The type of bean to create @@ -108,6 +109,7 @@ public class BasicRowProcessor implements RowProcessor { /** * Convert a <code>ResultSet</code> into a <code>List</code> of JavaBeans. * This implementation delegates to a BeanProcessor instance. + * * @see org.apache.commons.dbutils2.RowProcessor#toBeanList(java.sql.ResultSet, java.lang.Class) * @see org.apache.commons.dbutils2.BeanProcessor#toBeanList(java.sql.ResultSet, java.lang.Class) * @param <T> The type of bean to create @@ -127,6 +129,7 @@ public class BasicRowProcessor implements RowProcessor { * 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. + * * @see org.apache.commons.dbutils2.RowProcessor#toMap(java.sql.ResultSet) * @param rs ResultSet that supplies the map data * @throws SQLException if a database access error occurs @@ -184,7 +187,6 @@ public class BasicRowProcessor implements RowProcessor { */ private static final long serialVersionUID = -2848100435296897392L; - /** {@inheritDoc} */ @Override public boolean containsKey(Object key) { Object realKey = lowerCaseMap.get(key.toString().toLowerCase(Locale.ENGLISH)); @@ -195,14 +197,12 @@ public class BasicRowProcessor implements RowProcessor { // return lowerCaseMap.containsKey(key.toString().toLowerCase()); } - /** {@inheritDoc} */ @Override public Object get(Object key) { Object realKey = lowerCaseMap.get(key.toString().toLowerCase(Locale.ENGLISH)); return super.get(realKey); } - /** {@inheritDoc} */ @Override public Object put(String key, Object value) { /* @@ -218,7 +218,6 @@ public class BasicRowProcessor implements RowProcessor { return oldValue; } - /** {@inheritDoc} */ @Override public void putAll(Map<? extends String, ?> m) { for (Map.Entry<? extends String, ?> entry : m.entrySet()) { @@ -228,7 +227,6 @@ public class BasicRowProcessor implements RowProcessor { } } - /** {@inheritDoc} */ @Override public Object remove(Object key) { Object realKey = lowerCaseMap.remove(key.toString().toLowerCase(Locale.ENGLISH)); http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/BatchExecutor.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/BatchExecutor.java b/src/main/java/org/apache/commons/dbutils2/BatchExecutor.java index 8569873..e8b13a9 100644 --- a/src/main/java/org/apache/commons/dbutils2/BatchExecutor.java +++ b/src/main/java/org/apache/commons/dbutils2/BatchExecutor.java @@ -33,6 +33,7 @@ public class BatchExecutor extends AbstractExecutor<BatchExecutor> { /** * Constructs a BatchExecutor given a connection and SQL statement. + * * @param conn The connection to use during execution. * @param sql The SQL statement. * @param closeConnection If the connection should be closed or not. @@ -45,6 +46,7 @@ public class BatchExecutor extends AbstractExecutor<BatchExecutor> { /** * Binds a parameter name to a value for a given statement. + * * @param name the name of the parameter. * @param value the value to bind to the parameter. * @return this object. @@ -60,6 +62,7 @@ public class BatchExecutor extends AbstractExecutor<BatchExecutor> { * Binds null to a parameter. * Types.VARCHAR is used as the type's parameter. * This usually works, but fails with some Oracle and MS SQL drivers. + * * @param name the name of the parameter. * @return this execution object to provide the fluent style. * @throws SQLException throw if the parameter is not found, already bound, or there is an issue binding null. @@ -71,6 +74,7 @@ public class BatchExecutor extends AbstractExecutor<BatchExecutor> { /** * Binds null to a parameter, specifying the parameter's type. + * * @param name the name of the parameter. * @param sqlType the type of the parameter. * @return this execution object to provide the fluent style. @@ -83,6 +87,7 @@ public class BatchExecutor extends AbstractExecutor<BatchExecutor> { /** * Adds the statement to the batch after binding all of the parameters. + * * @return this object. * @throws SQLException if a SQLException is thrown during the addBatch() call. * @see java.sql.PreparedStatement#addBatch() @@ -100,6 +105,7 @@ public class BatchExecutor extends AbstractExecutor<BatchExecutor> { /** * Calls batch after checking the parameters to ensure nothing is null. + * * @return an array containing the number of rows updated for each statement. * @throws SQLException If there are database or parameter errors. * @see org.apache.commons.dbutils2.UpdateExecutor#execute() http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/BeanProcessor.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/BeanProcessor.java b/src/main/java/org/apache/commons/dbutils2/BeanProcessor.java index 1ee0ff6..53e8515 100644 --- a/src/main/java/org/apache/commons/dbutils2/BeanProcessor.java +++ b/src/main/java/org/apache/commons/dbutils2/BeanProcessor.java @@ -129,6 +129,7 @@ public class BeanProcessor { * <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 @@ -172,6 +173,7 @@ public class BeanProcessor { * <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 @@ -198,6 +200,7 @@ public class BeanProcessor { /** * 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). @@ -236,6 +239,7 @@ public class BeanProcessor { /** * Calls the setter method on the target object for the given property. * If no setter method exists for the property, this method does nothing. + * * @param target The object to set the property on. * @param prop The property to set. * @param value The value to pass into the setter. @@ -340,6 +344,7 @@ public class BeanProcessor { * 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. @@ -388,9 +393,7 @@ public class BeanProcessor { * the column name. If no bean property was found for a column, the * position is set to <code>PROPERTY_NOT_FOUND</code>. * - * @param rsmd The <code>ResultSetMetaData</code> containing column - * information. - * + * @param rsmd The <code>ResultSetMetaData</code> containing column information. * @param props The bean property descriptors. * * @throws SQLException if a database access error occurs http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/DbUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/DbUtils.java b/src/main/java/org/apache/commons/dbutils2/DbUtils.java index 37ff688..47f9ace 100644 --- a/src/main/java/org/apache/commons/dbutils2/DbUtils.java +++ b/src/main/java/org/apache/commons/dbutils2/DbUtils.java @@ -297,6 +297,7 @@ public final class DbUtils { /** * Rollback any changes made on the given connection. + * * @param conn Connection to rollback. A null value is legal. * @throws SQLException if a database access error occurs */ @@ -360,49 +361,31 @@ public final class DbUtils { this.adapted = adapted; } - /** - * {@inheritDoc} - */ @Override public boolean acceptsURL(String url) throws SQLException { return adapted.acceptsURL(url); } - /** - * {@inheritDoc} - */ @Override public Connection connect(String url, Properties info) throws SQLException { return adapted.connect(url, info); } - /** - * {@inheritDoc} - */ @Override public int getMajorVersion() { return adapted.getMajorVersion(); } - /** - * {@inheritDoc} - */ @Override public int getMinorVersion() { return adapted.getMinorVersion(); } - /** - * {@inheritDoc} - */ @Override public DriverPropertyInfo[] getPropertyInfo(String url, Properties info) throws SQLException { return adapted.getPropertyInfo(url, info); } - /** - * {@inheritDoc} - */ @Override public boolean jdbcCompliant() { return adapted.jdbcCompliant(); http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/InsertExecutor.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/InsertExecutor.java b/src/main/java/org/apache/commons/dbutils2/InsertExecutor.java index f1aa78a..8fdd9db 100644 --- a/src/main/java/org/apache/commons/dbutils2/InsertExecutor.java +++ b/src/main/java/org/apache/commons/dbutils2/InsertExecutor.java @@ -32,6 +32,7 @@ public class InsertExecutor extends AbstractExecutor<InsertExecutor> { /** * Constructs an InsertExecutor given a connection and SQL statement. + * * @param conn The connection to use during execution. * @param sql The SQL statement. * @param closeConnection If the connection should be closed or not. @@ -88,6 +89,7 @@ public class InsertExecutor extends AbstractExecutor<InsertExecutor> { /** * Executes the given INSERT SQL statement. + * * @return the number of rows updated. * @throws SQLException If there are database or parameter errors. */ http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/ProxyFactory.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/ProxyFactory.java b/src/main/java/org/apache/commons/dbutils2/ProxyFactory.java index 9410f27..ac9e0db 100644 --- a/src/main/java/org/apache/commons/dbutils2/ProxyFactory.java +++ b/src/main/java/org/apache/commons/dbutils2/ProxyFactory.java @@ -71,6 +71,7 @@ public class ProxyFactory { /** * Creates a new proxy <code>CallableStatement</code> object. + * * @param handler The handler that intercepts/overrides method calls. * @return proxied CallableStatement */ @@ -80,6 +81,7 @@ public class ProxyFactory { /** * Creates a new proxy <code>Connection</code> object. + * * @param handler The handler that intercepts/overrides method calls. * @return proxied Connection */ @@ -89,6 +91,7 @@ public class ProxyFactory { /** * Creates a new proxy <code>Driver</code> object. + * * @param handler The handler that intercepts/overrides method calls. * @return proxied Driver */ @@ -98,6 +101,7 @@ public class ProxyFactory { /** * Creates a new proxy <code>PreparedStatement</code> object. + * * @param handler The handler that intercepts/overrides method calls. * @return proxied PreparedStatement */ @@ -107,6 +111,7 @@ public class ProxyFactory { /** * Creates a new proxy <code>ResultSet</code> object. + * * @param handler The handler that intercepts/overrides method calls. * @return proxied ResultSet */ @@ -116,6 +121,7 @@ public class ProxyFactory { /** * Creates a new proxy <code>ResultSetMetaData</code> object. + * * @param handler The handler that intercepts/overrides method calls. * @return proxied ResultSetMetaData */ @@ -125,6 +131,7 @@ public class ProxyFactory { /** * Creates a new proxy <code>Statement</code> object. + * * @param handler The handler that intercepts/overrides method calls. * @return proxied Statement */ http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/QueryExecutor.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/QueryExecutor.java b/src/main/java/org/apache/commons/dbutils2/QueryExecutor.java index 5fc5c25..0af8b64 100644 --- a/src/main/java/org/apache/commons/dbutils2/QueryExecutor.java +++ b/src/main/java/org/apache/commons/dbutils2/QueryExecutor.java @@ -31,6 +31,7 @@ public class QueryExecutor extends AbstractExecutor<QueryExecutor> { /** * Constructs a QueryExecutor given a connection and SQL statement. + * * @param conn The connection to use during execution. * @param sql The SQL statement. * @param closeConnection If the connection should be closed or not. http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/QueryLoader.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/QueryLoader.java b/src/main/java/org/apache/commons/dbutils2/QueryLoader.java index e7b1f54..59c1152 100644 --- a/src/main/java/org/apache/commons/dbutils2/QueryLoader.java +++ b/src/main/java/org/apache/commons/dbutils2/QueryLoader.java @@ -37,6 +37,7 @@ public class QueryLoader { /** * Return an instance of this class. + * * @return The Singleton instance. */ public static QueryLoader instance() { @@ -84,6 +85,7 @@ public class QueryLoader { /** * 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 if a file access error occurs * @throws IllegalArgumentException if the ClassLoader can't find a file at @@ -115,6 +117,7 @@ public class QueryLoader { /** * Removes the queries for the given path from the cache. + * * @param path The path that the queries were loaded from. */ public synchronized void unload(String path) { http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/ResultSetIterator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/ResultSetIterator.java b/src/main/java/org/apache/commons/dbutils2/ResultSetIterator.java index cd9ca53..ce49c26 100644 --- a/src/main/java/org/apache/commons/dbutils2/ResultSetIterator.java +++ b/src/main/java/org/apache/commons/dbutils2/ResultSetIterator.java @@ -46,6 +46,7 @@ public class ResultSetIterator implements Iterator<Object[]> { /** * Constructor for ResultSetIterator. + * * @param rs Wrap this <code>ResultSet</code> in an <code>Iterator</code>. */ public ResultSetIterator(ResultSet rs) { @@ -54,6 +55,7 @@ public class ResultSetIterator implements Iterator<Object[]> { /** * Constructor for ResultSetIterator. + * * @param rs Wrap this <code>ResultSet</code> in an <code>Iterator</code>. * @param convert The processor to use when converting a row into an * <code>Object[]</code>. Defaults to a @@ -66,6 +68,7 @@ public class ResultSetIterator implements Iterator<Object[]> { /** * 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. */ @@ -81,6 +84,7 @@ public class ResultSetIterator implements Iterator<Object[]> { /** * Returns the next row as an <code>Object[]</code>. + * * @return An <code>Object[]</code> with the same number of elements as * columns in the <code>ResultSet</code>. * @see java.util.Iterator#next() @@ -99,6 +103,7 @@ public class ResultSetIterator implements Iterator<Object[]> { /** * Deletes the current row from the <code>ResultSet</code>. + * * @see java.util.Iterator#remove() * @throws RuntimeException if an SQLException occurs. */ @@ -114,6 +119,7 @@ public class ResultSetIterator implements Iterator<Object[]> { /** * Rethrow the SQLException as a RuntimeException. This implementation * creates a new RuntimeException with the SQLException's error message. + * * @param e SQLException to rethrow * @since 1.1 */ http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/RowProcessor.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/RowProcessor.java b/src/main/java/org/apache/commons/dbutils2/RowProcessor.java index b896b01..c21346f 100644 --- a/src/main/java/org/apache/commons/dbutils2/RowProcessor.java +++ b/src/main/java/org/apache/commons/dbutils2/RowProcessor.java @@ -49,6 +49,7 @@ public interface RowProcessor { * 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 @@ -61,6 +62,7 @@ public interface RowProcessor { * 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 http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/UpdateExecutor.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/UpdateExecutor.java b/src/main/java/org/apache/commons/dbutils2/UpdateExecutor.java index 7ee34f4..5f39687 100644 --- a/src/main/java/org/apache/commons/dbutils2/UpdateExecutor.java +++ b/src/main/java/org/apache/commons/dbutils2/UpdateExecutor.java @@ -30,6 +30,7 @@ public class UpdateExecutor extends AbstractExecutor<UpdateExecutor> { /** * Constructs an UpdateExecutor given a connection and SQL statement. + * * @param conn The connection to use during execution. * @param sql The SQL statement. * @param closeConnection If the connection should be closed or not. @@ -42,6 +43,7 @@ public class UpdateExecutor extends AbstractExecutor<UpdateExecutor> { /** * Calls update after checking the parameters to ensure nothing is null. + * * @return The number of rows updated. * @throws SQLException If there are database or parameter errors. */ http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/handlers/AbstractKeyedHandler.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/handlers/AbstractKeyedHandler.java b/src/main/java/org/apache/commons/dbutils2/handlers/AbstractKeyedHandler.java index a6372e1..b4116f7 100644 --- a/src/main/java/org/apache/commons/dbutils2/handlers/AbstractKeyedHandler.java +++ b/src/main/java/org/apache/commons/dbutils2/handlers/AbstractKeyedHandler.java @@ -41,6 +41,7 @@ public abstract class AbstractKeyedHandler<K, V> implements ResultSetHandler<Map /** * 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 @@ -69,6 +70,7 @@ public abstract class AbstractKeyedHandler<K, V> implements ResultSetHandler<Map /** * This factory method is called by <code>handle()</code> to retrieve the * key value from the current <code>ResultSet</code> row. + * * @param rs ResultSet to create a key from * @return K from the configured key column name/index * @throws SQLException if a database access error occurs @@ -78,6 +80,7 @@ public abstract class AbstractKeyedHandler<K, V> implements ResultSetHandler<Map /** * This factory method is called by <code>handle()</code> to store the * current <code>ResultSet</code> row in some object. + * * @param rs ResultSet to create a row from * @return V object created from the current row * @throws SQLException if a database access error occurs http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/handlers/ArrayHandler.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/handlers/ArrayHandler.java b/src/main/java/org/apache/commons/dbutils2/handlers/ArrayHandler.java index ddac362..5eef4ba 100644 --- a/src/main/java/org/apache/commons/dbutils2/handlers/ArrayHandler.java +++ b/src/main/java/org/apache/commons/dbutils2/handlers/ArrayHandler.java @@ -66,6 +66,7 @@ public class ArrayHandler<T> implements ResultSetHandler<T[]> { /** * Places the column values from the first row in an <code>T[]</code>. + * * @param rs <code>ResultSet</code> to process. * @return An T[] or <code>null</code> if there are no rows in the * <code>ResultSet</code>. http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/handlers/ArrayListHandler.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/handlers/ArrayListHandler.java b/src/main/java/org/apache/commons/dbutils2/handlers/ArrayListHandler.java index 6328c58..6b260a2 100644 --- a/src/main/java/org/apache/commons/dbutils2/handlers/ArrayListHandler.java +++ b/src/main/java/org/apache/commons/dbutils2/handlers/ArrayListHandler.java @@ -58,6 +58,7 @@ public class ArrayListHandler extends AbstractListHandler<Object[]> { /** * Convert row's columns into an <code>Object[]</code>. + * * @param rs <code>ResultSet</code> to process. * @return <code>Object[]</code>, never <code>null</code>. * http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/handlers/BeanHandler.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/handlers/BeanHandler.java b/src/main/java/org/apache/commons/dbutils2/handlers/BeanHandler.java index 9146bd0..e9b17f3 100644 --- a/src/main/java/org/apache/commons/dbutils2/handlers/BeanHandler.java +++ b/src/main/java/org/apache/commons/dbutils2/handlers/BeanHandler.java @@ -68,6 +68,7 @@ public class BeanHandler<T> implements ResultSetHandler<T> { /** * 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>. http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/handlers/BeanMapHandler.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/handlers/BeanMapHandler.java b/src/main/java/org/apache/commons/dbutils2/handlers/BeanMapHandler.java index a8edff0..7e8d5cd 100644 --- a/src/main/java/org/apache/commons/dbutils2/handlers/BeanMapHandler.java +++ b/src/main/java/org/apache/commons/dbutils2/handlers/BeanMapHandler.java @@ -158,6 +158,7 @@ public class BeanMapHandler<K, V> extends AbstractKeyedHandler<K, V> { /** * This factory method is called by <code>handle()</code> to retrieve the * key value from the current <code>ResultSet</code> row. + * * @param rs ResultSet to create a key from * * @return K from the configured key column name/index http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/handlers/ColumnListHandler.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/handlers/ColumnListHandler.java b/src/main/java/org/apache/commons/dbutils2/handlers/ColumnListHandler.java index 39cf128..8cebaa5 100644 --- a/src/main/java/org/apache/commons/dbutils2/handlers/ColumnListHandler.java +++ b/src/main/java/org/apache/commons/dbutils2/handlers/ColumnListHandler.java @@ -69,7 +69,9 @@ public class ColumnListHandler<T> extends AbstractListHandler<T> { this(1, columnName); } - /** Private 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 @@ -83,6 +85,7 @@ public class ColumnListHandler<T> extends AbstractListHandler<T> { /** * 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>. * http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/handlers/KeyedHandler.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/handlers/KeyedHandler.java b/src/main/java/org/apache/commons/dbutils2/handlers/KeyedHandler.java index 4089650..106edb0 100644 --- a/src/main/java/org/apache/commons/dbutils2/handlers/KeyedHandler.java +++ b/src/main/java/org/apache/commons/dbutils2/handlers/KeyedHandler.java @@ -107,7 +107,9 @@ public class KeyedHandler<K> extends AbstractKeyedHandler<K, Map<String, Object> this(ArrayHandler.ROW_PROCESSOR, 1, columnName); } - /** Private 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 @@ -127,6 +129,7 @@ public class KeyedHandler<K> extends AbstractKeyedHandler<K, Map<String, Object> * key value from the current <code>ResultSet</code> row. This * implementation returns <code>ResultSet.getObject()</code> for the * configured key column name or index. + * * @param rs ResultSet to create a key from * @return Object from the configured key column name/index * @@ -149,6 +152,7 @@ public class KeyedHandler<K> extends AbstractKeyedHandler<K, Map<String, Object> * 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. + * * @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 http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/handlers/MapHandler.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/handlers/MapHandler.java b/src/main/java/org/apache/commons/dbutils2/handlers/MapHandler.java index c767948..990619e 100644 --- a/src/main/java/org/apache/commons/dbutils2/handlers/MapHandler.java +++ b/src/main/java/org/apache/commons/dbutils2/handlers/MapHandler.java @@ -60,6 +60,7 @@ public class MapHandler implements ResultSetHandler<Map<String, Object>> { /** * 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>. http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/handlers/MapListHandler.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/handlers/MapListHandler.java b/src/main/java/org/apache/commons/dbutils2/handlers/MapListHandler.java index f557f59..665632a 100644 --- a/src/main/java/org/apache/commons/dbutils2/handlers/MapListHandler.java +++ b/src/main/java/org/apache/commons/dbutils2/handlers/MapListHandler.java @@ -58,6 +58,7 @@ public class MapListHandler extends AbstractListHandler<Map<String, Object>> { /** * 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. * http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/handlers/ScalarHandler.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/handlers/ScalarHandler.java b/src/main/java/org/apache/commons/dbutils2/handlers/ScalarHandler.java index 902c380..1ed8f12 100644 --- a/src/main/java/org/apache/commons/dbutils2/handlers/ScalarHandler.java +++ b/src/main/java/org/apache/commons/dbutils2/handlers/ScalarHandler.java @@ -69,7 +69,9 @@ public class ScalarHandler<T> implements ResultSetHandler<T> { 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 @@ -84,6 +86,7 @@ public class ScalarHandler<T> implements ResultSetHandler<T> { * 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>. http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/f1e96c2c/src/main/java/org/apache/commons/dbutils2/wrappers/StringTrimmedResultSet.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils2/wrappers/StringTrimmedResultSet.java b/src/main/java/org/apache/commons/dbutils2/wrappers/StringTrimmedResultSet.java index c65dbb6..0648f9c 100644 --- a/src/main/java/org/apache/commons/dbutils2/wrappers/StringTrimmedResultSet.java +++ b/src/main/java/org/apache/commons/dbutils2/wrappers/StringTrimmedResultSet.java @@ -72,6 +72,7 @@ public class StringTrimmedResultSet implements InvocationHandler { /** * Constructs a new instance of <code>StringTrimmedResultSet</code> * to wrap the specified <code>ResultSet</code>. + * * @param rs ResultSet to wrap */ public StringTrimmedResultSet(ResultSet rs) {
