Top Description Fields Constructors Methods
io.reactivex.rxjava3.observers

public abstract Class ResourceObserver<T>

extends Object
implements Observer<T>, Disposable
Class Inheritance
All Implemented Interfaces
io.reactivex.rxjava3.disposables.Disposable, io.reactivex.rxjava3.core.Observer
Type Parameters
<T>
the value type
Imports
java.util.Objects, java.util.concurrent.atomic.AtomicReference, io.reactivex.rxjava3.annotations.NonNull, io.reactivex.rxjava3.core.Observer, io.reactivex.rxjava3.disposables.Disposable, io.reactivex.rxjava3.internal.disposables.*, io.reactivex.rxjava3.internal.util.EndConsumerHelper

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

All pre-implemented final methods are thread-safe.

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 ResourceObserver 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 ResourceObserver and then add/remove resources to/from the CompositeDisposable freely.

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

Like all other consumers, ResourceObserver 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 io.reactivex.rxjava3.core.Observable#safeSubscribe(io.reactivex.rxjava3.core.Observer) instead of the standard subscribe() method.

Example


Disposable d =
    Observable.range(1, 5)
    .subscribeWith(new ResourceObserver<Integer>() {
        @Override public void onStart() {
            add(Schedulers.single()
                .scheduleDirect(() -> System.out.println("Time!"),
                    2, TimeUnit.SECONDS));
            request(1);
        }
        @Override public void onNext(Integer t) {
            if (t == 3) {
                dispose();
            }
            System.out.println(t);
        }
        @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(@NonNull Disposable
the resource to add
resource
)

Adds a resource to this ResourceObserver.

public final void
dispose()

Implements io.reactivex.rxjava3.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.rxjava3.disposables.Disposable.isDisposed.

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

Called once the upstream sets a Disposable on this ResourceObserver.

public final void
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

ResourceObserverback to summary
public ResourceObserver()

Method Detail

addback to summary
public final void add(@NonNull Disposable resource)

Adds a resource to this ResourceObserver.

Parameters
resource:@NonNull Disposable

the resource to add

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

Implements io.reactivex.rxjava3.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(Disposable) at which case the main Disposable will be immediately disposed.

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

Implements io.reactivex.rxjava3.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 Disposable on this ResourceObserver.

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

onSubscribeback to summary
public final void onSubscribe(Disposable d)
Annotations
@Override