IntBiFunction.java

/*
 * Strongback
 * Copyright 2015, Strongback and individual contributors by the @authors tag.
 * See the COPYRIGHT.txt in the distribution for a full listing of individual
 * contributors.
 *
 * Licensed under the MIT License; you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://opensource.org/licenses/MIT
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.strongback.function;

import java.util.function.Function;

/**
 * Represents a function that accepts two a integer-valued arguments and produces a integer-valued result. This is the
 * {@code integer} primitive specialization for {@link Function BiFunction}.
 * <p>
 * This is a functional interface whose functional method is {@link #applyAsInt(int,int)}.
 *
 * @see Function
 * @author Randall Hauch
 */
@FunctionalInterface
public interface IntBiFunction {

    /**
     * Applies this function to the given arguments.
     *
     * @param t the first function argument
     * @param u the second function argument
     * @return the function result
     */
    public int applyAsInt(int t, int u);
}