Top Description Fields Constructors Methods
io.reactivex.observers

public abstract Class ResourceCompletableObserver

extends Object
implements CompletableObserver, Disposable
Class Inheritance
All Implemented Interfaces
io.reactivex.disposables.Disposable, io.reactivex.CompletableObserver
Imports
java.util.concurrent.atomic.AtomicReference, io.reactivex.CompletableObserver, io.reactivex.annotations.NonNull, io.reactivex.disposables.Disposable, io.reactivex.internal.disposables.*, io.reactivex.internal.functions.ObjectHelper, io.reactivex.internal.util.EndConsumerHelper

An abstract 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(), onError(Throwable) and 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();

Field Summary

Modifier and TypeField and Description
private final ListCompositeDisposable
resources

The resource composite, can never be null.

private final AtomicReference<Disposable>
upstream

The active subscription.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public final void
add(Disposable
the resource to add
resource
)

Adds a resource to this ResourceObserver.

public final void
dispose()

Implements io.reactivex.disposables.Disposable.dispose.

Cancels the main disposable (if any) and disposes the resources associated with this ResourceObserver (if any).
public final boolean

Returns:

true if this ResourceObserver has been disposed/cancelled
isDisposed
()

Implements io.reactivex.disposables.Disposable.isDisposed.

Returns true if this ResourceObserver has been disposed/cancelled.
protected void
onStart()

Called once the upstream sets a Subscription on this ResourceObserver.

public final void
onSubscribe(Disposable
the Disposable instance to call dispose on for cancellation, not null
d
)

Implements io.reactivex.CompletableObserver.onSubscribe.

Called once by the Completable to set a Disposable on this instance which then can be used to cancel the subscription at any time.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

resourcesback to summary
private final ListCompositeDisposable resources

The resource composite, can never be null.

upstreamback to summary
private final AtomicReference<Disposable> upstream

The active subscription.

Constructor Detail

ResourceCompletableObserverback to summary
public ResourceCompletableObserver()

Method Detail

addback to summary
public final void add(Disposable resource)

Adds a resource to this ResourceObserver.

Parameters
resource:Disposable

the resource to add

Exceptions
NullPointerException:
if resource is null
disposeback to summary
public final void dispose()

Implements io.reactivex.disposables.Disposable.dispose.

Cancels the main disposable (if any) and disposes the resources associated with this ResourceObserver (if any).

This method can be called before the upstream calls onSubscribe at which case the main Disposable will be immediately disposed.

Annotations
@Override
isDisposedback to summary
public final boolean isDisposed()

Implements io.reactivex.disposables.Disposable.isDisposed.

Returns true if this ResourceObserver has been disposed/cancelled.

Returns:boolean

true if this ResourceObserver has been disposed/cancelled

Annotations
@Override
onStartback to summary
protected void onStart()

Called once the upstream sets a Subscription on this ResourceObserver.

You can perform initialization at this moment. The default implementation does nothing.

onSubscribeback to summary
public final void onSubscribe(Disposable d)

Implements io.reactivex.CompletableObserver.onSubscribe.

Doc from io.reactivex.CompletableObserver.onSubscribe.

Called once by the Completable to set a Disposable on this instance which then can be used to cancel the subscription at any time.

Parameters
d:Disposable

the Disposable instance to call dispose on for cancellation, not null

Annotations
@Override