rx.observers

Class Subscribers

java.lang.Object

rx.observers.Subscribers

public final class Subscribers
extends java.lang.Object

Helper methods and utilities for creating and working with Subscriber objects.

Method Summary

Methods

Modifier and Type	Method and Description
static <T> Subscriber<T>	create(Action1<? super T> onNext) Creates a Subscriber that receives the emissions of any Observable it subscribes to via onNext but ignores onError and onCompleted notifications.
static <T> Subscriber<T>	create(Action1<? super T> onNext, Action1<java.lang.Throwable> onError) Creates an Subscriber that receives the emissions of any Observable it subscribes to via onNext and handles any onError notification but ignores an onCompleted notification.
static <T> Subscriber<T>	create(Action1<? super T> onNext, Action1<java.lang.Throwable> onError, Action0 onComplete) Creates an Subscriber that receives the emissions of any Observable it subscribes to via onNext and handles any onError or onCompleted notifications.
static <T> Subscriber<T>	empty() Returns an inert Subscriber that does nothing in response to the emissions or notifications from any Observable it subscribes to.
static <T> Subscriber<T>	from(Observer<? super T> o) Converts an Observer into a Subscriber.
static <T> Subscriber<T>	wrap(Subscriber<? super T> subscriber) Returns a new Subscriber that passes all events to subscriber, has backpressure controlled by subscriber and uses the subscription list of subscriber when Subscriber.add(rx.Subscription) is called.

Methods inherited from class java.lang.Object

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

Method Detail

empty

public static <T> Subscriber<T> empty()

Returns an inert Subscriber that does nothing in response to the emissions or notifications from any Observable it subscribes to. This is different, however, from an EmptyObserver, in that it will throw an exception if its onError method is called (whereas EmptyObserver will swallow the error in such a case).

Returns:

an inert Observer

from

public static <T> Subscriber<T> from(Observer<? super T> o)

Converts an Observer into a Subscriber.

Parameters:

o - the Observer to convert

Returns:

a Subscriber version of o

create

public static final <T> Subscriber<T> create(Action1<? super T> onNext)

Creates a Subscriber that receives the emissions of any Observable it subscribes to via onNext but ignores onError and onCompleted notifications.

Parameters:

onNext - a function that handles each item emitted by an Observable

Returns:

a Subscriber that calls onNext for each emitted item from the Observable the Subscriber subscribes to

Throws:

IllegalArgument - Exception if onNext is null

create

public static final <T> Subscriber<T> create(Action1<? super T> onNext,
                       Action1<java.lang.Throwable> onError)

Creates an Subscriber that receives the emissions of any Observable it subscribes to via onNext and handles any onError notification but ignores an onCompleted notification.

Parameters:

onNext - a function that handles each item emitted by an Observable

onError - a function that handles an error notification if one is sent by an Observable

Returns:

an Subscriber that calls onNext for each emitted item from the Observable the Subscriber subscribes to, and calls onError if the Observable notifies of an error

Throws:

IllegalArgument - Exception if either onNext or onError are null

create

public static final <T> Subscriber<T> create(Action1<? super T> onNext,
                       Action1<java.lang.Throwable> onError,
                       Action0 onComplete)

Creates an Subscriber that receives the emissions of any Observable it subscribes to via onNext and handles any onError or onCompleted notifications.

Parameters:

onNext - a function that handles each item emitted by an Observable

onError - a function that handles an error notification if one is sent by an Observable

onComplete - a function that handles a sequence complete notification if one is sent by an Observable

Returns:

an Subscriber that calls onNext for each emitted item from the Observable the Subscriber subscribes to, calls onError if the Observable notifies of an error, and calls onComplete if the Observable notifies that the observable sequence is complete

Throws:

IllegalArgument - Exception if either onNext, onError, or onComplete are null

wrap

@Experimental
public static <T> Subscriber<T> wrap(Subscriber<? super T> subscriber)

Returns a new Subscriber that passes all events to subscriber, has backpressure controlled by subscriber and uses the subscription list of subscriber when Subscriber.add(rx.Subscription) is called.

Parameters:

subscriber - the Subscriber to wrap.

Returns:

a new Subscriber that passes all events to subscriber, has backpressure controlled by subscriber and uses subscriber to manage unsubscription.

Since:

(if this graduates from Experimental/Beta to supported, replace this parenthetical with the release number)