dgraham 2003/10/15 20:25:46
Modified: dbutils/src/java/org/apache/commons/dbutils
ResultSetHandler.java
Log:
Added javadoc.
Revision Changes Path
1.5 +19 -7
jakarta-commons-sandbox/dbutils/src/java/org/apache/commons/dbutils/ResultSetHandler.java
Index: ResultSetHandler.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/dbutils/src/java/org/apache/commons/dbutils/ResultSetHandler.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ResultSetHandler.java 15 Oct 2003 03:19:27 -0000 1.4
+++ ResultSetHandler.java 16 Oct 2003 03:25:46 -0000 1.5
@@ -58,16 +58,28 @@
* <http://www.apache.org/>.
*
*/
-
+
package org.apache.commons.dbutils;
+import java.sql.ResultSet;
+import java.sql.SQLException;
+
/**
- *
+ * Implementations of this interface convert ResultSets into other objects.
* @author Juozas Baliuka
*/
public interface ResultSetHandler {
- public Object handle(java.sql.ResultSet rs, Object params[], Object userObject)
- throws java.sql.SQLException;
+ /**
+ * Turn the <code>ResultSet</code> into an Object.
+ * @param rs
+ * @param params
+ * @param userObject
+ * @return An Object initialized with <code>ResultSet</code> data or
+ * <code>null</code> if the <code>ResultSet</code> contained 0 rows.
+ * @throws SQLException
+ */
+ public Object handle(ResultSet rs, Object params[], Object userObject)
+ throws SQLException;
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
