com.trello.rxlifecycle3

Class RxLifecycle

java.lang.Object

com.trello.rxlifecycle3.RxLifecycle

public class RxLifecycle
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static <T,R> LifecycleTransformer<T>	bind(io.reactivex.Observable<R> lifecycle) Binds the given source to a lifecycle.
static <T,R> LifecycleTransformer<T>	bind(io.reactivex.Observable<R> lifecycle, io.reactivex.functions.Function<R,R> correspondingEvents) Binds the given source to a lifecycle.
static <T,R> LifecycleTransformer<T>	bindUntilEvent(io.reactivex.Observable<R> lifecycle, R 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

bindUntilEvent

@Nonnull
 @CheckReturnValue
public static <T,R> LifecycleTransformer<T> bindUntilEvent(@Nonnull
                                                                                       io.reactivex.Observable<R> lifecycle,
                                                                                       @Nonnull
                                                                                       R 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

event - the event which should conclude notifications from the source

Returns:

a reusable LifecycleTransformer that unsubscribes the source at the specified event

bind

@Nonnull
 @CheckReturnValue
public static <T,R> LifecycleTransformer<T> bind(@Nonnull
                                                                             io.reactivex.Observable<R> lifecycle)

Binds the given source to a lifecycle.

This helper automatically determines (based on the lifecycle sequence itself) when the source should stop emitting items. Note that for this method, it assumes any event emitted by the given lifecycle indicates that the lifecycle is over.

Parameters:

lifecycle - the lifecycle sequence

Returns:

a reusable LifecycleTransformer that unsubscribes the source whenever the lifecycle emits

bind

@Nonnull
 @CheckReturnValue
public static <T,R> LifecycleTransformer<T> bind(@Nonnull
                                                                             io.reactivex.Observable<R> lifecycle,
                                                                             @Nonnull
                                                                             io.reactivex.functions.Function<R,R> correspondingEvents)

Binds the given source to a lifecycle.

This method determines (based on the lifecycle sequence itself) when the source should stop emitting items. It uses the provided correspondingEvents function to determine when to unsubscribe.

Note that this is an advanced usage of the library and should generally be used only if you really know what you're doing with a given lifecycle.

Parameters:

lifecycle - the lifecycle sequence

correspondingEvents - a function which tells the source when to unsubscribe

Returns:

a reusable LifecycleTransformer that unsubscribes the source during the Fragment lifecycle