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

public abstract Class ResourceSingleObserver<T>

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

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();

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 ResourceSingleObserver.

public final void
dispose()

Implements io.reactivex.rxjava3.disposables.Disposable.dispose.

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

Returns:

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

Implements io.reactivex.rxjava3.disposables.Disposable.isDisposed.

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

Called once the upstream sets a Disposable on this ResourceSingleObserver.

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

ResourceSingleObserverback to summary
public ResourceSingleObserver()

Method Detail

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

Adds a resource to this ResourceSingleObserver.

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 ResourceSingleObserver (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 ResourceSingleObserver has been disposed/cancelled.

Returns:boolean

true if this ResourceSingleObserver has been disposed/cancelled

Annotations
@Override
onStartback to summary
protected void onStart()

Called once the upstream sets a Disposable on this ResourceSingleObserver.

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

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