jdk/src/share/classes/java/util/function/ToDoubleBiFunction.java
author psandoz
Tue, 13 Aug 2013 11:16:37 +0200
changeset 19424 c4524285927f
parent 19040 7b25fde2a4ed
permissions -rw-r--r--
8022797: Clarify spliterator characteristics for collections containing no elements Reviewed-by: alanb, mduigou
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
/*
16748
ed60b6527f64 8012048: JDK8 b85 source with GPL header errors
katleman
parents: 16036
diff changeset
     2
 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
16011
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
/**
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    28
 * Represents a function that accepts two arguments and produces a double-valued
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    29
 * result.  This is the {@code double}-producing primitive specialization for
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    30
 * {@link BiFunction}.
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    31
 *
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    32
 * <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
    33
 * whose functional method is {@link #applyAsDouble(Object, Object)}.
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    34
 *
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    35
 * @param <T> the type of the first argument to the function
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    36
 * @param <U> the type of the second argument to the function
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    37
 *
16036
a30224365db2 8009102: Several docs warnings in Project Lambda APIs
darcy
parents: 16011
diff changeset
    38
 * @see BiFunction
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    39
 * @since 1.8
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    40
 */
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    41
@FunctionalInterface
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    42
public interface ToDoubleBiFunction<T, U> {
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
    /**
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    45
     * Applies this function to the given arguments.
16011
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
     * @param t the first function argument
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    48
     * @param u the second function argument
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    49
     * @return the function result
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    50
     */
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16748
diff changeset
    51
    double applyAsDouble(T t, U u);
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    52
}