hu.akarnokd.rxjava2.joins.Pattern2 Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rxjava2-extensions Show documentation

rxjava2-extensions developed by David Karnok

There is a newer version: 0.20.10

/*
 * Copyright 2016-2017 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.rxjava2.joins;

import io.reactivex.Observable;
import io.reactivex.functions.BiFunction;

/**
 * Represents a join pattern over observable sequences.
 * @param  the first value type
 * @param  the second value type
 */
public final class Pattern2 {
    private final Observable o1;
    private final Observable o2;

    public Pattern2(Observable o1, Observable o2) {
        this.o1 = o1;
        this.o2 = o2;
    }

    Observable o1() {
        return o1;
    }

    Observable o2() {
        return o2;
    }

    /**
     * Creates a pattern that matches when all three observable sequences have an available element.
     *
     * @param  the value type of the extra Observable
     * @param other
     *            Observable sequence to match with the two previous sequences.
     * @return Pattern object that matches when all observable sequences have an available element.
     */
    public  Pattern3 and(Observable other) {
        if (other == null) {
            throw new NullPointerException();
        }
        return new Pattern3(o1, o2, other);
    }

    /**
     * Matches when all observable sequences have an available
     * element and projects the elements by invoking the selector function.
     *
     * @param  the result type
     * @param selector
     *            the function that will be invoked for elements in the source sequences.
     * @return the plan for the matching
     * @throws NullPointerException
     *             if selector is null
     */
    public  Plan then(BiFunction selector) {
        if (selector == null) {
            throw new NullPointerException();
        }
        return new Plan2(this, selector);
    }
}