rxpreferences-dagger

A Dagger component for RxPreferences.

License	The Apache Software License, Version 2.0
Categories	Dagger Application Layer Libs Dependency Injection
GroupId	dev.drewhamilton.rxpreferences
ArtifactId	rxpreferences-dagger
Last Version	3.0.0
Release Date	Mar 21, 2020
Type	aar
Description	rxpreferences-dagger A Dagger component for RxPreferences.
Project URL	https://github.com/drewhamilton/RxPreferences
Source Code Management	https://github.com/drewhamilton/RxPreferences

Download rxpreferences-dagger

Filename	Size
rxpreferences-dagger-3.0.0.pom
rxpreferences-dagger-3.0.0.aar	5 KB
rxpreferences-dagger-3.0.0-sources.jar	1 KB
rxpreferences-dagger-3.0.0-javadoc.jar	24 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/dev.drewhamilton.rxpreferences/rxpreferences-dagger/ -->
<dependency>
    <groupId>dev.drewhamilton.rxpreferences</groupId>
    <artifactId>rxpreferences-dagger</artifactId>
    <version>3.0.0</version>
    <type>aar</type>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/dev.drewhamilton.rxpreferences/rxpreferences-dagger/
implementation 'dev.drewhamilton.rxpreferences:rxpreferences-dagger:3.0.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/dev.drewhamilton.rxpreferences/rxpreferences-dagger/
implementation ("dev.drewhamilton.rxpreferences:rxpreferences-dagger:3.0.0")

Apache Buildr

'dev.drewhamilton.rxpreferences:rxpreferences-dagger:aar:3.0.0'

Apache Ivy

<dependency org="dev.drewhamilton.rxpreferences" name="rxpreferences-dagger" rev="3.0.0">
  <artifact name="rxpreferences-dagger" type="aar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='dev.drewhamilton.rxpreferences', module='rxpreferences-dagger', version='3.0.0')
)

Scala SBT

libraryDependencies += "dev.drewhamilton.rxpreferences" % "rxpreferences-dagger" % "3.0.0"

Leiningen

[dev.drewhamilton.rxpreferences/rxpreferences-dagger "3.0.0"]

Dependencies

compile (1)

Group / Artifact	Type	Version
dev.drewhamilton.rxpreferences : rxpreferences	aar	3.0.0

runtime (2)

Group / Artifact	Type	Version
org.jetbrains.kotlin : kotlin-stdlib-jdk8	jar	1.3.61
com.google.dagger : dagger	jar	2.26

Project Modules

There are no modules declared in this project.

RxPreferences

An RxJava wrapper for Android's SharedPreferences.

Download

RxPreferences is available in Maven Central.

// RxPreferences:
implementation "dev.drewhamilton.rxpreferences:rxpreferences:$version"
// With Kotlin extensions:
implementation "dev.drewhamilton.rxpreferences:rxpreferences-ktx:$version"
// Dagger component:
implementation "dev.drewhamilton.rxpreferences:rxpreferences-dagger:$version"

Usage

RxPreferences

Get the current value of any preference:

rxPreferences.getIntOnce("Language count", 0)
        .subscribeOn(Schedulers.io())
        .observeOn(AndroidSchedulers.mainThread())
        .subscribe(count -> displayCount(count));

Observe the initial value plus any changes to a preference:

rxPreferences.getStringStream("Favorite language", "None")
        .subscribeOn(Schedulers.io())
        .observeOn(AndroidSchedulers.mainThread())
        .subscribe(name -> displayBestFriend(name));

Edit preferences and monitor the completion of committing those changes:

rxPreferences.edit()
        .putInt("Language count", 1)
        .putString("Favorite language", "Java")
        .commit()
        .subscribeOn(Schedulers.io())
        .observeOn(AndroidSchedulers.mainThread())
        .subscribe(() -> showSavedIndicator(), error -> displayError(error));

Kotlin extensions

With Kotlin extensions, use the Editor as a receiver:

rxPreferences.edit {
    putInt("Language count", 2)
    putString("Favorite language", "Kotlin")
}.subscribeOn(Schedulers.io())
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe({ showSavedIndicator() }, { error -> displayError(error) })

Dagger component

Easily provide and access RxPreferences instances using RxPreferencesComponent:

@Module
object PersistenceModule {

    private const val sharedPreferencesName = "example.SharedPreferences"

    private val ExampleApplication.sharedPreferences
        get() = getSharedPreferences(sharedPreferencesName, Context.MODE_PRIVATE)

    @JvmStatic
    @Provides
    fun preferencesComponent(application: ExampleApplication) =
        RxPreferencesComponent.create(application.sharedPreferences)

    @JvmStatic
    @Provides
    @Reusable
    fun preferences(preferencesComponent: RxPreferencesComponent) =
        preferencesComponent.rxPreferences()
}

License

Copyright 2018 Drew Hamilton

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
3.0.0 Mar 21, 2020
3.0.0-beta01 Feb 23, 2020