belongs to Maven artifact com.android.support:preference-v7:28.0.0-alpha1
PreferenceDataStore
public
abstract
class
PreferenceDataStore
extends Object
java.lang.Object | |
↳ | android.support.v7.preference.PreferenceDataStore |
A data store interface to be implemented and provided to the Preferences framework. This can be
used to replace the default SharedPreferences
, if needed.
In most cases you want to use 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 db, 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 are not supposed to be stored at all because they are valid per session only.
Once a put method is called it is 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
.
Summary
Public constructors | |
---|---|
PreferenceDataStore()
|
Public methods | |
---|---|
boolean
|
getBoolean(String key, boolean defValue)
Retrieves a |
float
|
getFloat(String key, float defValue)
Retrieves a |
int
|
getInt(String key, int defValue)
Retrieves an |
long
|
getLong(String key, long defValue)
Retrieves a |
String
|
getString(String key, String defValue)
Retrieves a |
Set<String>
|
getStringSet(String key, Set<String> defValues)
Retrieves a set of Strings from the data store. |
void
|
putBoolean(String key, boolean value)
Sets a |
void
|
putFloat(String key, float value)
Sets a |
void
|
putInt(String key, int value)
Sets an |
void
|
putLong(String key, long value)
Sets a |
void
|
putString(String key, String value)
Sets a |
void
|
putStringSet(String key, Set<String> values)
Sets a set of Strings to the data store. |
Inherited methods | |
---|---|
![]()
java.lang.Object
|