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

@@ -23,28 +23,30 @@
  * questions.
  */
 package java.util.function;
 
 /**
- * Apply a function to the input arguments, yielding an appropriate result.
- * This is the {@code int}-bearing specialization for {@link BiFunction}.
+ * Represents a function that accepts two arguments and produces an int-valued
+ * result.  This is the {@code int}-producing primitive specialization for
+ * {@link BiFunction}.
  *
- * @param <T> the type of the first argument to the {@code applyAsInt}
- * operation
- * @param <U> the type of the second argument to the {@code applyAsInt}
- * operation
+ * <p>This is a <a href="package-summary.html">functional interface</a>
+ * whose functional method is {@link #applyAsInt(Object, Object)}.
+ *
+ * @param <T> the type of the first argument to the function
+ * @param <U> the type of the second argument to the function
  *
  * @see BiFunction
  * @since 1.8
  */
 @FunctionalInterface
 public interface ToIntBiFunction<T, U> {
 
     /**
-     * Compute the result of applying the function to the input arguments
+     * Applies this function to the given arguments.
      *
-     * @param t an input object
-     * @param u an input object
-     * @return the function result value
+     * @param t the first function argument
+     * @param u the second function argument
+     * @return the function result
      */
     int applyAsInt(T t, U u);
 }