Class ResourceCompletableObserver
- java.lang.Object
-
- io.reactivex.rxjava3.observers.ResourceCompletableObserver
-
- All Implemented Interfaces:
CompletableObserver
,Disposable
public abstract class ResourceCompletableObserver extends java.lang.Object implements CompletableObserver, Disposable
An abstractCompletableObserver
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 thisResourceCompletableObserver
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()
inonError()
andonComplete()
explicitly.Use
add(Disposable)
to associate resources (asDisposable
s) with thisResourceCompletableObserver
that will be cleaned up whendispose()
is called. Removing previously associated resources is not possible but one can create aCompositeDisposable
, associate it with thisResourceCompletableObserver
and then add/remove resources to/from theCompositeDisposable
freely.Like all other consumers,
ResourceCompletableObserver
can be subscribed only once. Any subsequent attempt to subscribe it to a new source will yield anIllegalStateException
with message"It is not allowed to subscribe with a(n) <class name> multiple times."
.Implementation of
onStart()
,CompletableObserver.onError(Throwable)
andCompletableObserver.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
Fields Modifier and Type Field Description private ListCompositeDisposable
resources
The resource composite, can never be null.private java.util.concurrent.atomic.AtomicReference<Disposable>
upstream
The active subscription.
-
Constructor Summary
Constructors Constructor Description ResourceCompletableObserver()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(@NonNull Disposable resource)
Adds a resource to thisResourceCompletableObserver
.void
dispose()
Cancels the main disposable (if any) and disposes the resources associated with thisResourceCompletableObserver
(if any).boolean
isDisposed()
Returns true if thisResourceCompletableObserver
has been disposed/cancelled.protected void
onStart()
Called once the upstream sets aDisposable
on thisResourceCompletableObserver
.void
onSubscribe(@NonNull Disposable d)
Called once by theCompletable
to set aDisposable
on this instance which then can be used to cancel the subscription at any time.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface io.reactivex.rxjava3.core.CompletableObserver
onComplete, onError
-
-
-
-
Field Detail
-
upstream
private final java.util.concurrent.atomic.AtomicReference<Disposable> upstream
The active subscription.
-
resources
private final ListCompositeDisposable resources
The resource composite, can never be null.
-
-
Method Detail
-
add
public final void add(@NonNull @NonNull Disposable resource)
Adds a resource to thisResourceCompletableObserver
.- Parameters:
resource
- the resource to add- Throws:
java.lang.NullPointerException
- if resource isnull
-
onSubscribe
public final void onSubscribe(@NonNull @NonNull Disposable d)
Description copied from interface:CompletableObserver
Called once by theCompletable
to set aDisposable
on this instance which then can be used to cancel the subscription at any time.- Specified by:
onSubscribe
in interfaceCompletableObserver
- Parameters:
d
- theDisposable
instance to call dispose on for cancellation, not null
-
onStart
protected void onStart()
Called once the upstream sets aDisposable
on thisResourceCompletableObserver
.You can perform initialization at this moment. The default implementation does nothing.
-
dispose
public final void dispose()
Cancels the main disposable (if any) and disposes the resources associated with thisResourceCompletableObserver
(if any).This method can be called before the upstream calls
onSubscribe(Disposable)
at which case the mainDisposable
will be immediately disposed.- Specified by:
dispose
in interfaceDisposable
-
isDisposed
public final boolean isDisposed()
Returns true if thisResourceCompletableObserver
has been disposed/cancelled.- Specified by:
isDisposed
in interfaceDisposable
- Returns:
- true if this
ResourceCompletableObserver
has been disposed/cancelled
-
-