jdk/src/share/classes/java/util/function/BiFunction.java
author mduigou
Tue, 19 Feb 2013 11:56:49 -0800
changeset 16011 890a7ed97f6c
child 17695 032254f2467b
permissions -rw-r--r--
8004561: Additional functional interfaces, extension methods and name changes Summary: Adds additional functional interfaces for primitives and "Bi" (two operand). Adds utility extension methods. Includes some name changes for existing functional interfaces per EG decisions. Reviewed-by: briangoetz, darcy, chegar, dholmes
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
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    27
/**
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    28
 * Apply a function to the input arguments, yielding an appropriate result. This
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    29
 * is the two-arity specialization of {@link Function}. A function may
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    30
 * variously provide a mapping between types, object instances or keys and
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    31
 * values or any other form of transformation upon the input.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    32
 *
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    33
 * @param <T> the type of the first argument to the {@code apply} operation.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    34
 * @param <U> the type of the second argument to the {@code apply} operation.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    35
 * @param <R> the type of results returned by the {@code apply} operation.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    36
 *
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    37
 * @see Function
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    38
 * @since 1.8
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
@FunctionalInterface
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    41
public interface BiFunction<T, U, R> {
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
    /**
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    44
     * Compute the result of applying the function to the input arguments
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
     * @param t an input object
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    47
     * @param u an input object
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    48
     * @return the function result
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    49
     */
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    50
    R apply(T t, U u);
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    51
}