/* * Copyright (c) 2016-present, RxJava Contributors. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in * compliance with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software distributed under the License is * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See * the License for the specific language governing permissions and limitations under the License. */ package io.reactivex.rxjava3.observers; import java.util.Objects; import java.util.concurrent.atomic.AtomicReference; import io.reactivex.rxjava3.annotations.NonNull; import io.reactivex.rxjava3.core.SingleObserver; import io.reactivex.rxjava3.disposables.Disposable; import io.reactivex.rxjava3.internal.disposables.*; import io.reactivex.rxjava3.internal.util.EndConsumerHelper; /** * An abstract {@link SingleObserver} that allows asynchronous cancellation of its subscription * and the associated resources. * *
All pre-implemented final methods are thread-safe. * *
Override the protected {@link #onStart()} to perform initialization when this * {@code ResourceSingleObserver} is subscribed to a source. * *
Use the public {@link #dispose()} method to dispose the sequence externally and release * all resources. * *
To release the associated resources, one has to call {@link #dispose()} * in {@code onSuccess()} and {@code onError()} explicitly. * *
Use {@link #add(Disposable)} to associate resources (as {@link io.reactivex.rxjava3.disposables.Disposable Disposable}s) * with this {@code ResourceSingleObserver} that will be cleaned up when {@link #dispose()} is called. * Removing previously associated resources is not possible but one can create a * {@link io.reactivex.rxjava3.disposables.CompositeDisposable CompositeDisposable}, associate it with this * {@code ResourceSingleObserver} and then add/remove resources to/from the {@code CompositeDisposable} * freely. * *
Like all other consumers, {@code ResourceSingleObserver} can be subscribed only once.
* Any subsequent attempt to subscribe it to a new source will yield an
* {@link IllegalStateException} with message {@code "It is not allowed to subscribe with a(n) Implementation of {@link #onStart()}, {@link #onSuccess(Object)} and {@link #onError(Throwable)}
* are not allowed to throw any unchecked exceptions.
*
* Example You can perform initialization at this moment. The default
* implementation does nothing.
*/
protected void onStart() {
}
/**
* Cancels the main disposable (if any) and disposes the resources associated with
* this {@code ResourceSingleObserver} (if any).
*
* This method can be called before the upstream calls {@link #onSubscribe(Disposable)} at which
* case the main {@link Disposable} will be immediately disposed.
*/
@Override
public final void dispose() {
if (DisposableHelper.dispose(upstream)) {
resources.dispose();
}
}
/**
* Returns true if this {@code ResourceSingleObserver} has been disposed/cancelled.
* @return true if this {@code ResourceSingleObserver} has been disposed/cancelled
*/
@Override
public final boolean isDisposed() {
return DisposableHelper.isDisposed(upstream.get());
}
}
*
* @param
* 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();
*