BuiltInColumnTypeConverters.State

Kotlin |Java

public enum BuiltInColumnTypeConverters.State extends Enum

java.lang.Object
↳	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 methods
`final @NonNull EnumEntries<@NonNull BuiltInColumnTypeConverters.State>`	`getEntries()` Returns a representation of an immutable list of all enum entries, in the order they're declared.
`final @NonNull BuiltInColumnTypeConverters.State`	`valueOf(@NonNull String value)` Returns the enum constant of this type with the specified name.
`final @NonNull BuiltInColumnTypeConverters.State[]`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.

Enum Values

DISABLED

BuiltInColumnTypeConverters.State BuiltInColumnTypeConverters.State.DISABLED

Room cannot use the built-in converter.

ENABLED

BuiltInColumnTypeConverters.State BuiltInColumnTypeConverters.State.ENABLED

Room can use the built-in converter.

INHERITED

BuiltInColumnTypeConverters.State BuiltInColumnTypeConverters.State.INHERITED

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

Public methods

getEntries

public final @NonNull EnumEntries<@NonNull BuiltInColumnTypeConverters.State> getEntries()

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.

valueOf

Added in 3.0.0-rc01

public final @NonNull BuiltInColumnTypeConverters.State valueOf(@NonNull String value)

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

Added in 3.0.0-rc01

public final @NonNull BuiltInColumnTypeConverters.State[] values()

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.