org.jooq

Interface Converter<T,U>

Type Parameters:

T - The database type - i.e. any type available from SQLDataType

U - The user type

All Superinterfaces:

Serializable

All Known Implementing Classes:

EnumConverter

public interface Converter<T,U>
extends Serializable

A Converter for data types.

A general data type conversion interface that can be provided to jOOQ at various places in order to perform custom data type conversion. Conversion is directed, this means that the Converter is used

• to load database types converting them to user types "FROM" the database. Hence, fromType() is the type as defined in the database.
• to store user types converting them to database types "TO" the database. Hence, toType() is the user-defined type

Note: In order to avoid unwanted side-effects, it is highly recommended (yet not required) for from(Object) and to(Object) to be reciprocal. The two methods are reciprocal, if for all X and Y, it can be said that

• if Y.equals(converter.from(X)), then X.equals(converter.to(Y)).
• X.equals(converter.from(converter.to(X)))
• X.equals(converter.to(converter.from(X)))

Furthermore, it is recommended (yet not required) that

• converter.from(null) == null
• converter.to(null) == null

Author:

Lukas Eder

Method Summary

Methods

Modifier and Type	Method and Description
U	from(T databaseObject) Convert a database object to a user object
Class<T>	fromType() The database type
T	to(U userObject) Convert a user object to a database object
Class<U>	toType() The user type

Method Detail

from

U from(T databaseObject)

Convert a database object to a user object

Parameters:

databaseObject - The database object

Returns:

The user object

to

T to(U userObject)

Convert a user object to a database object

Parameters:

userObject - The user object

Returns:

The database object

fromType

Class<T> fromType()

The database type

toType

Class<U> toType()

The user type