1 /* 2 * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 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 * An operation on two {@code long} operands yielding a {@code long} result. 29 * 30 * <p>This is the primitive type specialization of {@link BinaryOperator} for 31 * {@code long} and also may be used as a {@code BinaryOperator<Long>}. When 32 * used as a {@code BinaryOperator} the default {@code operate} implementation 33 * provided by this interface neither accepts null parameters nor does it return 34 * null results. 35 * 36 * @since 1.8 37 */ 38 public interface LongBinaryOperator extends BinaryOperator<Long> { 39 40 /** 41 * {@inheritDoc} 42 * 43 * @param left {@inheritDoc}, must be non-null 44 * @param right {@inheritDoc}, must be non-null 45 * @return {@inheritDoc}, always non-null 46 */ 47 @Override 48 public default Long operate(Long left, Long right) { 49 return operateAsLong((long)left, (long)right); 50 } 51 52 /** 53 * Returns the {@code long} result of the operation upon the {@code long} 54 * operands. The parameters are named {@code left} and {@code right} for 55 * operations where the order of parameters matters. 56 * 57 * @param left the left operand value 58 * @param right the right operand value 59 * @return the result of the operation 60 */ 61 public long operateAsLong(long left, long right); 62 }