Class ResourceSingleObserver<T>
- Type Parameters:
T
- the value type
- All Implemented Interfaces:
SingleObserver<T>
,Disposable
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 Disposable
s)
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()
, SingleObserver.onSuccess(Object)
and SingleObserver.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
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 thisResourceSingleObserver
.final void
dispose()
Cancels the main disposable (if any) and disposes the resources associated with thisResourceSingleObserver
(if any).final boolean
Returns true if thisResourceSingleObserver
has been disposed/cancelled.protected void
onStart()
Called once the upstream sets aDisposable
on thisResourceSingleObserver
.final void
Provides theSingleObserver
with the means of cancelling (disposing) the connection (channel) with the Single in both synchronous (from withinonSubscribe(Disposable)
itself) and asynchronous manner.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.SingleObserver
onError, onSuccess
-
Field Details
-
upstream
The active subscription. -
resources
The resource composite, can never be null.
-
-
Constructor Details
-
ResourceSingleObserver
public ResourceSingleObserver()
-
-
Method Details
-
add
Adds a resource to thisResourceSingleObserver
.- Parameters:
resource
- the resource to add- Throws:
NullPointerException
- if resource isnull
-
onSubscribe
Description copied from interface:SingleObserver
Provides theSingleObserver
with the means of cancelling (disposing) the connection (channel) with the Single in both synchronous (from withinonSubscribe(Disposable)
itself) and asynchronous manner.- Specified by:
onSubscribe
in interfaceSingleObserver<T>
- Parameters:
d
- the Disposable instance whoseDisposable.dispose()
can be called anytime to cancel the connection
-
onStart
protected void onStart()Called once the upstream sets aDisposable
on thisResourceSingleObserver
.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 thisResourceSingleObserver
(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 thisResourceSingleObserver
has been disposed/cancelled.- Specified by:
isDisposed
in interfaceDisposable
- Returns:
- true if this
ResourceSingleObserver
has been disposed/cancelled
-