Class ResourceCompletableObserver
- All Implemented Interfaces:
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 Disposable
s)
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();
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final ListCompositeDisposable
The resource composite, can never be null.private final AtomicReference
<Disposable> The active subscription. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal void
add
(@NonNull Disposable resource) Adds a resource to thisResourceCompletableObserver
.final void
dispose()
Cancels the main disposable (if any) and disposes the resources associated with thisResourceCompletableObserver
(if any).final boolean
Returns true if thisResourceCompletableObserver
has been disposed/cancelled.protected void
onStart()
Called once the upstream sets aDisposable
on thisResourceCompletableObserver
.final void
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 Details
-
upstream
The active subscription. -
resources
The resource composite, can never be null.
-
-
Constructor Details
-
ResourceCompletableObserver
public ResourceCompletableObserver()
-
-
Method Details
-
add
Adds a resource to thisResourceCompletableObserver
.- Parameters:
resource
- the resource to add- Throws:
NullPointerException
- if resource isnull
-
onSubscribe
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
-