jdk/src/share/classes/java/util/function/IntBinaryOperator.java
author mduigou
Tue, 19 Feb 2013 11:56:49 -0800
changeset 16011 890a7ed97f6c
parent 15647 314007859004
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:
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
     1
/*
15647
314007859004 8005623: Retrofit FunctionalInterface annotations to core platform interfaces
darcy
parents: 14670
diff changeset
     2
 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
     4
 *
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    10
 *
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    15
 * accompanied this code).
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    16
 *
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    20
 *
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    23
 * questions.
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    24
 */
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    25
package java.util.function;
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    26
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    27
/**
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    28
 * An operation on two {@code int} operands yielding an {@code int} result.
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents: 15647
diff changeset
    29
 * This is the primitive type specialization of {@link BinaryOperator} for
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents: 15647
diff changeset
    30
 * {@code int}.
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    31
 *
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents: 15647
diff changeset
    32
 * @see BinaryOperator
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    33
 * @since 1.8
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    34
 */
15647
314007859004 8005623: Retrofit FunctionalInterface annotations to core platform interfaces
darcy
parents: 14670
diff changeset
    35
@FunctionalInterface
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    36
public interface IntBinaryOperator {
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    37
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    38
    /**
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    39
     * Returns the {@code int} result of the operation upon the {@code int}
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    40
     * operands. The parameters are named {@code left} and {@code right} for
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    41
     * operations where the order of parameters matters.
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    42
     *
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    43
     * @param left the left operand value
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    44
     * @param right  the right operand value
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    45
     * @return the result of the operation
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    46
     */
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents: 15647
diff changeset
    47
    public int applyAsInt(int left, int right);
14670
964ac9f1463c 8001634: Initial set of functional interface types
mduigou
parents:
diff changeset
    48
}