Git Product home page Git Product logo

rxcursorloader's Introduction

Description

An RX replacement for android.content.CursorLoader

Min API level 9

Setup

Maven Central

For RxJava 2

compile 'com.github.doctoror.rxcursorloader:library:[version]'

If you need RxJava 1, you can use the old version

compile 'com.github.doctoror.rxcursorloader:library:1.1.5'

Usage

Create a Query using Query.Builder. The required parameter is only a content URI.

final RxCursorLoader.Query query = new RxCursorLoader.Query.Builder()
        .setContentUri(MediaStore.Audio.Media.INTERNAL_CONTENT_URI)
        .setProjection(new String[]{MediaStore.Audio.Media._ID})
        .setSortOrder(MediaStore.Audio.Artists.ARTIST)
        .setSelection(MediaStore.Audio.Artists.ARTIST + "=?")
        .setSelectionArgs(new String[] {"Oh Long Johnson"})
        .create();

Thare are two cases covered by this library.

  1. You want to load the Cursor once
RxCursorLoader.single(getContentResolver(), query)
    .subscribeOn(Schedulers.io())
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe(this::handleAndCloseCursor);
  1. You want to reload a Cursor every time the content under URI changes, just like CursorLoader does. Note that unlike CursorLoader, this does not close the Cursor for you, so make sure to close old cursor once onNext() is called.
mCursorDisposable = RxCursorLoader
    .flowable(getContentResolver(), params, Schedulers.io(), BackpressureStrategy.LATEST)
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe(c -> mCursorAdapter.changeCursor(c));

You must call Disposable.dispose() when finished so that the library unregisters the ContentObserver

@Override
protected void onStop() {
    super.onStop();
    // stop using Cursor
    mAdapter.changeCursor(null);
    
    // Unsubscribe to close the Cursor and stop monitoring for ContentObserver changes
    mCursorDisposable.dispose();
}

If ContentResolver query returns null, onError() will be called with QueryReturnedNullException

License

Copyright 2016 Yaroslav Mytkalyk

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.

rxcursorloader's People

Contributors

doctoror avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.