/*
 * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package java.util.function;

/**
 * An operation on two {@code int} operands yielding an {@code int} result.
 *
 * <p>This is the primitive type specialization of {@link BinaryOperator} for
 * {@code int} and also may be used as a {@code BinaryOperator<Integer>}. When
 * used as a {@code BinaryOperator} the default {@code operate} implementation
 * provided by this interface neither accepts null parameters nor does it return
 * null results.
 *
 * @since 1.8
 */
public interface IntBinaryOperator extends BinaryOperator<Integer> {

    /**
     * {@inheritDoc}
     *
     * @param left {@inheritDoc}, must be non-null
     * @param right {@inheritDoc}, must be non-null
     * @return {@inheritDoc}, always non-null
     */
    @Override
    public default Integer operate(Integer left, Integer right) {
        return operateAsInt((int)left, (int)right);
    }

    /**
     * Returns the {@code int} result of the operation upon the {@code int}
     * operands. The parameters are named {@code left} and {@code right} for
     * operations where the order of parameters matters.
     *
     * @param left the left operand value
     * @param right  the right operand value
     * @return the result of the operation
     */
    public int operateAsInt(int left, int right);
}