T
- the received value typepublic abstract class DisposableObserver<T> extends Object implements Observer<T>, Disposable
Observer
that allows asynchronous cancellation by implementing Disposable
.
All pre-implemented final methods are thread-safe.
Use the public dispose()
method to dispose the sequence from within an
onNext
implementation.
Like all other consumers, DisposableObserver
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()
, Observer.onNext(Object)
, Observer.onError(Throwable)
and Observer.onComplete()
are not allowed to throw any unchecked exceptions.
If for some reason this can't be avoided, use Observable.safeSubscribe(io.reactivex.rxjava3.core.Observer)
instead of the standard subscribe()
method.
Example
Disposable d =
Observable.range(1, 5)
.subscribeWith(new DisposableObserver<Integer>() {
@Override public void onStart() {
System.out.println("Start!");
}
@Override public void onNext(Integer t) {
if (t == 3) {
dispose();
}
System.out.println(t);
}
@Override public void onError(Throwable t) {
t.printStackTrace();
}
@Override public void onComplete() {
System.out.println("Done!");
}
});
// ...
d.dispose();
Constructor and Description |
---|
DisposableObserver() |
Modifier and Type | Method and Description |
---|---|
void |
dispose()
Dispose the resource, the operation should be idempotent.
|
boolean |
isDisposed()
Returns true if this resource has been disposed.
|
protected void |
onStart()
Called once the single upstream Disposable is set via onSubscribe.
|
void |
onSubscribe(@NonNull Disposable d)
Provides the
Observer with the means of cancelling (disposing) the
connection (channel) with the Observable in both
synchronous (from within Observer.onNext(Object) ) and asynchronous manner. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
onComplete, onError, onNext
disposed, empty, fromAction, fromAutoCloseable, fromFuture, fromFuture, fromRunnable, fromSubscription, toAutoCloseable
public final void onSubscribe(@NonNull @NonNull Disposable d)
Observer
Observer
with the means of cancelling (disposing) the
connection (channel) with the Observable
in both
synchronous (from within Observer.onNext(Object)
) and asynchronous manner.onSubscribe
in interface Observer<T>
d
- the Disposable
instance whose Disposable.dispose()
can
be called anytime to cancel the connectionprotected void onStart()
public final boolean isDisposed()
Disposable
isDisposed
in interface Disposable
public final void dispose()
Disposable
dispose
in interface Disposable