org.apache.commons.dbutils.handlers
Class BeanListHandler

java.lang.Object
  org.apache.commons.dbutils.handlers.GenericListHandler
      org.apache.commons.dbutils.handlers.BeanListHandler

All Implemented Interfaces:

ResultSetHandler

public class BeanListHandler

extends org.apache.commons.dbutils.handlers.GenericListHandler

ResultSetHandler implementation that converts a ResultSet into a List of beans. This class is thread safe.

See Also:

ResultSetHandler

Constructor Summary

BeanListHandler(java.lang.Class type)
Creates a new instance of BeanListHandler.

BeanListHandler(java.lang.Class type, RowProcessor convert)
Creates a new instance of BeanListHandler.

Method Summary

java.lang.Object	handle(java.sql.ResultSet rs) Whole ResultSet handler.
protected java.lang.Object	handleRow(java.sql.ResultSet rs) Convert the ResultSet row into a bean with the Class given in the constructor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BeanListHandler

public BeanListHandler(java.lang.Class type)

Creates a new instance of BeanListHandler.

Parameters:

type - The Class that objects returned from handle() are created from.

BeanListHandler

public BeanListHandler(java.lang.Class type,
                       RowProcessor convert)

Creates a new instance of BeanListHandler.

Parameters:

type - The Class that objects returned from handle() are created from.

convert - The RowProcessor implementation to use when converting rows into beans.

Method Detail

handleRow

protected java.lang.Object handleRow(java.sql.ResultSet rs)
                              throws java.sql.SQLException

Convert the ResultSet row into a bean with the Class given in the constructor.

Parameters:

rs - ResultSet to process.

Returns:

A bean, never null.

Throws:

java.sql.SQLException - if a database access error occurs

See Also:

GenericListHandler.handle(ResultSet)

handle

public java.lang.Object handle(java.sql.ResultSet rs)
                        throws java.sql.SQLException

Whole ResultSet handler. It produce List as result. To convert individual rows into Java objects it uses handleRow(ResultSet) method.

Specified by:

handle in interface ResultSetHandler

Parameters:

rs - The ResultSet to handle. It has not been touched before being passed to this method.

Returns:

An Object initialized with ResultSet data. It is legal for implementations to return null if the ResultSet contained 0 rows.

Throws:

java.sql.SQLException - if a database access error occurs

See Also:

GenericListHandler.handleRow(ResultSet)