org.apache.commons.dbutils.handlers

Class ScalarHandler

java.lang.Object

org.apache.commons.dbutils.handlers.ScalarHandler

All Implemented Interfaces:

ResultSetHandler<Object>

public class ScalarHandler
extends Object
implements ResultSetHandler<Object>

ResultSetHandler implementation that converts one ResultSet column into an Object. This class is thread safe.

See Also:

ResultSetHandler

Constructor Summary

Constructors

Constructor and Description
ScalarHandler() Creates a new instance of ScalarHandler.
ScalarHandler(int columnIndex) Creates a new instance of ScalarHandler.
ScalarHandler(String columnName) Creates a new instance of ScalarHandler.

Method Summary

Methods

Modifier and Type	Method and Description
Object	handle(ResultSet rs) Returns one ResultSet column as an object via the ResultSet.getObject() method that performs type conversions.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScalarHandler

public ScalarHandler()

Creates a new instance of ScalarHandler. The first column will be returned from handle().

ScalarHandler

public ScalarHandler(int columnIndex)

Creates a new instance of ScalarHandler.

Parameters:

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

ScalarHandler

public ScalarHandler(String columnName)

Creates a new instance of ScalarHandler.

Parameters:

columnName - The name of the column to retrieve from the ResultSet.

Method Detail

handle

public Object handle(ResultSet rs)
              throws SQLException

Returns one ResultSet column as an object via the ResultSet.getObject() method that performs type conversions.

Specified by:

handle in interface ResultSetHandler<Object>

Parameters:

rs - ResultSet to process.

Returns:

The column or null if there are no rows in the ResultSet.

Throws:

SQLException - if a database access error occurs

See Also:

ResultSetHandler.handle(java.sql.ResultSet)