PreferenceDataStore

public interface PreferenceDataStore

This interface was deprecated in API level 29.
Use the AndroidX Preference Library for consistent behavior across all devices. For more information on using the AndroidX Preference Library see Settings.

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 methods

 public boolean getBoolean (String key, boolean defValue)

 public float getFloat (String key, float defValue)

 public int getInt (String key, int defValue)

 public long getLong (String key, long defValue)

 public String getString (String key, String defValue)

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

 public void putBoolean (String key, boolean value)

 public void putFloat (String key, float value)

 public void putInt (String key, int value)

 public void putLong (String key, long value)

 public void putString (String key, String value)

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