rx.joins.Pattern3 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rxjava-joins Show documentation
rxjava-joins
The newest version!
/**
 * Copyright 2014 Netflix, Inc.
 * 
 * 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 rx.joins;

import rx.Observable;
import rx.functions.Func3;

/**
 * Represents a join pattern over observable sequences.
 */
public final class Pattern3 implements Pattern {
    private final Observable o1;
    private final Observable o2;
    private final Observable o3;

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

    Observable o1() {
        return o1;
    }

    Observable o2() {
        return o2;
    }

    Observable o3() {
        return o3;
    }

    /**
     * Creates a pattern that matches when all three observable sequences have an available element.
     * 
     * @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  Pattern4 and(Observable other) {
        if (other == null) {
            throw new NullPointerException();
        }
        return new Pattern4(o1, o2, o3, other);
    }
    
    /**
     * Matches when all observable sequences have an available
     * element and projects the elements by invoking the selector function.
     * 
     * @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  Plan0 then(Func3 selector) {
        if (selector == null) {
            throw new NullPointerException();
        }
        return new Plan3(this, selector);
    }
}