core/com.frybits.rx.preferences.core/RxSharedPreferences

RxSharedPreferences

class RxSharedPreferences

Preference factory class to provide Preference objects used reactive frameworks

Parameters

sharedPreferences

The preferences that back this factory

Types

Companion

object Companion

Properties

sharedPreferences

val sharedPreferences: SharedPreferences

Functions

clear

fun clear()

Clears the underlying shared preferences

getBoolean

@CheckResult

fun getBoolean(key: String?): Preference<Boolean>

Creates a Boolean preference for the key with a default of false

@CheckResult

fun getBoolean(key: String?, defaultValue: Boolean): Preference<Boolean>

Creates a Boolean preference for the key with a default of defaultValue

getEnum

@CheckResult

inline fun <T : Enum<T>> getEnum(key: String?, defaultValue: T): Preference<T>

Creates a T preference for the key using the enum class type T with a default of defaultValue

@CheckResult

fun <T : Enum<T>> getEnum(key: String?, defaultValue: T, clazz: Class<T>): Preference<T>

Creates a T preference for the key using the enum class clazz with a default of defaultValue

getFloat

@CheckResult

fun getFloat(key: String?): Preference<Float>

Creates a Float preference for the key with a default of 0F

@CheckResult

fun getFloat(key: String?, defaultValue: Float): Preference<Float>

Creates a Float preference for the key with a default of defaultValue

getInteger

@CheckResult

fun getInteger(key: String?): Preference<Int>

Creates a Int preference for the key with a default of 0

@CheckResult

fun getInteger(key: String?, defaultValue: Int): Preference<Int>

Creates a Int preference for the key with a default of defaultValue

getLong

@CheckResult

fun getLong(key: String?): Preference<Long>

Creates a Long preference for the key with a default of 0L

@CheckResult

fun getLong(key: String?, defaultValue: Long): Preference<Long>

Creates a Long preference for the key with a default of defaultValue

getObject

@CheckResult

fun <T> getObject(key: String?, defaultValue: T, converter: Preference.Converter<T>): Preference<T>

Creates a T preference for the key using the converter, and with a default of defaultValue.

getObjectNonNull

@CheckResult

fun <T : Any> ~~getObjectNonNull~~(key: String?, defaultValue: T, converter: Preference.Converter<T>): Preference<T>

getString

@CheckResult

fun getString(key: String?): Preference<String?>

Creates a String preference for the key with a default of an empty string

@CheckResult

fun getString(key: String?, defaultValue: String?): Preference<String?>

Creates a String preference for the key with a default of defaultValue

getStringSet

@CheckResult

fun getStringSet(key: String?): Preference<Set<String?>?>

Creates a string Set preference for the key with a default of emptySet

@CheckResult

fun getStringSet(key: String?, defaultValue: Set<String?>?): Preference<Set<String?>?>

Creates a string Set preference for the key with a default of defaultValue