GuavaDataStore.Builder

public <T extends Object> Builder(
    @NonNull Context context,
    @NonNull String fileName,
    @NonNull Serializer<@NonNull T> serializer
)

Create a GuavaDataStoreBuilder with the Context and name from which to derive the DataStore file. The file is generated by File(this.filesDir, "datastore/$fileName"). The user is responsible for ensuring that there is never more than one DataStore acting on a file at a time.

Either produceFile or context & name must be set, but not both. This is enforced by the two constructors.

public final @NonNull GuavaDataStore.Builder<@NonNull T> addDataMigration(@NonNull DataMigration<@NonNull T> dataMigration)

Add a DataMigration to the Datastore. Migrations are run in the order they are added.

public final @NonNull GuavaDataStore<@NonNull T> build()

Build the DataStore.

public final @NonNull GuavaDataStore.Builder<@NonNull T> enableMultiProcess()

Flag used to signal the creation of a multi-process DataStore using a MultiProcessCoordinator.

By default, the builder sets up a DataStore intended for single-application use. It prioritizes speed and is created using DataStoreFactory. However, if you anticipate any scenario where different parts of your system (even if they are just reading data) might access the DataStore at the same time from separate processes, the enableMultiProcess flag must be set to true. This ensures a MultiProcessDataStoreFactory is used, providing the necessary safeguards for concurrent access across multiple processes.

public final @NonNull GuavaDataStore.Builder<@NonNull T> setCorruptionHandler(
    @NonNull ReplaceFileCorruptionHandler<@NonNull T> corruptionHandler
)

Sets the corruption handler to install into the DataStore.

This parameter is optional and defaults to no corruption handler.

public final @NonNull GuavaDataStore.Builder<@NonNull T> setExecutor(@NonNull Executor executor)

Sets the Executor used by the DataStore.

This parameter is optional and defaults to Dispatchers.IO.