rx3/com.frybits.rx.preferences.rx3/Rx3SharedPreferences

Rx3SharedPreferences

class Rx3SharedPreferences : BaseRxSharedPreferences

Preference factory class to provide Rx3Preference objects

Types

Companion

object Companion

Functions

clear

fun clear()

getBoolean

@CheckResult

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

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

@CheckResult

open override fun getBoolean(key: String?, defaultValue: Boolean): Rx3Preference<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): Rx3Preference<T>

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

@CheckResult

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

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

getFloat

@CheckResult

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

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

@CheckResult

open override fun getFloat(key: String?, defaultValue: Float): Rx3Preference<Float>

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

getInteger

@CheckResult

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

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

@CheckResult

open override fun getInteger(key: String?, defaultValue: Int): Rx3Preference<Int>

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

getLong

@CheckResult

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

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

@CheckResult

open override fun getLong(key: String?, defaultValue: Long): Rx3Preference<Long>

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

getObjectNonNull

@CheckResult

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

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

getString

@CheckResult

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

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

@CheckResult

open override fun getString(key: String?, defaultValue: String?): Rx3Preference<String>

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

getStringSet

@CheckResult

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

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

@CheckResult

open override fun getStringSet(key: String?, defaultValue: Set<String?>?): Rx3Preference<Set<String?>>

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