com.trello.lifecycle2.android.lifecycle

Class AndroidLifecycle

java.lang.Object

com.trello.lifecycle2.android.lifecycle.AndroidLifecycle

All Implemented Interfaces:

android.arch.lifecycle.LifecycleObserver, com.trello.rxlifecycle2.LifecycleProvider<android.arch.lifecycle.Lifecycle.Event>

public final class AndroidLifecycle
extends Object
implements com.trello.rxlifecycle2.LifecycleProvider<android.arch.lifecycle.Lifecycle.Event>, android.arch.lifecycle.LifecycleObserver

Wraps a LifecycleOwner so that it can be used as a LifecycleProvider. For example, you can do

 LifecycleProvider<Lifecycle.Event> provider = AndroidLifecycle.createLifecycleProvider(this);
 myObservable
     .compose(provider.bindLifecycle())
     .subscribe();
 

where this is a android.arch.lifecycle.LifecycleActivity or android.arch.lifecycle.LifecycleFragment.

Method Summary

Modifier and Type	Method and Description
<T> com.trello.rxlifecycle2.LifecycleTransformer<T>	bindToLifecycle()
<T> com.trello.rxlifecycle2.LifecycleTransformer<T>	bindUntilEvent(android.arch.lifecycle.Lifecycle.Event event)
static com.trello.rxlifecycle2.LifecycleProvider<android.arch.lifecycle.Lifecycle.Event>	createLifecycleProvider(android.arch.lifecycle.LifecycleOwner owner)
Observable<android.arch.lifecycle.Lifecycle.Event>	lifecycle()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createLifecycleProvider

public static com.trello.rxlifecycle2.LifecycleProvider<android.arch.lifecycle.Lifecycle.Event> createLifecycleProvider(android.arch.lifecycle.LifecycleOwner owner)

lifecycle

@NonNull
 @CheckResult
public Observable<android.arch.lifecycle.Lifecycle.Event> lifecycle()

Specified by:

lifecycle in interface com.trello.rxlifecycle2.LifecycleProvider<android.arch.lifecycle.Lifecycle.Event>

bindUntilEvent

@NonNull
 @CheckResult
public <T> com.trello.rxlifecycle2.LifecycleTransformer<T> bindUntilEvent(@NonNull
                                                                                                 android.arch.lifecycle.Lifecycle.Event event)

Specified by:

bindUntilEvent in interface com.trello.rxlifecycle2.LifecycleProvider<android.arch.lifecycle.Lifecycle.Event>

bindToLifecycle

@NonNull
 @CheckResult
public <T> com.trello.rxlifecycle2.LifecycleTransformer<T> bindToLifecycle()

Specified by:

bindToLifecycle in interface com.trello.rxlifecycle2.LifecycleProvider<android.arch.lifecycle.Lifecycle.Event>