public abstract class

DisposableObserver

extends Object
implements Observer<T> Disposable
java.lang.Object
   ↳ io.reactivex.observers.DisposableObserver<T>

Class Overview

An abstract Observer that allows asynchronous cancellation by implementing Disposable.

All pre-implemented final methods are thread-safe.

Use the public dispose() method to dispose the sequence from within an onNext implementation.

Like all other consumers, DisposableObserver can be subscribed only once. Any subsequent attempt to subscribe it to a new source will yield an IllegalStateException with message "It is not allowed to subscribe with a(n) <class name> multiple times.".

Implementation of onStart(), onNext(Object), onError(Throwable) and onComplete() are not allowed to throw any unchecked exceptions. If for some reason this can't be avoided, use safeSubscribe(io.reactivex.Observer) instead of the standard subscribe() method.

Example


 Disposable d =
     Observable.range(1, 5)
     .subscribeWith(new DisposableObserver<Integer>() {
         @Override public void onStart() {
             System.out.println("Start!");
         }
         @Override public void onNext(Integer t) {
             if (t == 3) {
                 dispose();
             }
             System.out.println(t);
         }
         @Override public void onError(Throwable t) {
             t.printStackTrace();
         }
         @Override public void onComplete() {
             System.out.println("Done!");
         }
     });
 // ...
 d.dispose();
 

Summary

Public Constructors
DisposableObserver()
Public Methods
final void dispose()
Dispose the resource, the operation should be idempotent.
final boolean isDisposed()
Returns true if this resource has been disposed.
final void onSubscribe(Disposable s)
Provides the Observer with the means of cancelling (disposing) the connection (channel) with the Observable in both synchronous (from within onNext(Object)) and asynchronous manner.
Protected Methods
void onStart()
Called once the single upstream Disposable is set via onSubscribe.
[Expand]
Inherited Methods
From class java.lang.Object
From interface io.reactivex.Observer
From interface io.reactivex.disposables.Disposable

Public Constructors

public DisposableObserver ()

Public Methods

public final void dispose ()

Dispose the resource, the operation should be idempotent.

public final boolean isDisposed ()

Returns true if this resource has been disposed.

Returns
  • true if this resource has been disposed

public final void onSubscribe (Disposable s)

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

Parameters
s the Disposable instance whose dispose() can be called anytime to cancel the connection

Protected Methods

protected void onStart ()

Called once the single upstream Disposable is set via onSubscribe.