PreferenceDataStore

<init>

PreferenceDataStore()

A data store interface to be implemented and provided to the Preference framework. This can be used to replace the default android.content.SharedPreferences, if needed.

In most cases you want to use android.content.SharedPreferences as it is automatically backed up and migrated to new devices. However, providing custom data store to preferences can be useful if your app stores its preferences in a local database, cloud, or they are device specific like "Developer settings". It might be also useful when you want to use the preferences UI but the data is not supposed to be stored at all because they are only valid per session.

Once a put method is called it is the full responsibility of the data store implementation to safely store the given values. Time expensive operations need to be done in the background to prevent from blocking the UI. You also need to have a plan on how to serialize the data in case the activity holding this object gets destroyed.

By default, all "put" methods throw UnsupportedOperationException.

getBoolean

open fun getBoolean(
    key: String!, 
    defValue: Boolean
): Boolean

Retrieves a Boolean value from the data store.

getFloat

open fun getFloat(
    key: String!, 
    defValue: Float
): Float

Retrieves a Float value from the data store.

getInt

open fun getInt(
    key: String!, 
    defValue: Int
): Int

Retrieves an Integer value from the data store.

getLong

open fun getLong(
    key: String!, 
    defValue: Long
): Long

Retrieves a Long value from the data store.

getString

@Nullable open fun getString(
    key: String!, 
    @Nullable defValue: String?
): String?

Retrieves a String value from the data store.

getStringSet

@Nullable open fun getStringSet(
    key: String!, 
    @Nullable defValues: MutableSet<String!>?
): MutableSet<String!>?

Retrieves a set of Strings from the data store.

putBoolean

open fun putBoolean(
    key: String!, 
    value: Boolean
): Unit

Sets a Boolean value to the data store.

Once the value is set the data store is responsible for holding it.

putFloat

open fun putFloat(
    key: String!, 
    value: Float
): Unit

Sets a Float value to the data store.

Once the value is set the data store is responsible for holding it.

putInt

open fun putInt(
    key: String!, 
    value: Int
): Unit

Sets an Integer value to the data store.

Once the value is set the data store is responsible for holding it.

putLong

open fun putLong(
    key: String!, 
    value: Long
): Unit

Sets a Long value to the data store.

Once the value is set the data store is responsible for holding it.

putString

open fun putString(
    key: String!, 
    @Nullable value: String?
): Unit

Sets a String value to the data store.

Once the value is set the data store is responsible for holding it.

putStringSet

open fun putStringSet(
    key: String!, 
    @Nullable values: MutableSet<String!>?
): Unit

Sets a set of Strings to the data store.

Once the value is set the data store is responsible for holding it.