desiderantes / rx-preferences

Reactive SharedPreferences for Android

Rx Preferences

Reactive SharedPreferences for Android.

Usage

Create an RxSharedPreferences instance which wraps a SharedPreferences:

SharedPreferences preferences = PreferenceManager.getDefaultSharedPreferences(context);
RxSharedPreferences rxPreferences = RxSharedPreferences.create(preferences);

val preferences = PreferenceManager.getDefaultSharedPreferences(context)
val rxpreferences = RxSharedPreferences.create(preferences)

Hint: Keep a strong reference on your RxSharedPreferences instance for as long as you want to observe them to prevent listeners from being GCed.

Create individual Preference objects:

Preference<String> username = rxPreferences.getString("username");
Preference<Boolean> showWhatsNew = rxPreferences.getBoolean("show-whats-new", true);

val username = rxPreferences.getString("username")
val shoWhatsNew = rxPreferences.getBoolean("show-whats-new", true)

Observe changes to individual preferences:

username.asObservable().subscribe(new Action1<String>() {
  @Override public void call(String username) {
    Log.d(TAG, "Username: " + username);
  }
}

username.asObservable.subscribe { usernameStr ->
    Log.d(TAG, "Username: $usernameStr")
}

Subscribe preferences to streams to store values:

RxCompoundButton.checks(showWhatsNewView)
    .subscribe(showWhatsNew.asConsumer());

(Note: RxCompoundButton is from RxBinding)

Test your preferences with Memory Storage:

Preference<String> stringPref = InMemoryPreference.getStringPreference("string-pref");
stringPref.setSync("New Value");

assertThat(stringPref.isSet()).isTrue();

Download

implementation 'com.desiderantes.rx.preferences3:rx-preferences:3.0.0-SNAPSHOT'

implementation("com.desiderantes.rx.preferences3:rx-preferences:3.0.0-SNAPSHOT")

The package is available in the Package registry from this Github repository

License

Copyright 2014 Prateek Srivastava
          2021 - Mario Daniel Ruiz Saavedra

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.