RxPreferences

Reactive SharedPreferences for Android

License	The Apache Software License, Version 2.0
GroupId	com.f2prateek.rx.preferences
ArtifactId	rx-preferences
Last Version	1.0.2
Release Date	Jun 14, 2016
Type	aar
Description	RxPreferences Reactive SharedPreferences for Android
Project URL	https://github.com/f2prateek/rx-preferences
Source Code Management	https://github.com/f2prateek/rx-preferences

Download rx-preferences

Filename	Size
rx-preferences-1.0.2.pom
rx-preferences-1.0.2.aar	19 KB
rx-preferences-1.0.2-sources.jar	8 KB
rx-preferences-1.0.2-javadoc.jar	26 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.f2prateek.rx.preferences/rx-preferences/ -->
<dependency>
    <groupId>com.f2prateek.rx.preferences</groupId>
    <artifactId>rx-preferences</artifactId>
    <version>1.0.2</version>
    <type>aar</type>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.f2prateek.rx.preferences/rx-preferences/
implementation 'com.f2prateek.rx.preferences:rx-preferences:1.0.2'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.f2prateek.rx.preferences/rx-preferences/
implementation ("com.f2prateek.rx.preferences:rx-preferences:1.0.2")

Apache Buildr

'com.f2prateek.rx.preferences:rx-preferences:aar:1.0.2'

Apache Ivy

<dependency org="com.f2prateek.rx.preferences" name="rx-preferences" rev="1.0.2">
  <artifact name="rx-preferences" type="aar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.f2prateek.rx.preferences', module='rx-preferences', version='1.0.2')
)

Scala SBT

libraryDependencies += "com.f2prateek.rx.preferences" % "rx-preferences" % "1.0.2"

Leiningen

[com.f2prateek.rx.preferences/rx-preferences "1.0.2"]

Dependencies

compile (2)

Group / Artifact	Type	Version
io.reactivex : rxjava	jar	1.1.0
com.android.support » support-annotations	jar	23.1.1

Project Modules

There are no modules declared in this project.

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.

Versions

Version
1.0.2 Jun 14, 2016
1.0.1 Oct 28, 2015
1.0.0 Aug 23, 2015