Interface TypeHandler

All Known Implementing Classes:

BaseTypeHandler, BigDecimalTypeHandler, BooleanTypeHandler, ByteArrayTypeHandler, ByteTypeHandler, CustomTypeHandler, DateOnlyTypeHandler, DateTypeHandler, DoubleTypeHandler, EnumTypeHandler, FloatTypeHandler, IntegerTypeHandler, LongTypeHandler, ObjectTypeHandler, ShortTypeHandler, SqlDateTypeHandler, SqlTimestampTypeHandler, SqlTimeTypeHandler, StringTypeHandler, TimeOnlyTypeHandler, UnknownTypeHandler

public interface TypeHandler

Interface for getting data into, and out of a mapped statement.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object, String string)	Compares two values (that this handler deals with) for equality.
Object	getResult(CallableStatement cs, int columnIndex)	Gets a column from a callable statement.
Object	getResult(ResultSet rs, int columnIndex)	Gets a column from a result set.
Object	getResult(ResultSet rs, String columnName)	Gets a column from a result set.
void	setParameter(PreparedStatement ps, int i, Object parameter, String jdbcType)	Sets a parameter on a prepared statement.
Object	valueOf(String s)	Converts the String to the type that this handler deals with.

Method Details

setParameter

void setParameter(PreparedStatement ps,
 int i,
 Object parameter,
 String jdbcType)
           throws SQLException

Sets a parameter on a prepared statement.

Parameters:

ps - - the prepared statement

i - - the parameter index

parameter - - the parameter value

jdbcType - - the JDBC type of the parameter

Throws:

SQLException - if setting the parameter fails

getResult

Object getResult(ResultSet rs,
 String columnName)
          throws SQLException

Gets a column from a result set.

Parameters:

rs - - the result set

columnName - - the column name to get

Returns:

- the column value

Throws:

SQLException - if getting the value fails

getResult

Object getResult(ResultSet rs,
 int columnIndex)
          throws SQLException

Gets a column from a result set.

Parameters:

rs - - the result set

columnIndex - - the column to get (by index)

Returns:

- the column value

Throws:

SQLException - if getting the value fails

getResult

Object getResult(CallableStatement cs,
 int columnIndex)
          throws SQLException

Gets a column from a callable statement.

Parameters:

cs - - the statement

columnIndex - - the column to get (by index)

Returns:

- the column value

Throws:

SQLException - if getting the value fails

valueOf

Object valueOf(String s)

Converts the String to the type that this handler deals with.

Parameters:

s - - the String value

Returns:

- the converted value

equals

boolean equals(Object object,
 String string)

Compares two values (that this handler deals with) for equality.

Parameters:

object - - one of the objects

string - - the other object as a String

Returns:

- true if they are equal