PreferencesFactory

Added in 1.0.0

---

Kotlin |Java

public final class PreferencesFactory

---

Summary

Public methods
static final @NonNull Preferences	create(@NonNull Preferences.Pair<@NonNull ?> pairs) Construct a Preferences object with a list of Preferences.Pair.
static final @NonNull Preferences	createEmpty() Get a new empty Preferences.
static final @NonNull MutablePreferences	createMutable(@NonNull Preferences.Pair<@NonNull ?> pairs) Construct a MutablePreferences object with a list of Preferences.Pair.

Public methods

create

Artifact: androidx.datastore:datastore-preferences-core

View Source

Added in 1.0.0

public static final @NonNull Preferences create(@NonNull Preferences.Pair<@NonNull ?> pairs)

Construct a Preferences object with a list of Preferences.Pair. Comparable to mapOf().

Example usage:

val counterKey = intPreferencesKey("counter")
val preferences = preferencesOf(counterKey to 100)

Parameters
@NonNull Preferences.Pair<@NonNull ?> pairs	the key value pairs with which to construct the preferences

createEmpty

Artifact: androidx.datastore:datastore-preferences-core

View Source

Added in 1.0.0

public static final @NonNull Preferences createEmpty()

Get a new empty Preferences.

Returns
@NonNull Preferences	a new Preferences instance with no preferences set

createMutable

Artifact: androidx.datastore:datastore-preferences-core

View Source

Added in 1.0.0

public static final @NonNull MutablePreferences createMutable(@NonNull Preferences.Pair<@NonNull ?> pairs)

Construct a MutablePreferences object with a list of Preferences.Pair. Comparable to mapOf().

Example usage:

val counterKey = intPreferencesKey("counter")
val preferences = mutablePreferencesOf(counterKey to 100)

Parameters
@NonNull Preferences.Pair<@NonNull ?> pairs	the key value pairs with which to construct the preferences