RxSharedPreferencesMigration
public interface RxSharedPreferencesMigration<T extends Object>
Client implemented migration interface.
Summary
Public methods |
|
|---|---|
abstract @NonNull Single<@NonNull T> |
migrate(Maps SharedPreferences into T. |
default @NonNull Single<@NonNull Boolean> |
shouldMigrate(@NonNull T currentData)Whether or not the migration should be run. |
Public methods
migrate
abstract @NonNull Single<@NonNull T> migrate(
@NonNull <Error class: unknown class> sharedPreferencesView,
@NonNull T currentData
)
Maps SharedPreferences into T. Implementations should be idempotent since this may be called multiple times. See DataMigration.migrate for more information. The method accepts a SharedPreferencesView which is the view of the SharedPreferences to migrate from (limited to keysToMigrate) and a T which represent the current data. The function must return the migrated data.
If SharedPreferences is empty or does not contain any keys which you specified, this callback will not run.
| Parameters | |
|---|---|
@NonNull <Error class: unknown class> sharedPreferencesView |
the current state of the SharedPreferences |
@NonNull T currentData |
the most recently persisted data |