DataStore.Builder

Kotlin |Java

public final class DataStore.Builder<T extends Object>

Builder for DataStore.

Summary

Public constructors
`<T extends Object> Builder( @NonNull Storage<@NonNull T> storage, @NonNull CoroutineContext context )`

Public methods
`final @NonNull DataStore.Builder<@NonNull T>`	`addMigrations(@NonNull List<@NonNull DataMigration<@NonNull T>> migrations)` Adds `DataMigration`s to the DataStore.
`final @NonNull DataStore<@NonNull T>`	`build()` Validates the configuration and builds the `Builder` instance.
`final @NonNull DataStore.Builder<@NonNull T>`	`setCorruptionHandler(@NonNull CorruptionHandler<@NonNull T> handler)` Sets the `CorruptionHandler` for the DataStore.
`final @NonNull DataStore.Builder<@NonNull T>`	`setTracer(@NonNull Tracer tracer)` Sets the `Tracer` for Android.

public <T extends Object> Builder(
    @NonNull Storage<@NonNull T> storage,
    @NonNull CoroutineContext context
)

public final @NonNull DataStore.Builder<@NonNull T> addMigrations(@NonNull List<@NonNull DataMigration<@NonNull T>> migrations)

Adds DataMigrations to the DataStore.

Migrations are run in the order they are added before any data is returned to the user.

Parameters
`@NonNull List<@NonNull DataMigration<@NonNull T>> migrations`	the list of migrations.

Returns
`@NonNull DataStore.Builder<@NonNull T>`	this `Builder` instance.

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

Validates the configuration and builds the Builder instance.

Returns
`@NonNull DataStore<@NonNull T>`	a new DataStore instance.

public final @NonNull DataStore.Builder<@NonNull T> setCorruptionHandler(@NonNull CorruptionHandler<@NonNull T> handler)

Sets the CorruptionHandler for the DataStore.

This handler is invoked if the Storage layer throws a CorruptionException. Defaults to ReThrowCorruptionHandler.

Parameters
`@NonNull CorruptionHandler<@NonNull T> handler`	the corruption handler.

Returns
`@NonNull DataStore.Builder<@NonNull T>`	this `Builder` instance.

public final @NonNull DataStore.Builder<@NonNull T> setTracer(@NonNull Tracer tracer)

Sets the Tracer for Android.

Parameters
`@NonNull Tracer tracer`	The `Tracer` to use.

Returns
`@NonNull DataStore.Builder<@NonNull T>`	this `Builder` instance.