BuiltInColumnTypeConverters


@Target(allowedTargets = )
@Retention(value = AnnotationRetention.BINARY)
public annotation BuiltInColumnTypeConverters


Control flags for built-in column type converters.

Room provides automatic column type converters for common types (enum classes, UUID). These converters are enabled by default but have lower priority than user-provided converters.

Configure these flags in ColumnTypeConverters to enable or disable specific built-in converters.

Summary

Nested types

Control flags for built-in converters.

Public methods

final @NonNull BuiltInColumnTypeConverters.State

Controls whether Room generates a ColumnTypeConverter for java.nio.ByteBuffer.

final @NonNull BuiltInColumnTypeConverters.State

Controls whether Room generates a ColumnTypeConverter for enum types using their name().

final @NonNull BuiltInColumnTypeConverters.State

Controls whether Room generates a ColumnTypeConverter for java.util.UUID using a ByteArray.

Public constructors

BuiltInColumnTypeConverters

Added in 3.0.0-rc01
public BuiltInColumnTypeConverters(
    @NonNull BuiltInColumnTypeConverters.State enums,
    @NonNull BuiltInColumnTypeConverters.State uuid,
    @NonNull BuiltInColumnTypeConverters.State byteBuffer
)

Public methods

getByteBuffer

public final @NonNull BuiltInColumnTypeConverters.State getByteBuffer()

Controls whether Room generates a ColumnTypeConverter for java.nio.ByteBuffer.

Defaults to State.INHERITED.

getEnums

public final @NonNull BuiltInColumnTypeConverters.State getEnums()

Controls whether Room generates a ColumnTypeConverter for enum types using their name().

Defaults to State.INHERITED.

getUuid

public final @NonNull BuiltInColumnTypeConverters.State getUuid()

Controls whether Room generates a ColumnTypeConverter for java.util.UUID using a ByteArray.

Defaults to State.INHERITED.