hu.akarnokd.rxjava3.consumers.ObservableConsumers Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rxjava3-extensions Show documentation
RxJava 3.x extra sources, operators and components and ports of many 1.x companion libraries.
There is a newer version: 3.1.1
/*
 * Copyright 2016-2019 David Karnok
 *
 * 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 hu.akarnokd.rxjava3.consumers;

import io.reactivex.rxjava3.core.Observable;
import io.reactivex.rxjava3.disposables.*;
import io.reactivex.rxjava3.functions.*;
import io.reactivex.rxjava3.internal.functions.*;

/**
 * Utility methods for creating and using consumers {@link io.reactivex.rxjava3.core.Observable}s.
 * @since 0.18.0
 */
public final class ObservableConsumers {

    /** Utility class. */
    private ObservableConsumers() {
        throw new IllegalStateException("No instances!");
    }

    /**
     * Wraps the given onXXX callbacks into a {@code Disposable} {@code Observer},
     * adds it to the given {@code CompositeDisposable} and ensures, that if the upstream
     * completes or this particlular Disposable is disposed, the Observer is removed
     * from the given composite.
     * 
     * The Observer will be removed after the callback for the terminal event has been invoked.
     * @param  the value type
     * @param source the source Observable to subscribe to.
     * @param composite the composite Disposable to add and remove the created Disposable Observer
     * @param onNext the callback for upstream items
     * @return the Disposable that allows disposing the particular subscription.
     */
    public static  Disposable subscribeAutoDispose(
            Observable source,
            CompositeDisposable composite,
            Consumer onNext) {
        ObjectHelper.requireNonNull(source, "source is null");
        ObjectHelper.requireNonNull(composite, "composite is null");
        ObjectHelper.requireNonNull(onNext, "onNext is null");

        DisposableAutoReleaseObserver observer = new DisposableAutoReleaseObserver(
                composite, onNext, null, Functions.EMPTY_ACTION);
        composite.add(observer);
        source.subscribe(observer);
        return observer;
    }

    /**
     * Wraps the given onXXX callbacks into a {@code Disposable} {@code Observer},
     * adds it to the given {@code CompositeDisposable} and ensures, that if the upstream
     * completes or this particlular Disposable is disposed, the Observer is removed
     * from the given composite.
     * 

     * The Observer will be removed after the callback for the terminal event has been invoked.
     * @param  the value type
     * @param source the source Observable to subscribe to.
     * @param composite the composite Disposable to add and remove the created Disposable Observer
     * @param onNext the callback for upstream items
     * @param onError the callback for an upstream error if any
     * @return the Disposable that allows disposing the particular subscription.
     */
    public static  Disposable subscribeAutoDispose(
            Observable source,
            CompositeDisposable composite,
            Consumer onNext,
            Consumer onError) {
        ObjectHelper.requireNonNull(source, "source is null");
        ObjectHelper.requireNonNull(composite, "composite is null");
        ObjectHelper.requireNonNull(onNext, "onNext is null");
        ObjectHelper.requireNonNull(onError, "onError is null");

        DisposableAutoReleaseObserver observer = new DisposableAutoReleaseObserver(
                composite, onNext, onError, Functions.EMPTY_ACTION);
        composite.add(observer);
        source.subscribe(observer);
        return observer;
    }

    /**
     * Wraps the given onXXX callbacks into a {@code Disposable} {@code Observer},
     * adds it to the given {@code CompositeDisposable} and ensures, that if the upstream
     * completes or this particlular Disposable is disposed, the Observer is removed
     * from the given composite.
     * 
     * The Observer will be removed after the callback for the terminal event has been invoked.
     * @param  the value type
     * @param source the source Observable to subscribe to.
     * @param composite the composite Disposable to add and remove the created Disposable Observer
     * @param onNext the callback for upstream items
     * @param onError the callback for an upstream error if any
     * @param onComplete the callback for the upstream completion if any
     * @return the Disposable that allows disposing the particular subscription.
     */
    public static  Disposable subscribeAutoDispose(
            Observable source,
            CompositeDisposable composite,
            Consumer onNext,
            Consumer onError,
            Action onComplete) {
        ObjectHelper.requireNonNull(source, "source is null");
        ObjectHelper.requireNonNull(composite, "composite is null");
        ObjectHelper.requireNonNull(onNext, "onNext is null");
        ObjectHelper.requireNonNull(onError, "onError is null");
        ObjectHelper.requireNonNull(onComplete, "onComplete is null");

        DisposableAutoReleaseObserver observer = new DisposableAutoReleaseObserver(
                composite, onNext, onError, onComplete);
        composite.add(observer);
        source.subscribe(observer);
        return observer;
    }
}