org.jooq.lambda.function.Function2 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jool Show documentation
jOOλ is part of the jOOQ series (along with jOOQ, jOOX, jOOR, jOOU) providing some useful extensions to Java 8 lambdas.
There is a newer version: 0.9.15
/**
 * Copyright (c) 2014-2016, Data Geekery GmbH, [email protected]
 *
 * 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 org.jooq.lambda.function;

import java.util.function.BiFunction;

import org.jooq.lambda.tuple.Tuple1;
import org.jooq.lambda.tuple.Tuple2;

/**
 * A function with 2 arguments.
 *
 * @author Lukas Eder
 */
@FunctionalInterface
public interface Function2 extends BiFunction {

    /**
     * Apply this function to the arguments.
     *
     * @param args The arguments as a tuple.
     */
    default R apply(Tuple2 args) {
        return apply(args.v1, args.v2);
    }

    /**
     * Apply this function to the arguments.
     */
    @Override
    R apply(T1 v1, T2 v2);

    /**
     * Convert this function to a {@link java.util.function.BiFunction}.
     */
    default BiFunction toBiFunction() {
        return this::apply;
    }

    /**
     * Convert to this function to a {@link java.util.function.BiFunction}.
     */
    static  Function2 from(BiFunction function) {
        return function::apply;
    }

    /**
     * Partially apply this function to the arguments.
     */
    default Function1 applyPartially(T1 v1) {
        return (v2) -> apply(v1, v2);
    }

    /**
     * Partially apply this function to the arguments.
     */
    default Function0 applyPartially(T1 v1, T2 v2) {
        return () -> apply(v1, v2);
    }

    /**
     * Partially apply this function to the arguments.
     */
    default Function1 applyPartially(Tuple1 args) {
        return (v2) -> apply(args.v1, v2);
    }

    /**
     * Partially apply this function to the arguments.
     */
    default Function0 applyPartially(Tuple2 args) {
        return () -> apply(args.v1, args.v2);
    }

    /**
     * Partially apply this function to the arguments.
     *
     * @deprecated - Use {@link #applyPartially(Object)} instead.
     */
    @Deprecated
    default Function1 curry(T1 v1) {
        return (v2) -> apply(v1, v2);
    }

    /**
     * Partially apply this function to the arguments.
     *
     * @deprecated - Use {@link #applyPartially(Object, Object)} instead.
     */
    @Deprecated
    default Function0 curry(T1 v1, T2 v2) {
        return () -> apply(v1, v2);
    }

    /**
     * Partially apply this function to the arguments.
     *
     * @deprecated - Use {@link #applyPartially(Tuple1)} instead.
     */
    @Deprecated
    default Function1 curry(Tuple1 args) {
        return (v2) -> apply(args.v1, v2);
    }

    /**
     * Partially apply this function to the arguments.
     *
     * @deprecated - Use {@link #applyPartially(Tuple2)} instead.
     */
    @Deprecated
    default Function0 curry(Tuple2 args) {
        return () -> apply(args.v1, args.v2);
    }
}