hu.akarnokd.rxjava.interop.RxJavaInterop Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rxjava2-interop Show documentation
rxjava2-interop developed by David Karnok
There is a newer version: 0.13.7
/*
 * Copyright 2016 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.rxjava.interop;

/**
 * Conversion methods for converting between 1.x and 2.x reactive types, composing backpressure
 * and cancellation through.
 */
public final class RxJavaInterop {
    /** Utility class. */
    private RxJavaInterop() {
        throw new IllegalStateException("No instances!");
    }

    // -----------------------------------------------------------------------------------------
    // Conversions to 2.x
    // -----------------------------------------------------------------------------------------

    /**
     * Converts an 1.x Observable into a 2.x Flowable, composing the backpressure and
     * cancellation (unsubscription) through.
     * 
     * Note that in 1.x Observable's backpressure somewhat optional; you may need to apply
     * one of the onBackpressureXXX operators on the source Observable or the resulting Flowable.
     * 

     *  Backpressure:
     *  The operator doesn't interfere with backpressure which is determined by the 
     *  source 1.x {@code Observable}'s backpressure behavior.
     *  Scheduler:
     *  The method does not operate by default on a particular {@code Scheduler}.
     * 
     * @param  the value type
     * @param source the source 1.x Observable instance, not null
     * @return the new 2.x Flowable instance
     * @throws NullPointerException if {@code source} is null
     */
    public static  io.reactivex.Flowable toV2Flowable(rx.Observable source) {
        io.reactivex.internal.functions.ObjectHelper.requireNonNull(source, "source is null");
        return new ObservableV1ToFlowableV2(source);
    }
    
    /**
     * Converts an 1.x Observable into a 2.x Observable, cancellation (unsubscription) through.
     * 
     *  Backpressure:
     *  The operator consumes the source 1.x {@code Observable} in an
     *  unbounded manner (without applying backpressure).
     *  Scheduler:
     *  The method does not operate by default on a particular {@code Scheduler}.
     * 
     * @param  the value type
     * @param source the source 1.x Observable instance, not null
     * @return the new 2.x Observable instance
     * @throws NullPointerException if {@code source} is null
     */
    public static  io.reactivex.Observable toV2Observable(rx.Observable source) {
        io.reactivex.internal.functions.ObjectHelper.requireNonNull(source, "source is null");
        return new ObservableV1ToObservableV2(source);
    }
    
    /**
     * Converts an 1.x Single into a 2.x Single, composing cancellation (unsubscription) through.
     * 
     *  Scheduler:
     *  The method does not operate by default on a particular {@code Scheduler}.
     * 
     * @param  the value type
     * @param source the source 1.x Single instance, not null
     * @return the new 2.x Single instance
     * @throws NullPointerException if {@code source} is null
     */
    public static  io.reactivex.Single toV2Single(rx.Single source) {
        io.reactivex.internal.functions.ObjectHelper.requireNonNull(source, "source is null");
        return new SingleV1ToSingleV2(source);
    }
    
    /**
     * Converts an 1.x Completable into a 2.x Completable, composing cancellation (unsubscription) through.
     * 
     *  Scheduler:
     *  The method does not operate by default on a particular {@code Scheduler}.
     * 
     * @param source the source 1.x Completable instance, not null
     * @return the new 2.x Completable instance
     * @throws NullPointerException if {@code source} is null
     */
    public static io.reactivex.Completable toV2Completable(rx.Completable source) {
        io.reactivex.internal.functions.ObjectHelper.requireNonNull(source, "source is null");
        return new CompletableV1ToCompletableV2(source);
    }
    
    // -----------------------------------------------------------------------------------------
    // Conversions to 1.x
    // -----------------------------------------------------------------------------------------
    
    /**
     * Converts a Reactive-Streams Publisher of any kind (the base type of 2.x Flowable)
     * into an 1.x Observable, composing the backpressure and cancellation 
     * (unsubscription) through.
     * 
     * Note that this method can convert any Reactive-Streams compliant
     * source into an 1.x Observable, not just the 2.x Flowable.
     * 

     *  Backpressure:
     *  The operator doesn't interfere with backpressure which is determined by the 
     *  source {@code Publisher}'s backpressure behavior.
     *  Scheduler:
     *  The method does not operate by default on a particular {@code Scheduler}.
     * 
     * @param  the value type
     * @param source the source Reactive-Streams Publisher instance, not null
     * @return the new 1.x Observable instance
     * @throws NullPointerException if {@code source} is null
     */
    public static  rx.Observable toV1Observable(org.reactivestreams.Publisher source) {
        io.reactivex.internal.functions.ObjectHelper.requireNonNull(source, "source is null");
        return rx.Observable.create(new FlowableV2ToObservableV1(source));
    }
    
    /**
     * Converts a 2.x ObservableSource (the base type of 2.x Observable) into an 1.x
     * Observable instance, applying the specified backpressure strategy and composing
     * the cancellation (unsubscription) through.
     * 
     *  Backpressure:
     *  The operator applies the backpressure strategy you specify.
     *  Scheduler:
     *  The method does not operate by default on a particular {@code Scheduler}.
     * 
     * @param  the value type
     * @param source the source ObservableSource instance, not null
     * @param strategy the backpressure strategy to apply: BUFFER, DROP or LATEST.
     * @return the new 1.x Observable instance
     * @throws NullPointerException if {@code source} is null
     */
    public static  rx.Observable toV1Observable(io.reactivex.ObservableSource source, io.reactivex.BackpressureStrategy strategy) {
        io.reactivex.internal.functions.ObjectHelper.requireNonNull(source, "source is null");
        io.reactivex.internal.functions.ObjectHelper.requireNonNull(strategy, "strategy is null");
        return toV1Observable(io.reactivex.Observable.wrap(source).toFlowable(strategy));
    }
    
    /**
     * Converts an 2.x SingleSource (the base type of 2.x Single) into a 
     * 1.x Single, composing cancellation (unsubscription) through.
     * 
     *  Scheduler:
     *  The method does not operate by default on a particular {@code Scheduler}.
     * 
     * @param  the value type
     * @param source the source 2.x SingleSource instance, not null
     * @return the new 1.x Single instance
     * @throws NullPointerException if {@code source} is null
     */
    public static  rx.Single toV1Single(io.reactivex.SingleSource source) {
        io.reactivex.internal.functions.ObjectHelper.requireNonNull(source, "source is null");
        return rx.Single.create(new SingleV2ToSingleV1(source));
    }
    
    /**
     * Converts an 2.x CompletableSource (the base type of 2.x Completable) into a 
     * 1.x Completable, composing cancellation (unsubscription) through.
     * 
     *  Scheduler:
     *  The method does not operate by default on a particular {@code Scheduler}.
     * 
     * @param source the source 2.x CompletableSource instance, not null
     * @return the new 1.x Completable instance
     * @throws NullPointerException if {@code source} is null
     */
    public static rx.Completable toV1Completable(io.reactivex.CompletableSource source) {
        io.reactivex.internal.functions.ObjectHelper.requireNonNull(source, "source is null");
        return rx.Completable.create(new CompletableV2ToCompletableV1(source));
    }
}