src/share/classes/java/util/function/ToIntBiFunction.java

Print this page
rev 7675 : 8019840: Spec updates for java.util.function
Reviewed-by: mduigou
Contributed-by: brian.goetz@oracle.com


   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package java.util.function;
  26 
  27 /**
  28  * Apply a function to the input arguments, yielding an appropriate result.
  29  * This is the {@code int}-bearing specialization for {@link BiFunction}.

  30  *
  31  * @param <T> the type of the first argument to the {@code applyAsInt}
  32  * operation
  33  * @param <U> the type of the second argument to the {@code applyAsInt}
  34  * operation

  35  *
  36  * @see BiFunction
  37  * @since 1.8
  38  */
  39 @FunctionalInterface
  40 public interface ToIntBiFunction<T, U> {
  41 
  42     /**
  43      * Compute the result of applying the function to the input arguments
  44      *
  45      * @param t an input object
  46      * @param u an input object
  47      * @return the function result value
  48      */
  49     int applyAsInt(T t, U u);
  50 }


   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package java.util.function;
  26 
  27 /**
  28  * Represents a function that accepts two arguments and produces an int-valued
  29  * result.  This is the {@code int}-producing primitive specialization for
  30  * {@link BiFunction}.
  31  *
  32  * <p>This is a <a href="package-summary.html">functional interface</a>
  33  * whose functional method is {@link #applyAsInt(Object, Object)}.
  34  *
  35  * @param <T> the type of the first argument to the function
  36  * @param <U> the type of the second argument to the function
  37  *
  38  * @see BiFunction
  39  * @since 1.8
  40  */
  41 @FunctionalInterface
  42 public interface ToIntBiFunction<T, U> {
  43 
  44     /**
  45      * Applies this function to the given arguments.
  46      *
  47      * @param t the first function argument
  48      * @param u the second function argument
  49      * @return the function result
  50      */
  51     int applyAsInt(T t, U u);
  52 }