ResourceSingleObserver

Class Overview

An abstract SingleObserver that allows asynchronous cancellation of its subscription and the associated resources.

All pre-implemented final methods are thread-safe.

Override the protected onStart() to perform initialization when this ResourceSingleObserver is subscribed to a source.

Use the public dispose() method to dispose the sequence externally and release all resources.

To release the associated resources, one has to call dispose() in onSuccess() and onError() explicitly.

Use add(Disposable) to associate resources (as Disposables) with this ResourceSingleObserver that will be cleaned up when dispose() is called. Removing previously associated resources is not possible but one can create a CompositeDisposable, associate it with this ResourceSingleObserver and then add/remove resources to/from the CompositeDisposable freely.

Like all other consumers, ResourceSingleObserver 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(), onSuccess(Object) and onError(Throwable) are not allowed to throw any unchecked exceptions.

Example

 Disposable d =
     Single.just(1).delay(1, TimeUnit.SECONDS)
     .subscribeWith(new ResourceSingleObserver<Integer>() {
         @Override public void onStart() {
             add(Schedulers.single()
                 .scheduleDirect(() -> System.out.println("Time!"),
                     2, TimeUnit.SECONDS));
         }
         @Override public void onSuccess(Integer t) {
             System.out.println(t);
             dispose();
         }
         @Override public void onError(Throwable t) {
             t.printStackTrace();
             dispose();
         }
     });
 // ...
 d.dispose();
 

Summary

[Expand] Inherited Methods
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface io.reactivex.SingleObserver abstract void onError(Throwable e) Notifies the SingleObserver that the Single has experienced an error condition. abstract void onSubscribe(Disposable d) Provides the SingleObserver with the means of cancelling (disposing) the connection (channel) with the Single in both synchronous (from within onSubscribe(Disposable) itself) and asynchronous manner. abstract void onSuccess(T t) Notifies the SingleObserver with a single item and that the Single has finished sending push-based notifications.
From interface io.reactivex.disposables.Disposable abstract void dispose() Dispose the resource, the operation should be idempotent. abstract boolean isDisposed() Returns true if this resource has been disposed.