org.apache.commons.dbutils.handlers
Class ColumnListHandler

java.lang.Object
  extended by org.apache.commons.dbutils.handlers.GenericListHandler
      extended by org.apache.commons.dbutils.handlers.ColumnListHandler
All Implemented Interfaces:
ResultSetHandler

public class ColumnListHandler
extends GenericListHandler

ResultSetHandler implementation that converts one ResultSet column into a List of Objects. This class is thread safe.

Since:
DbUtils 1.1
See Also:
ResultSetHandler

Field Summary
private  int columnIndex
          The column number to retrieve.
private  java.lang.String columnName
          The column name to retrieve.
 
Constructor Summary
ColumnListHandler()
          Creates a new instance of ColumnListHandler.
ColumnListHandler(int columnIndex)
          Creates a new instance of ColumnListHandler.
ColumnListHandler(java.lang.String columnName)
          Creates a new instance of ColumnListHandler.
 
Method Summary
protected  java.lang.Object handleRow(java.sql.ResultSet rs)
          Returns one ResultSet column value as Object.
 
Methods inherited from class org.apache.commons.dbutils.handlers.GenericListHandler
handle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

columnIndex

private int columnIndex
The column number to retrieve.


columnName

private java.lang.String columnName
The column name to retrieve. Either columnName or columnIndex will be used but never both.

Constructor Detail

ColumnListHandler

public ColumnListHandler()
Creates a new instance of ColumnListHandler. The first column of each row will be returned from handle().


ColumnListHandler

public ColumnListHandler(int columnIndex)
Creates a new instance of ColumnListHandler.

Parameters:
columnIndex - The index of the column to retrieve from the ResultSet.

ColumnListHandler

public ColumnListHandler(java.lang.String columnName)
Creates a new instance of ColumnListHandler.

Parameters:
columnName - The name of the column to retrieve from the ResultSet.
Method Detail

handleRow

protected java.lang.Object handleRow(java.sql.ResultSet rs)
                              throws java.sql.SQLException
Returns one ResultSet column value as Object.

Specified by:
handleRow in class GenericListHandler
Parameters:
rs - ResultSet to process.
Returns:
Object, never null.
Throws:
java.sql.SQLException - if a database access error occurs
See Also:
GenericListHandler.handle(ResultSet)