io.reactivex.observers

Class SerializedObserver

java.lang.Object

io.reactivex.observers.SerializedObserver

Type Parameters:

T - the value type

All Implemented Interfaces:

Disposable, Observer

public final class SerializedObserver
extends Object
implements Observer, Disposable

Serializes access to the onNext, onError and onComplete methods of another Observer.

Note that onSubscribe(Disposable) is not serialized in respect of the other methods so make sure the onSubscribe() is called with a non-null Disposable before any of the other methods are called.

The implementation assumes that the actual Observer's methods don't throw.

Constructor Summary

Constructors

Constructor and Description
SerializedObserver(ObserverT> downstream) Construct a SerializedObserver by wrapping the given actual Observer.
SerializedObserver(ObserverT> actual, boolean delayError) Construct a SerializedObserver by wrapping the given actual Observer and optionally delaying the errors till all regular values have been emitted from the internal buffer.

Method Summary

Modifier and Type	Method and Description
void	dispose() Dispose the resource, the operation should be idempotent.
boolean	isDisposed() Returns true if this resource has been disposed.
void	onComplete() Notifies the Observer that the Observable has finished sending push-based notifications.
void	onError(Throwable t) Notifies the Observer that the Observable has experienced an error condition.
void	onNext(T t) Provides the Observer with a new item to observe.
void	onSubscribe(Disposable d) Provides the Observer with the means of cancelling (disposing) the connection (channel) with the Observable in both synchronous (from within Observer.onNext(Object)) and asynchronous manner.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerializedObserver

public SerializedObserver(@NonNull
                          ObserverT> downstream)

Construct a SerializedObserver by wrapping the given actual Observer.

Parameters:

downstream - the actual Observer, not null (not verified)

SerializedObserver

public SerializedObserver(@NonNull
                          ObserverT> actual,
                          boolean delayError)

Construct a SerializedObserver by wrapping the given actual Observer and optionally delaying the errors till all regular values have been emitted from the internal buffer.

Parameters:

actual - the actual Observer, not null (not verified)

delayError - if true, errors are emitted after regular values have been emitted

Method Detail

onSubscribe

public void onSubscribe(@NonNull
                        Disposable d)

Description copied from interface: Observer

Provides the Observer with the means of cancelling (disposing) the connection (channel) with the Observable in both synchronous (from within Observer.onNext(Object)) and asynchronous manner.

Specified by:

onSubscribe in interface Observer<T>

Parameters:

d - the Disposable instance whose Disposable.dispose() can be called anytime to cancel the connection

dispose

public void dispose()

Description copied from interface: Disposable

Dispose the resource, the operation should be idempotent.

Specified by:

dispose in interface Disposable

isDisposed

public boolean isDisposed()

Description copied from interface: Disposable

Returns true if this resource has been disposed.

Specified by:

isDisposed in interface Disposable

Returns:

true if this resource has been disposed

onNext

public void onNext(@NonNull
                   T t)

Description copied from interface: Observer

Provides the Observer with a new item to observe.

The Observable may call this method 0 or more times.

The Observable will not call this method again after it calls either Observer.onComplete() or Observer.onError(java.lang.Throwable).

Specified by:

onNext in interface Observer<T>

Parameters:

t - the item emitted by the Observable

onError

public void onError(@NonNull
                    Throwable t)

Description copied from interface: Observer

Notifies the Observer that the Observable has experienced an error condition.

If the Observable calls this method, it will not thereafter call Observer.onNext(T) or Observer.onComplete().

Specified by:

onError in interface Observer<T>

Parameters:

t - the exception encountered by the Observable

onComplete

public void onComplete()

Description copied from interface: Observer

Notifies the Observer that the Observable has finished sending push-based notifications.

The Observable will not call this method if it calls Observer.onError(java.lang.Throwable).

Specified by:

onComplete in interface Observer<T>