hu.akarnokd.rxjava3.operators.Completables 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.operators;

import org.reactivestreams.Publisher;

import io.reactivex.rxjava3.core.*;
import io.reactivex.rxjava3.functions.*;
import io.reactivex.rxjava3.internal.functions.ObjectHelper;

/**
 * Additional operators in the form of {@link CompletableConverter}s,
 * use {@link Completable#to(CompletableConverter)}
 * to apply the operators to an existing sequence.
 * 
 * @see CompletableTransformers
 * @since 0.20.2
 */
public final class Completables {

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

    /**
     * Maps the terminal signals of the upstream into {@link MaybeSource}s and
     * subscribes to it, relaying its terminal events to the downstream.
     * @param  the element type of the mapped-in MaybeSource
     * @param onCompleteHandler called when the upstream completes normally and should return
     * the MaybeSource to continue with.
     * @param onErrorHandler called when the upstream fails and should return the
     * MaybeSource for the given Throwable instance to continue with.
     * @return the new CompletableConverter instance
     * @since 0.20.2
     */
    public static  CompletableConverter> flatMapMaybe(
            Supplier> onCompleteHandler,
            Function> onErrorHandler) {
        ObjectHelper.requireNonNull(onCompleteHandler, "onCompleteHandler is null");
        ObjectHelper.requireNonNull(onErrorHandler, "onErrorHandler is null");
        return new CompletableFlatMapSignalMaybe(null, onCompleteHandler, onErrorHandler);
    }

    /**
     * Maps the terminal signals of the upstream into {@link SingleSource}s and
     * subscribes to it, relaying its terminal events to the downstream.
     * @param  the element type of the mapped-in SingleSource
     * @param onCompleteHandler called when the upstream completes normally and should return
     * the SingleSource to continue with.
     * @param onErrorHandler called when the upstream fails and should return the
     * SingleSource for the given Throwable instance to continue with.
     * @return the new CompletableConverter instance
     * @since 0.20.2
     */
    public static  CompletableConverter> flatMapSingle(
            Supplier> onCompleteHandler,
            Function> onErrorHandler) {
        ObjectHelper.requireNonNull(onCompleteHandler, "onCompleteHandler is null");
        ObjectHelper.requireNonNull(onErrorHandler, "onErrorHandler is null");
        return new CompletableFlatMapSignalSingle(null, onCompleteHandler, onErrorHandler);
    }

    /**
     * Maps the terminal signals of the upstream into {@link ObservableSource}s and
     * subscribes to it, relaying its terminal events to the downstream.
     * @param  the element type of the mapped-in ObservableSource
     * @param onCompleteHandler called when the upstream completes normally and should return
     * the SingleSource to continue with.
     * @param onErrorHandler called when the upstream fails and should return the
     * ObservableSource for the given Throwable instance to continue with.
     * @return the new CompletableConverter instance
     * @since 0.20.2
     */
    public static  CompletableConverter> flatMapObservable(
            Supplier> onCompleteHandler,
            Function> onErrorHandler) {
        ObjectHelper.requireNonNull(onCompleteHandler, "onCompleteHandler is null");
        ObjectHelper.requireNonNull(onErrorHandler, "onErrorHandler is null");
        return new CompletableFlatMapSignalObservable(null, onCompleteHandler, onErrorHandler);
    }

    /**
     * Maps the terminal signals of the upstream into {@link Publisher}s and
     * subscribes to it, relaying its terminal events to the downstream.
     * @param  the element type of the mapped-in ObservableSource
     * @param onCompleteHandler called when the upstream completes normally and should return
     * the Publisher to continue with.
     * @param onErrorHandler called when the upstream fails and should return the
     * Publisher for the given Throwable instance to continue with.
     * @return the new CompletableConverter instance
     * @since 0.20.2
     */
    public static  CompletableConverter> flatMapFlowable(
            Supplier> onCompleteHandler,
            Function> onErrorHandler) {
        ObjectHelper.requireNonNull(onCompleteHandler, "onCompleteHandler is null");
        ObjectHelper.requireNonNull(onErrorHandler, "onErrorHandler is null");
        return new CompletableFlatMapSignalFlowable(null, onCompleteHandler, onErrorHandler);
    }
}