BuiltInColumnTypeConverters.State

Added in 3.0.1

Kotlin |Java

Cmn

enum BuiltInColumnTypeConverters.State : Enum

kotlin.Any
↳	kotlin.Enum
	↳	androidx.room3.BuiltInColumnTypeConverters.State

Control flags for built-in converters.

Summary

Enum Values
`DISABLED`	Room cannot use the built-in converter.
`ENABLED`	Room can use the built-in converter.
`INHERITED`	Inherits value from a higher scope.

Public functions
`BuiltInColumnTypeConverters.State`	`valueOf(value: String)` Returns the enum constant of this type with the specified name.	Cmn
`Array<BuiltInColumnTypeConverters.State>`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.	Cmn

Public properties
`EnumEntries<BuiltInColumnTypeConverters.State>`	`entries` Returns an immutable `kotlin.enums.EnumEntries` list containing the constants of this enum type, in the order they're declared.	Cmn

Enum Values

DISABLED

val BuiltInColumnTypeConverters.State.DISABLED: BuiltInColumnTypeConverters.State

Room cannot use the built-in converter.

ENABLED

val BuiltInColumnTypeConverters.State.ENABLED: BuiltInColumnTypeConverters.State

Room can use the built-in converter.

INHERITED

val BuiltInColumnTypeConverters.State.INHERITED: BuiltInColumnTypeConverters.State

Inherits value from a higher scope. See ColumnTypeConverters documentation for scoping rules. Defaults to ENABLED if never set.

Public functions

valueOf

Cmn

Added in 3.0.1

fun valueOf(value: String): BuiltInColumnTypeConverters.State

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws
`kotlin.IllegalArgumentException`	if this enum type has no constant with the specified name

values

Cmn

Added in 3.0.1

fun values(): Array<BuiltInColumnTypeConverters.State>

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

The function returns a new instance of the array on every call. The array could be mutated, so working with it may also require defensive copying. Consider using entries property as a more efficient alternative returning an immutable list of enum entries.

Public properties

entries

Cmn

val entries: EnumEntries<BuiltInColumnTypeConverters.State>

Returns an immutable kotlin.enums.EnumEntries list containing the constants of this enum type, in the order they're declared.