Package org.jdbi.v3.core.codec

Interface Codec<T>

@Beta
public interface Codec<T>

A Codec provides a convenient way for a bidirectional mapping of an attribute to a database column.

Groups a ColumnMapper and an Argument mapping function for a given type.

Codec instances can replace existing Mapper and Argument pairs.

Method Summary

Modifier and Type	Method	Description
default Function<T,Argument>	getArgumentFunction()	Returns a Function that creates an Argument to map an attribute value onto the database column.
default Function<T,Argument>	getArgumentFunction(ConfigRegistry configRegistry)	Returns a Function that creates an Argument to map an attribute value onto the database column.
default ColumnMapper<T>	getColumnMapper()	Returns a ColumnMapper that creates an attribute value from a database column.
default ColumnMapper<T>	getColumnMapper(ConfigRegistry configRegistry)	Returns a ColumnMapper that creates an attribute value from a database column.

Method Details

getColumnMapper

default ColumnMapper<T> getColumnMapper()

Returns a ColumnMapper that creates an attribute value from a database column.

Either this method or getColumnMapper(ConfigRegistry) must be implemented.

getColumnMapper

default ColumnMapper<T> getColumnMapper(ConfigRegistry configRegistry)

Returns a ColumnMapper that creates an attribute value from a database column.

This method is optional. If it is not implemented, the result of getColumnMapper() is returned.

Parameters:

configRegistry - The ConfigRegistry that this argument belongs to.

getArgumentFunction

default Function<T,Argument> getArgumentFunction()

Returns a Function that creates an Argument to map an attribute value onto the database column.

Either this method or getArgumentFunction(ConfigRegistry) must be implemented.

getArgumentFunction

default Function<T,Argument> getArgumentFunction(ConfigRegistry configRegistry)

Returns a Function that creates an Argument to map an attribute value onto the database column.

This method is optional. If it is not implemented, the result of getArgumentFunction() is returned.

Parameters:

configRegistry - The ConfigRegistry that this argument belongs to.