ColumnTypeConverters

Registers additional ColumnTypeConverter functions for Room.

Adds converter functions to the scope of the annotated element:

  • Database: available to all DAOs and entities in the database.

  • Dao: available to all functions in the DAO.

  • Entity: available to all properties of the entity.

  • Data class: available to all properties of the data class.

  • Entity property: available only to that property.

  • Dao function: available to all parameters of the function.

  • Dao function parameter: available only to that parameter.

Note: @ColumnTypeConverters only converts column and parameter values. To convert a DAO function return value (e.g., query result transformation), use DaoReturnTypeConverters.

See also
ColumnTypeConverter
ProvidedColumnTypeConverter

Summary

Public constructors
ColumnTypeConverters(
    vararg value: KClass<*>,
    builtInColumnTypeConverters: BuiltInColumnTypeConverters
)
Cmn

Public properties
BuiltInColumnTypeConverters

Configuration for built-in type converters.
Cmn
Array<KClass<*>>

Classes containing type converter functions.
Cmn

Public constructors

ColumnTypeConverters

Cmn
Added in 3.0.0-rc01
ColumnTypeConverters(
    vararg value: KClass<*> = [],
    builtInColumnTypeConverters: BuiltInColumnTypeConverters = BuiltInColumnTypeConverters()
)

Public properties

builtInColumnTypeConverters

Cmn 
val builtInColumnTypeConverters: BuiltInColumnTypeConverters

Configuration for built-in type converters.

value

Cmn 
val value: Array<KClass<*>>

Classes containing type converter functions.

If a converter class is not an object, Room creates an instance of the class.