Rx Preferences

Additional

Language
Java
Version
2.0.0-RC1 (Dec 25, 2016)
Created
Dec 16, 2014
Updated
May 24, 2023
Owner
Prateek Srivastava (f2prateek)
Contributors
Egor Neliuba (egor-n)
Prateek Srivastava (f2prateek)
Ray Ryan (rjrjr)
Michael Evans (MichaelEvans)
Brais Gabín (BraisGabin)
Sven Bendel (ubuntudroid)
Jake Wharton (JakeWharton)
Eric Cochran (NightlyNexus)
Paul Woitaschek (PaulWoitaschek)
Andrew (bemusementpark)
Rafał Gurzkowski (r-gurzkowski)
Rafał Naniewicz (freszu)
Andrew Reitz (AndrewReitz)
Denis Nek (nekdenis)
Dmitrii Makarov (m4xp1)
Richard Banasiak (banasiak)
16
Activity
Badge
Generate
Download
Source code

DEPRECATED

rx-preferences is deprecated. Please consider using a replacement, such as this. Thank you for using the library!

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);

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);

Observe changes to individual preferences:

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

Subscribe preferences to streams to store values:

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

(Note: RxCompoundButton is from RxBinding)

Download

implementation 'com.f2prateek.rx.preferences2:rx-preferences:2.0.1'

License

Copyright 2014 Prateek Srivastava

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.