Class BaseTypeHandler<T>

java.lang.Object

org.apache.ibatis.type.TypeReference<T>

org.apache.ibatis.type.BaseTypeHandler<T>

All Implemented Interfaces:

TypeHandler<T>

Direct Known Subclasses:

ArrayTypeHandler, BigDecimalTypeHandler, BigIntegerTypeHandler, BlobByteObjectArrayTypeHandler, BlobInputStreamTypeHandler, BlobTypeHandler, BooleanTypeHandler, ByteArrayTypeHandler, ByteObjectArrayTypeHandler, ByteTypeHandler, CharacterTypeHandler, ClobReaderTypeHandler, ClobTypeHandler, DateOnlyTypeHandler, DateTypeHandler, DoubleTypeHandler, EnumOrdinalTypeHandler, EnumTypeHandler, FloatTypeHandler, InstantTypeHandler, IntegerTypeHandler, JapaneseDateTypeHandler, LocalDateTimeTypeHandler, LocalDateTypeHandler, LocalTimeTypeHandler, LongTypeHandler, MonthTypeHandler, NClobTypeHandler, NStringTypeHandler, ObjectTypeHandler, OffsetDateTimeTypeHandler, OffsetTimeTypeHandler, ShortTypeHandler, SqlDateTypeHandler, SqlTimestampTypeHandler, SqlTimeTypeHandler, SqlxmlTypeHandler, StringTypeHandler, TimeOnlyTypeHandler, UnknownTypeHandler, YearMonthTypeHandler, YearTypeHandler, ZonedDateTimeTypeHandler

public abstract class BaseTypeHandler<T>
extends TypeReference<T>
implements TypeHandler<T>

The base TypeHandler for references a generic type.

Important: Since 3.5.0, This class never call the ResultSet.wasNull() and CallableStatement.wasNull() method for handling the SQL NULL value. In other words, null value handling should be performed on subclass.

Field Summary

Fields

Modifier and Type	Field	Description
protected Configuration	configuration	Deprecated. Since 3.5.0 - See https://github.com/mybatis/mybatis-3/issues/1203.

Constructor Summary

Constructors

Constructor	Description
BaseTypeHandler()

Method Summary

Modifier and Type	Method	Description
abstract T	getNullableResult(CallableStatement cs, int columnIndex)
abstract T	getNullableResult(ResultSet rs, int columnIndex)
abstract T	getNullableResult(ResultSet rs, String columnName)	Gets the nullable result.
T	getResult(CallableStatement cs, int columnIndex)
T	getResult(ResultSet rs, int columnIndex)
T	getResult(ResultSet rs, String columnName)	Gets the result.
void	setConfiguration(Configuration c)	Deprecated. Since 3.5.0 - See https://github.com/mybatis/mybatis-3/issues/1203.
abstract void	setNonNullParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType)
void	setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType)

Methods inherited from class TypeReference

getRawType, getSuperclassTypeParameter, toString

Methods inherited from class Object

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

Field Details

configuration

@Deprecated
protected Configuration configuration

Deprecated.

Since 3.5.0 - See https://github.com/mybatis/mybatis-3/issues/1203. This field will remove future.

Constructor Details

BaseTypeHandler

public BaseTypeHandler()

Method Details

setConfiguration

@Deprecated
public void setConfiguration(Configuration c)

Deprecated.

Since 3.5.0 - See https://github.com/mybatis/mybatis-3/issues/1203. This property will remove future.

Sets the configuration.

Parameters:

c - the new configuration

setParameter

public void setParameter(PreparedStatement ps,
 int i,
 T parameter,
 JdbcType jdbcType)
                  throws SQLException

Specified by:

setParameter in interface TypeHandler<T>

Throws:

SQLException

getResult

public T getResult(ResultSet rs,
 String columnName)
            throws SQLException

Description copied from interface: TypeHandler

Gets the result.

Specified by:

getResult in interface TypeHandler<T>

Parameters:

rs - the rs

columnName - Column name, when configuration useColumnLabel is false

Returns:

the result

Throws:

SQLException - the SQL exception

getResult

public T getResult(ResultSet rs,
 int columnIndex)
            throws SQLException

Specified by:

getResult in interface TypeHandler<T>

Throws:

SQLException

getResult

public T getResult(CallableStatement cs,
 int columnIndex)
            throws SQLException

Specified by:

getResult in interface TypeHandler<T>

Throws:

SQLException

setNonNullParameter

public abstract void setNonNullParameter(PreparedStatement ps,
 int i,
 T parameter,
 JdbcType jdbcType)
                                  throws SQLException

Throws:

SQLException

getNullableResult

public abstract T getNullableResult(ResultSet rs,
 String columnName)
                             throws SQLException

Gets the nullable result.

Parameters:

rs - the rs

columnName - Column name, when configuration useColumnLabel is false

Returns:

the nullable result

Throws:

SQLException - the SQL exception

getNullableResult

public abstract T getNullableResult(ResultSet rs,
 int columnIndex)
                             throws SQLException

Throws:

SQLException

getNullableResult

public abstract T getNullableResult(CallableStatement cs,
 int columnIndex)
                             throws SQLException

Throws:

SQLException