public abstract class ResourceCompletableObserver extends Object implements CompletableObserver, Disposable
CompletableObserver that allows asynchronous cancellation of its subscription and associated resources.
All pre-implemented final methods are thread-safe.
Override the protected onStart() to perform initialization when this
ResourceCompletableObserver 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 onError() and onComplete() explicitly.
Use add(Disposable) to associate resources (as Disposables)
with this ResourceCompletableObserver 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
ResourceCompletableObserver and then add/remove resources to/from the CompositeDisposable
freely.
Like all other consumers, ResourceCompletableObserver 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(), CompletableObserver.onError(Throwable)
and CompletableObserver.onComplete() are not allowed to throw any unchecked exceptions.
Example
Disposable d =
Completable.complete().delay(1, TimeUnit.SECONDS)
.subscribeWith(new ResourceCompletableObserver() {
@Override public void onStart() {
add(Schedulers.single()
.scheduleDirect(() -> System.out.println("Time!"),
2, TimeUnit.SECONDS));
}
@Override public void onError(Throwable t) {
t.printStackTrace();
dispose();
}
@Override public void onComplete() {
System.out.println("Done!");
dispose();
}
});
// ...
d.dispose();
| Constructor and Description |
|---|
ResourceCompletableObserver () |
| Modifier and Type | Method and Description |
|---|---|
void |
add (@NonNull Disposable resource)
Adds a resource to this
ResourceCompletableObserver. |
void |
dispose ()
Cancels the main disposable (if any) and disposes the resources associated with
this
ResourceCompletableObserver (if any). |
boolean |
isDisposed ()
Returns true if this
ResourceCompletableObserver has been disposed/cancelled. |
protected void |
onStart ()
Called once the upstream sets a
Disposable on this ResourceCompletableObserver. |
void |
onSubscribe (@NonNull Disposable d)
Called once by the
Completable to set a Disposable on this instance which
then can be used to cancel the subscription at any time. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait onComplete, onError disposed, empty, fromAction, fromAutoCloseable, fromFuture, fromFuture, fromRunnable, fromSubscription, toAutoCloseable public ResourceCompletableObserver()
public final void add(@NonNull @NonNull Disposable resource)
ResourceCompletableObserver.resource - the resource to addNullPointerException - if resource is nullpublic final void onSubscribe(@NonNull @NonNull Disposable d)
CompletableObserver Completable to set a Disposable on this instance which
then can be used to cancel the subscription at any time.onSubscribe in interface CompletableObserver d - the Disposable instance to call dispose on for cancellation, not nullprotected void onStart()
Disposable on this ResourceCompletableObserver.
You can perform initialization at this moment. The default implementation does nothing.
public final void dispose()
ResourceCompletableObserver (if any).
This method can be called before the upstream calls onSubscribe(Disposable) at which
case the main Disposable will be immediately disposed.
dispose in interface Disposable public final boolean isDisposed()
ResourceCompletableObserver has been disposed/cancelled.isDisposed in interface Disposable ResourceCompletableObserver has been disposed/cancelled