added in version 26.1.0
belongs to Maven artifact com.android.support:preference-v7:28.0.0-alpha1

Summary: Ctors | Methods | Inherited Methods | [Expand All]

PreferenceDataStore

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

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.

See also:

• setPreferenceDataStore(PreferenceDataStore)
• setPreferenceDataStore(PreferenceDataStore)

Summary

Public constructors
PreferenceDataStore()

Public methods
boolean	getBoolean(String key, boolean defValue) Retrieves a Boolean value from the data store.
float	getFloat(String key, float defValue) Retrieves a Float value from the data store.
int	getInt(String key, int defValue) Retrieves an Integer value from the data store.
long	getLong(String key, long defValue) Retrieves a Long value from the data store.
String	getString(String key, String defValue) Retrieves a String value from the data store.
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 Boolean value to the data store.
void	putFloat(String key, float value) Sets a Float value to the data store.
void	putInt(String key, int value) Sets an Integer value to the data store.
void	putLong(String key, long value) Sets a Long value to the data store.
void	putString(String key, String value) Sets a String value to the data store.
void	putStringSet(String key, Set<String> values) Sets a set of Strings to the data store.

Inherited methods
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()

Public constructors

PreferenceDataStore

added in version 26.1.0

PreferenceDataStore ()

Public methods

getBoolean

added in version 26.1.0

boolean getBoolean (String key, 
                boolean defValue)

Retrieves a Boolean value from the data store.

Parameters
key	String: the name of the preference to retrieve
defValue	boolean: value to return if this preference does not exist in the storage

Returns
boolean	the value from the data store or the default return value

See also:

• getBoolean(String, boolean)

getFloat

added in version 26.1.0

float getFloat (String key, 
                float defValue)

Retrieves a Float value from the data store.

Parameters
key	String: the name of the preference to retrieve
defValue	float: value to return if this preference does not exist in the storage

Returns
float	the value from the data store or the default return value

See also:

• putFloat(String, float)

getInt

added in version 26.1.0

int getInt (String key, 
                int defValue)

Retrieves an Integer value from the data store.

Parameters
key	String: the name of the preference to retrieve
defValue	int: value to return if this preference does not exist in the storage

Returns
int	the value from the data store or the default return value

See also:

• putInt(String, int)

getLong

added in version 26.1.0

long getLong (String key, 
                long defValue)

Retrieves a Long value from the data store.

Parameters
key	String: the name of the preference to retrieve
defValue	long: value to return if this preference does not exist in the storage

Returns
long	the value from the data store or the default return value

See also:

• putLong(String, long)

getString

added in version 26.1.0

String getString (String key, 
                String defValue)

Retrieves a String value from the data store.

Parameters
key	String: the name of the preference to retrieve
defValue	String: value to return if this preference does not exist in the storage

Returns
String	the value from the data store or the default return value

See also:

• putString(String, String)

getStringSet

added in version 26.1.0

Set<String> getStringSet (String key, 
                Set<String> defValues)

Retrieves a set of Strings from the data store.

Parameters
key	String: the name of the preference to retrieve
defValues	Set: values to return if this preference does not exist in the storage

Returns
Set<String>	the values from the data store or the default return values

See also:

• ERROR(/#putStringSet(String, Set))

putBoolean

added in version 26.1.0

void putBoolean (String key, 
                boolean value)

Sets a Boolean value to the data store.

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

Parameters
key	String: the name of the preference to modify
value	boolean: the new value for the preference

See also:

• getBoolean(String, boolean)

putFloat

added in version 26.1.0

void putFloat (String key, 
                float value)

Sets a Float value to the data store.

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

Parameters
key	String: the name of the preference to modify
value	float: the new value for the preference

See also:

• getFloat(String, float)

putInt

added in version 26.1.0

void putInt (String key, 
                int value)

Sets an Integer value to the data store.

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

Parameters
key	String: the name of the preference to modify
value	int: the new value for the preference

See also:

• getInt(String, int)

putLong

added in version 26.1.0

void putLong (String key, 
                long value)

Sets a Long value to the data store.

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

Parameters
key	String: the name of the preference to modify
value	long: the new value for the preference

See also:

• getLong(String, long)

putString

added in version 26.1.0

void putString (String key, 
                String value)

Sets a String value to the data store.

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

Parameters
key	String: the name of the preference to modify
value	String: the new value for the preference

See also:

• getString(String, String)

putStringSet

added in version 26.1.0

void putStringSet (String key, 
                Set<String> values)

Sets a set of Strings to the data store.

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

Parameters
key	String: the name of the preference to modify
values	Set: the set of new values for the preference

See also:

• ERROR(/#getStringSet(String, Set))

• Interfaces

  • DialogPreference.TargetFragment
  • Preference.OnPreferenceChangeListener
  • Preference.OnPreferenceClickListener
  • PreferenceFragmentCompat.OnPreferenceDisplayDialogCallback
  • PreferenceFragmentCompat.OnPreferenceStartFragmentCallback
  • PreferenceFragmentCompat.OnPreferenceStartScreenCallback
  • PreferenceGroup.PreferencePositionCallback
  • PreferenceManager.OnDisplayPreferenceDialogListener
  • PreferenceManager.OnNavigateToScreenListener
  • PreferenceManager.OnPreferenceTreeClickListener

• Classes

  • CheckBoxPreference
  • DialogPreference
  • DropDownPreference
  • EditTextPreference
  • EditTextPreferenceDialogFragmentCompat
  • ListPreference
  • ListPreferenceDialogFragmentCompat
  • MultiSelectListPreferenceDialogFragmentCompat
  • Preference
  • Preference.BaseSavedState
  • PreferenceCategory
  • PreferenceDataStore
  • PreferenceDialogFragmentCompat
  • PreferenceFragmentCompat
  • PreferenceGroup
  • PreferenceManager
  • PreferenceManager.PreferenceComparisonCallback
  • PreferenceManager.SimplePreferenceComparisonCallback
  • PreferenceScreen
  • PreferenceViewHolder
  • R
  • R.anim
  • R.attr
  • R.bool
  • R.color
  • R.dimen
  • R.drawable
  • R.id
  • R.integer
  • R.layout
  • R.string
  • R.style
  • R.styleable
  • SeekBarPreference
  • SwitchPreferenceCompat
  • TwoStatePreference