rx.android.lifecycle

Class LifecycleObservable

java.lang.Object

rx.android.lifecycle.LifecycleObservable

public class LifecycleObservable
extends java.lang.Object

Method Summary

Methods

Modifier and Type	Method and Description
static <T> rx.Observable<T>	bindActivityLifecycle(rx.Observable<LifecycleEvent> lifecycle, rx.Observable<T> source) Binds the given source to an Activity lifecycle.
static <T> rx.Observable<T>	bindFragmentLifecycle(rx.Observable<LifecycleEvent> lifecycle, rx.Observable<T> source) Binds the given source to a Fragment lifecycle.
static <T> rx.Observable<T>	bindUntilLifecycleEvent(rx.Observable<LifecycleEvent> lifecycle, rx.Observable<T> source, LifecycleEvent event) Binds the given source to a lifecycle.

Methods inherited from class java.lang.Object

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

Method Detail

bindUntilLifecycleEvent

public static <T> rx.Observable<T> bindUntilLifecycleEvent(rx.Observable<LifecycleEvent> lifecycle,
                                           rx.Observable<T> source,
                                           LifecycleEvent event)

Binds the given source to a lifecycle.

When the lifecycle event occurs, the source will cease to emit any notifications.

Parameters:

lifecycle - the lifecycle sequence

source - the source sequence

event - the event which should conclude notifications from the source

bindActivityLifecycle

public static <T> rx.Observable<T> bindActivityLifecycle(rx.Observable<LifecycleEvent> lifecycle,
                                         rx.Observable<T> source)

Binds the given source to an Activity lifecycle.

This helper automatically determines (based on the lifecycle sequence itself) when the source should stop emitting items. In the case that the lifecycle sequence is in the creation phase (CREATE, START, etc) it will choose the equivalent destructive phase (DESTROY, STOP, etc). If used in the destructive phase, the notifications will cease at the next event; for example, if used in PAUSE, it will unsubscribe in STOP.

Due to the differences between the Activity and Fragment lifecycles, this method should only be used for an Activity lifecycle.

Parameters:

lifecycle - the lifecycle sequence of an Activity

source - the source sequence

bindFragmentLifecycle

public static <T> rx.Observable<T> bindFragmentLifecycle(rx.Observable<LifecycleEvent> lifecycle,
                                         rx.Observable<T> source)

Binds the given source to a Fragment lifecycle.

This helper automatically determines (based on the lifecycle sequence itself) when the source should stop emitting items. In the case that the lifecycle sequence is in the creation phase (CREATE, START, etc) it will choose the equivalent destructive phase (DESTROY, STOP, etc). If used in the destructive phase, the notifications will cease at the next event; for example, if used in PAUSE, it will unsubscribe in STOP.

Due to the differences between the Activity and Fragment lifecycles, this method should only be used for a Fragment lifecycle.

Parameters:

lifecycle - the lifecycle sequence of a Fragment

source - the source sequence