All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.reactivex.observers.ResourceSingleObserver Maven / Gradle / Ivy

The newest version!
/**
 * 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.observers;

import java.util.concurrent.atomic.AtomicReference;

import io.reactivex.SingleObserver;
import io.reactivex.annotations.NonNull;
import io.reactivex.disposables.Disposable;
import io.reactivex.internal.disposables.*;
import io.reactivex.internal.functions.ObjectHelper;
import io.reactivex.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.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.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) multiple times."}. * *

Implementation of {@link #onStart()}, {@link #onSuccess(Object)} and {@link #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();
 * 
* * @param the value type */ public abstract class ResourceSingleObserver implements SingleObserver, Disposable { /** The active subscription. */ private final AtomicReference upstream = new AtomicReference(); /** The resource composite, can never be null. */ private final ListCompositeDisposable resources = new ListCompositeDisposable(); /** * Adds a resource to this ResourceObserver. * * @param resource the resource to add * * @throws NullPointerException if resource is null */ public final void add(@NonNull Disposable resource) { ObjectHelper.requireNonNull(resource, "resource is null"); resources.add(resource); } @Override public final void onSubscribe(@NonNull Disposable d) { if (EndConsumerHelper.setOnce(this.upstream, d, getClass())) { onStart(); } } /** * Called once the upstream sets a Subscription on this ResourceObserver. * *

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 ResourceObserver (if any). * *

This method can be called before the upstream calls onSubscribe at which * case the main Disposable will be immediately disposed. */ @Override public final void dispose() { if (DisposableHelper.dispose(upstream)) { resources.dispose(); } } /** * Returns true if this ResourceObserver has been disposed/cancelled. * @return true if this ResourceObserver has been disposed/cancelled */ @Override public final boolean isDisposed() { return DisposableHelper.isDisposed(upstream.get()); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy