/*
 * Copyright (c) 2010, 2011, 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.functions;

/**
 * Combines two operands of the same type producing a result of the same type.
 *
 * @param <T> the type of input objects to {@code operate} and of the result.
 *
 * @since  1.8
 */
public interface BinaryOperator<T> /* extends Combiner<T,T,T> */ {

    /**
     * Returns the result of some operation upon the the operands.
     * The operands are named {@code left} and {@code right} for operations
     * where the order of operands matters.
     *
     * @param left Input object used as the left operand.
     * @param right Input object used as the right operand.
     * @return result of the operation.
     */
    public T operate(T left, T right);
}