# PreferenceDataStore

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level
29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

# PreferenceDataStore

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/preference/PreferenceDataStore "View this page in Kotlin") \|Java


`
public


interface
PreferenceDataStore
`


`


`

|----------------------------------------|
| android.preference.PreferenceDataStore |

<br />

*** ** * ** ***


**This interface was deprecated
in API level 29.**   

Use the [AndroidX](https://developer.android.com/jetpack/androidx)
[Preference Library](https://developer.android.com/reference/androidx/preference/package-summary) for consistent behavior across all devices. For more information on
using the AndroidX Preference Library see
[Settings](https://developer.android.com/guide/topics/ui/settings).

A data store interface to be implemented and provided to the Preferences framework. This can be
used to replace the default [SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences), if needed.

In most cases you want to use [SharedPreferences](https://developer.android.com/reference/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 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](https://developer.android.com/reference/java/lang/UnsupportedOperationException).  
**See also:**

- [Preference.setPreferenceDataStore(PreferenceDataStore)](https://developer.android.com/reference/android/preference/Preference#setPreferenceDataStore(android.preference.PreferenceDataStore))
- [PreferenceManager.setPreferenceDataStore(PreferenceDataStore)](https://developer.android.com/reference/android/preference/PreferenceManager#setPreferenceDataStore(android.preference.PreferenceDataStore))

## Summary

|                                                                                                                                                                                                                                                                                           ### Public methods                                                                                                                                                                                                                                                                                           ||
|-------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` default boolean`                                                                                                                              | ` `[getBoolean](https://developer.android.com/reference/android/preference/PreferenceDataStore#getBoolean(java.lang.String,%20boolean))`(`[String](https://developer.android.com/reference/java/lang/String)` key, boolean defValue) ` Retrieve a boolean value from the data store.                                                                                                                                                                  |
| ` default float`                                                                                                                                | ` `[getFloat](https://developer.android.com/reference/android/preference/PreferenceDataStore#getFloat(java.lang.String,%20float))`(`[String](https://developer.android.com/reference/java/lang/String)` key, float defValue) ` Retrieve a float value from the data store.                                                                                                                                                                            |
| ` default int`                                                                                                                                  | ` `[getInt](https://developer.android.com/reference/android/preference/PreferenceDataStore#getInt(java.lang.String,%20int))`(`[String](https://developer.android.com/reference/java/lang/String)` key, int defValue) ` Retrieve an int value from the data store.                                                                                                                                                                                     |
| ` default long`                                                                                                                                 | ` `[getLong](https://developer.android.com/reference/android/preference/PreferenceDataStore#getLong(java.lang.String,%20long))`(`[String](https://developer.android.com/reference/java/lang/String)` key, long defValue) ` Retrieve a long value from the data store.                                                                                                                                                                                 |
| ` default `[String](https://developer.android.com/reference/java/lang/String)                                                                   | ` `[getString](https://developer.android.com/reference/android/preference/PreferenceDataStore#getString(java.lang.String,%20java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` key, `[String](https://developer.android.com/reference/java/lang/String)` defValue) ` Retrieve a String value from the data store.                                                                                               |
| ` default `[Set](https://developer.android.com/reference/java/util/Set)`<`[String](https://developer.android.com/reference/java/lang/String)`>` | ` `[getStringSet](https://developer.android.com/reference/android/preference/PreferenceDataStore#getStringSet(java.lang.String,%20java.util.Set<java.lang.String>))`(`[String](https://developer.android.com/reference/java/lang/String)` key, `[Set](https://developer.android.com/reference/java/util/Set)`<`[String](https://developer.android.com/reference/java/lang/String)`> defValues) ` Retrieve a set of String values from the data store. |
| ` default void`                                                                                                                                 | ` `[putBoolean](https://developer.android.com/reference/android/preference/PreferenceDataStore#putBoolean(java.lang.String,%20boolean))`(`[String](https://developer.android.com/reference/java/lang/String)` key, boolean value) ` Set a boolean value to the data store.                                                                                                                                                                            |
| ` default void`                                                                                                                                 | ` `[putFloat](https://developer.android.com/reference/android/preference/PreferenceDataStore#putFloat(java.lang.String,%20float))`(`[String](https://developer.android.com/reference/java/lang/String)` key, float value) ` Set a float value to the data store.                                                                                                                                                                                      |
| ` default void`                                                                                                                                 | ` `[putInt](https://developer.android.com/reference/android/preference/PreferenceDataStore#putInt(java.lang.String,%20int))`(`[String](https://developer.android.com/reference/java/lang/String)` key, int value) ` Set an int value to the data store.                                                                                                                                                                                               |
| ` default void`                                                                                                                                 | ` `[putLong](https://developer.android.com/reference/android/preference/PreferenceDataStore#putLong(java.lang.String,%20long))`(`[String](https://developer.android.com/reference/java/lang/String)` key, long value) ` Set a long value to the data store.                                                                                                                                                                                           |
| ` default void`                                                                                                                                 | ` `[putString](https://developer.android.com/reference/android/preference/PreferenceDataStore#putString(java.lang.String,%20java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` key, `[String](https://developer.android.com/reference/java/lang/String)` value) ` Set a String value to the data store.                                                                                                         |
| ` default void`                                                                                                                                 | ` `[putStringSet](https://developer.android.com/reference/android/preference/PreferenceDataStore#putStringSet(java.lang.String,%20java.util.Set<java.lang.String>))`(`[String](https://developer.android.com/reference/java/lang/String)` key, `[Set](https://developer.android.com/reference/java/util/Set)`<`[String](https://developer.android.com/reference/java/lang/String)`> values) ` Set a set of String value to the data store.            |

## Public methods

### getBoolean

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public boolean getBoolean (String key, 
                boolean defValue)
```

Retrieve a boolean value from the data store.

<br />

|                                    Parameters                                    ||
|------------|----------------------------------------------------------------------|
| `key`      | `String`: The name of the preference to retrieve. <br />             |
| `defValue` | `boolean`: Value to return if this preference does not exist. <br /> |

|      Returns      ||
|-----------|--------|
| `boolean` | <br /> |

**See also:**

- [getBoolean(String, boolean)](https://developer.android.com/reference/android/preference/PreferenceDataStore#getBoolean(java.lang.String,%20boolean))  

### getFloat

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public float getFloat (String key, 
                float defValue)
```

Retrieve a float value from the data store.

<br />

|                                   Parameters                                   ||
|------------|--------------------------------------------------------------------|
| `key`      | `String`: The name of the preference to retrieve. <br />           |
| `defValue` | `float`: Value to return if this preference does not exist. <br /> |

|     Returns     ||
|---------|--------|
| `float` | <br /> |

**See also:**

- [putFloat(String, float)](https://developer.android.com/reference/android/preference/PreferenceDataStore#putFloat(java.lang.String,%20float))  

### getInt

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public int getInt (String key, 
                int defValue)
```

Retrieve an int value from the data store.

<br />

|                                  Parameters                                  ||
|------------|------------------------------------------------------------------|
| `key`      | `String`: The name of the preference to retrieve. <br />         |
| `defValue` | `int`: Value to return if this preference does not exist. <br /> |

|    Returns    ||
|-------|--------|
| `int` | <br /> |

**See also:**

- [putInt(String, int)](https://developer.android.com/reference/android/preference/PreferenceDataStore#putInt(java.lang.String,%20int))  

### getLong

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long getLong (String key, 
                long defValue)
```

Retrieve a long value from the data store.

<br />

|                                  Parameters                                   ||
|------------|-------------------------------------------------------------------|
| `key`      | `String`: The name of the preference to retrieve. <br />          |
| `defValue` | `long`: Value to return if this preference does not exist. <br /> |

|    Returns     ||
|--------|--------|
| `long` | <br /> |

**See also:**

- [putLong(String, long)](https://developer.android.com/reference/android/preference/PreferenceDataStore#putLong(java.lang.String,%20long))  

### getString

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public String getString (String key, 
                String defValue)
```

Retrieve a String value from the data store.

<br />

|                                                Parameters                                                 ||
|------------|-----------------------------------------------------------------------------------------------|
| `key`      | `String`: The name of the preference to retrieve. <br />                                      |
| `defValue` | `String`: Value to return if this preference does not exist. This value may be `null`. <br /> |

|                                               Returns                                                ||
|--------------------------------------------------------------------|----------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | This value may be `null`. <br /> |

**See also:**

- [putString(String, String)](https://developer.android.com/reference/android/preference/PreferenceDataStore#putString(java.lang.String,%20java.lang.String))  

### getStringSet

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

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

Retrieve a set of String values from the data store.

<br />

|                                                Parameters                                                ||
|-------------|---------------------------------------------------------------------------------------------|
| `key`       | `String`: The name of the preference to retrieve. <br />                                    |
| `defValues` | `Set`: Values to return if this preference does not exist. This value may be `null`. <br /> |

|                                                                                Returns                                                                                 ||
|--------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|
| [Set](https://developer.android.com/reference/java/util/Set)`<`[String](https://developer.android.com/reference/java/lang/String)`>` | This value may be `null`. <br /> |

**See also:**

- [putStringSet(String, Set)](https://developer.android.com/reference/android/preference/PreferenceDataStore#putStringSet(java.lang.String,%20java.util.Set<java.lang.String>))  

### putBoolean

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public void putBoolean (String key, 
                boolean value)
```

Set a boolean value to the data store.

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

<br />

|                           Parameters                            ||
|---------|--------------------------------------------------------|
| `key`   | `String`: The name of the preference to modify. <br /> |
| `value` | `boolean`: The new value for the preference. <br />    |

**See also:**

- [getBoolean(String, boolean)](https://developer.android.com/reference/android/preference/PreferenceDataStore#getBoolean(java.lang.String,%20boolean))  

### putFloat

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public void putFloat (String key, 
                float value)
```

Set a float value to the data store.

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

<br />

|                           Parameters                            ||
|---------|--------------------------------------------------------|
| `key`   | `String`: The name of the preference to modify. <br /> |
| `value` | `float`: The new value for the preference. <br />      |

**See also:**

- [getFloat(String, float)](https://developer.android.com/reference/android/preference/PreferenceDataStore#getFloat(java.lang.String,%20float))  

### putInt

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public void putInt (String key, 
                int value)
```

Set an int value to the data store.

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

<br />

|                           Parameters                            ||
|---------|--------------------------------------------------------|
| `key`   | `String`: The name of the preference to modify. <br /> |
| `value` | `int`: The new value for the preference. <br />        |

**See also:**

- [getInt(String, int)](https://developer.android.com/reference/android/preference/PreferenceDataStore#getInt(java.lang.String,%20int))  

### putLong

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public void putLong (String key, 
                long value)
```

Set a long value to the data store.

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

<br />

|                           Parameters                            ||
|---------|--------------------------------------------------------|
| `key`   | `String`: The name of the preference to modify. <br /> |
| `value` | `long`: The new value for the preference. <br />       |

**See also:**

- [getLong(String, long)](https://developer.android.com/reference/android/preference/PreferenceDataStore#getLong(java.lang.String,%20long))  

### putString

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public void putString (String key, 
                String value)
```

Set a String value to the data store.

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

<br />

|                                      Parameters                                       ||
|---------|------------------------------------------------------------------------------|
| `key`   | `String`: The name of the preference to modify. <br />                       |
| `value` | `String`: The new value for the preference. This value may be `null`. <br /> |

**See also:**

- [getString(String, String)](https://developer.android.com/reference/android/preference/PreferenceDataStore#getString(java.lang.String,%20java.lang.String))  

### putStringSet

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

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

Set a set of String value to the data store.

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

<br />

|                                         Parameters                                          ||
|----------|-----------------------------------------------------------------------------------|
| `key`    | `String`: The name of the preference to modify. <br />                            |
| `values` | `Set`: The set of new values for the preference. This value may be `null`. <br /> |

**See also:**

- [getStringSet(String, Set)](https://developer.android.com/reference/android/preference/PreferenceDataStore#getStringSet(java.lang.String,%20java.util.Set<java.lang.String>))