Platform Android Studio Google Play Android Jetpack Docs News
Overview Guides Reference Samples Design & Quality
Save the date! Android Dev Summit is coming to Sunnyvale, CA on Oct 23-24, 2019.

TypeConverters

@Target([AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CLASS, AnnotationTarget.FILE, AnnotationTarget.FIELD]) class TypeConverters
androidx.room.TypeConverters

Specifies additional type converters that Room can use. The TypeConverter is added to the scope of the element so if you put it on a class / interface, all methods / fields in that class will be able to use the converters.

  • If you put it on a Database, all Daos and Entities in that database will be able to use it.
  • If you put it on a Dao, all methods in the Dao will be able to use it.
  • If you put it on an Entity, all fields of the Entity will be able to use it.
  • If you put it on a POJO, all fields of the POJO will be able to use it.
  • If you put it on an Entity field, only that field will be able to use it.
  • If you put it on a Dao method, all parameters of the method will be able to use it.
  • If you put it on a Dao method parameter, just that field will be able to use it.

Summary

Public constructors
<init>(vararg value: KClass<*>)

Specifies additional type converters that Room can use.
Properties
Array<KClass<*>>

The list of type converter classes.

Public constructors

<init>

TypeConverters(vararg value: KClass<*>)

Specifies additional type converters that Room can use. The TypeConverter is added to the scope of the element so if you put it on a class / interface, all methods / fields in that class will be able to use the converters.

  • If you put it on a Database, all Daos and Entities in that database will be able to use it.
  • If you put it on a Dao, all methods in the Dao will be able to use it.
  • If you put it on an Entity, all fields of the Entity will be able to use it.
  • If you put it on a POJO, all fields of the POJO will be able to use it.
  • If you put it on an Entity field, only that field will be able to use it.
  • If you put it on a Dao method, all parameters of the method will be able to use it.
  • If you put it on a Dao method parameter, just that field will be able to use it.

See Also

Properties

value

val value: Array<KClass<*>>

The list of type converter classes. If converter methods are not static, Room will create an instance of these classes.

Return
Array<KClass<*>>: The list of classes that contains the converter methods.