Package rx.observers

Class Observers

java.lang.Object

rx.observers.Observers

public final class Observers
extends Object

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

Field Summary

Fields

Modifier and Type	Field	Description
private static final Observer<Object>	EMPTY

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Observers()

Method Summary

Modifier and Type	Method	Description
static <T> Observer<T>	create(Action1<? super T> onNext)	Creates an Observer that receives the emissions of any Observable it subscribes to via onNext but ignores onCompleted notifications; it will throw an OnErrorNotImplementedException if onError is invoked.
static <T> Observer<T>	create(Action1<? super T> onNext, Action1<Throwable> onError)	Creates an Observer that receives the emissions of any Observable it subscribes to via onNext and handles any onError notification but ignores an onCompleted notification.
static <T> Observer<T>	create(Action1<? super T> onNext, Action1<Throwable> onError, Action0 onComplete)	Creates an Observer that receives the emissions of any Observable it subscribes to via onNext and handles any onError or onCompleted notifications.
static <T> Observer<T>	empty()	Returns an inert Observer that does nothing in response to the emissions or notifications from any Observable it subscribes to but will throw an exception if its onError method is called.

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

private static final Observer<Object> EMPTY

Constructor Details

Observers

private Observers()

Method Details

empty

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

Returns an inert Observer that does nothing in response to the emissions or notifications from any Observable it subscribes to but will throw an exception if its onError method is called.

Type Parameters:

T - the observed value type

Returns:

an inert Observer

create

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

Creates an Observer that receives the emissions of any Observable it subscribes to via onNext but ignores onCompleted notifications; it will throw an OnErrorNotImplementedException if onError is invoked.

Type Parameters:

T - the observed value type

Parameters:

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

Returns:

an Observer that calls onNext for each emitted item from the Observable the Observer subscribes to

Throws:

IllegalArgumentException - if onNext is null

create

public static <T> Observer<T> create(Action1<? super T> onNext,
 Action1<Throwable> onError)

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

Type Parameters:

T - the observed value type

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 Observer that calls onNext for each emitted item from the Observable the Observer subscribes to, and calls onError if the Observable notifies of an error

Throws:

IllegalArgumentException - if either onNext or onError are null

create

public static <T> Observer<T> create(Action1<? super T> onNext,
 Action1<Throwable> onError,
 Action0 onComplete)

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

Type Parameters:

T - the observed value type

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 Observer that calls onNext for each emitted item from the Observable the Observer 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:

IllegalArgumentException - if either onNext, onError, or onComplete are null