/* * 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.concurrent.atomic.AtomicReference; import io.reactivex.rxjava3.annotations.NonNull; import io.reactivex.rxjava3.core.Observer; import io.reactivex.rxjava3.disposables.Disposable; import io.reactivex.rxjava3.internal.disposables.DisposableHelper; import io.reactivex.rxjava3.internal.util.EndConsumerHelper; /** * An abstract {@link Observer} that allows asynchronous cancellation by implementing {@link Disposable}. * *

All pre-implemented final methods are thread-safe. * *

Use the public {@link #dispose()} method to dispose the sequence from within an * {@code onNext} implementation. * *

Like all other consumers, {@code DisposableObserver} 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) multiple times."}. * *

Implementation of {@link #onStart()}, {@link #onNext(Object)}, {@link #onError(Throwable)} * and {@link #onComplete()} are not allowed to throw any unchecked exceptions. * If for some reason this can't be avoided, use {@link io.reactivex.rxjava3.core.Observable#safeSubscribe(io.reactivex.rxjava3.core.Observer)} * instead of the standard {@code 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();
 * 
* * @param the received value type */ public abstract class DisposableObserver implements Observer, Disposable { final AtomicReference upstream = new AtomicReference<>(); @Override public final void onSubscribe(@NonNull Disposable d) { if (EndConsumerHelper.setOnce(this.upstream, d, getClass())) { onStart(); } } /** * Called once the single upstream Disposable is set via onSubscribe. */ protected void onStart() { } @Override public final boolean isDisposed() { return upstream.get() == DisposableHelper.DISPOSED; } @Override public final void dispose() { DisposableHelper.dispose(upstream); } }