jdk/src/share/classes/java/util/function/BiFunction.java
author mduigou
Tue, 23 Jul 2013 13:20:11 -0700
changeset 19040 7b25fde2a4ed
parent 17695 032254f2467b
permissions -rw-r--r--
8019840: Spec updates for java.util.function Reviewed-by: mduigou, chegar Contributed-by: brian.goetz@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     1
/*
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     2
 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     4
 *
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    10
 *
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    15
 * accompanied this code).
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    16
 *
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    20
 *
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    23
 * questions.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    24
 */
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    25
package java.util.function;
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    26
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    27
import java.util.Objects;
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    28
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    29
/**
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    30
 * Represents a function that accepts two arguments and produces a result.
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    31
 * This is the two-arity specialization of {@link Function}.
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    32
 *
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    33
 * <p>This is a <a href="package-summary.html">functional interface</a>
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    34
 * whose functional method is {@link #apply(Object, Object)}.
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    35
 *
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    36
 * @param <T> the type of the first argument to the function
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    37
 * @param <U> the type of the second argument to the function
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    38
 * @param <R> the type of the result of the function
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    39
 *
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    40
 * @see Function
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    41
 * @since 1.8
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    42
 */
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    43
@FunctionalInterface
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    44
public interface BiFunction<T, U, R> {
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    45
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    46
    /**
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    47
     * Applies this function to the given arguments.
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    48
     *
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    49
     * @param t the first function argument
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    50
     * @param u the second function argument
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    51
     * @return the function result
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    52
     */
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    53
    R apply(T t, U u);
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    54
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    55
    /**
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    56
     * Returns a composed function that first applies this function to
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    57
     * its input, and then applies the {@code after} function to the result.
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    58
     * If evaluation of either function throws an exception, it is relayed to
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    59
     * the caller of the composed function.
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    60
     *
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    61
     * @param <V> the type of output of the {@code after} function, and of the
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    62
     *           composed function
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    63
     * @param after the function to apply after this function is applied
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    64
     * @return a composed function that first applies this function and then
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    65
     * applies the {@code after} function
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    66
     * @throws NullPointerException if after is null
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    67
     */
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    68
    default <V> BiFunction<T, U, V> andThen(Function<? super R, ? extends V> after) {
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    69
        Objects.requireNonNull(after);
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    70
        return (T t, U u) -> after.apply(apply(t, u));
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    71
    }
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    72
}