prefs-core/com.hendraanggrian.auto.prefs/EditablePreferences

EditablePreferences

interface EditablePreferences<E : PreferencesEditor> : ReadablePreferences

Subinterface of ReadablePreferences that, in contrast to WritablePreferences, requires an instance of PreferencesEditor to modify preferences.

Parameters

editor of this preferences.

Functions

contains

abstract operator fun contains(key: String): Boolean

Checks whether the preferences contains a preference.

edit

open fun edit(editAction: E.() -> Unit)

Convenient method to open an editor and apply changes in dsl.

get

abstract operator fun get(key: String): String?

Retrieve a String value from the preferences.

getBoolean

abstract fun getBoolean(key: String): Boolean?

Retrieve a Boolean value from the preferences.

getBooleanOrDefault

open fun getBooleanOrDefault(key: String, defaultValue: Boolean): Boolean

Retrieve a Boolean value from the preferences, providing default value as a fallback.

getBooleanOrElse

open fun getBooleanOrElse(key: String, defaultValue: () -> Boolean): Boolean

Retrieve a Boolean value from the preferences, calling default value getter as a fallback.

getByte

abstract fun getByte(key: String): Byte?

Retrieve a Byte value from the preferences.

getByteOrDefault

open fun getByteOrDefault(key: String, defaultValue: Byte): Byte

Retrieve a Byte value from the preferences, providing default value as a fallback.

getByteOrElse

open fun getByteOrElse(key: String, defaultValue: () -> Byte): Byte

Retrieve a Byte value from the preferences, calling default value getter as a fallback.

getDouble

abstract fun getDouble(key: String): Double?

Retrieve a Double value from the preferences.

getDoubleOrDefault

open fun getDoubleOrDefault(key: String, defaultValue: Double): Double

Retrieve a Double value from the preferences, providing default value as a fallback.

getDoubleOrElse

open fun getDoubleOrElse(key: String, defaultValue: () -> Double): Double

Retrieve a Double value from the preferences, calling default value getter as a fallback.

getFloat

abstract fun getFloat(key: String): Float?

Retrieve a Float value from the preferences.

getFloatOrDefault

open fun getFloatOrDefault(key: String, defaultValue: Float): Float

Retrieve a Float value from the preferences, providing default value as a fallback.

getFloatOrElse

open fun getFloatOrElse(key: String, defaultValue: () -> Float): Float

Retrieve a Float value from the preferences, calling default value getter as a fallback.

getInt

abstract fun getInt(key: String): Int?

Retrieve an Int value from the preferences.

getIntOrDefault

open fun getIntOrDefault(key: String, defaultValue: Int): Int

Retrieve an Int value from the preferences, providing default value as a fallback.

getIntOrElse

open fun getIntOrElse(key: String, defaultValue: () -> Int): Int

Retrieve an Int value from the preferences, calling default value getter as a fallback.

getLong

abstract fun getLong(key: String): Long?

Retrieve a Long value from the preferences.

getLongOrDefault

open fun getLongOrDefault(key: String, defaultValue: Long): Long

Retrieve a Long value from the preferences, providing default value as a fallback.

getLongOrElse

open fun getLongOrElse(key: String, defaultValue: () -> Long): Long

Retrieve a Long value from the preferences, calling default value getter as a fallback.

getOrDefault

open fun getOrDefault(key: String, defaultValue: String?): String?

Retrieve a String value from the preferences, providing default value as a fallback.

getOrElse

open fun getOrElse(key: String, defaultValue: () -> String?): String?

Retrieve a String value from the preferences, calling default value getter as a fallback.

getShort

abstract fun getShort(key: String): Short?

Retrieve a Short value from the preferences.

getShortOrDefault

open fun getShortOrDefault(key: String, defaultValue: Short): Short

Retrieve a Short value from the preferences, providing default value as a fallback.

getShortOrElse

open fun getShortOrElse(key: String, defaultValue: () -> Short): Short

Retrieve a Short value from the preferences, calling default value getter as a fallback.

Properties

editor

abstract val editor: E

Returns an editor to modify preferences.