RoomDatabase.JournalMode

kotlin.Any
   ↳ kotlin.Enum
     ↳ androidx.room.RoomDatabase.JournalMode

Journal modes for SQLite database.

See also
RoomDatabase.Builder

#setJournalMode

Summary

Enum Values
AUTOMATIC

Let Room choose the journal mode.
TRUNCATE

Truncate journal mode.
WRITE_AHEAD_LOGGING

Write-Ahead Logging mode.

Public functions
RoomDatabase.JournalMode
valueOf(value: String)

Returns the enum constant of this type with the specified name.
android
RoomDatabase.JournalMode
valueOf(value: String)

Returns the enum constant of this type with the specified name.
Cmn
RoomDatabase.JournalMode
valueOf(value: String)

Returns the enum constant of this type with the specified name.
N
Array<RoomDatabase.JournalMode>

Returns an array containing the constants of this enum type, in the order they're declared.
android
Array<RoomDatabase.JournalMode>

Returns an array containing the constants of this enum type, in the order they're declared.
Cmn
Array<RoomDatabase.JournalMode>

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

Public properties
EnumEntries<RoomDatabase.JournalMode>

Returns a representation of an immutable list of all enum entries, in the order they're declared.
android
EnumEntries<RoomDatabase.JournalMode>

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

Enum Values

AUTOMATIC

val RoomDatabase.JournalMode.AUTOMATIC: RoomDatabase.JournalMode

Let Room choose the journal mode. This is the default value when no explicit value is specified.

The actual value will be TRUNCATE when the device runs API Level lower than 16 or it is a low-RAM device. Otherwise, WRITE_AHEAD_LOGGING will be used.

TRUNCATE

val RoomDatabase.JournalMode.TRUNCATE: RoomDatabase.JournalMode

Truncate journal mode.

WRITE_AHEAD_LOGGING

val RoomDatabase.JournalMode.WRITE_AHEAD_LOGGING: RoomDatabase.JournalMode

Write-Ahead Logging mode.

Public functions

valueOf

android
Added in 2.0.0
fun valueOf(value: String): RoomDatabase.JournalMode

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

valueOf

Cmn
Added in 2.0.0
fun valueOf(value: String): RoomDatabase.JournalMode

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

valueOf

N
Added in 2.0.0
fun valueOf(value: String): RoomDatabase.JournalMode

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

android
Added in 2.0.0
fun values(): Array<RoomDatabase.JournalMode>

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.

values

Cmn
Added in 2.0.0
fun values(): Array<RoomDatabase.JournalMode>

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.

values

N
Added in 2.0.0
fun values(): Array<RoomDatabase.JournalMode>

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.

Public properties

entries

android 
val entries: EnumEntries<RoomDatabase.JournalMode>

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.

entries

Cmn 
val entries: EnumEntries<RoomDatabase.JournalMode>

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.