jdk-sandbox: jdk/src/share/classes/java/util/function/BinaryOperator.java@7b25fde2a4ed (annotated)

14670 964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	1	/*
15647 314007859004 8005623: Retrofit FunctionalInterface annotations to core platform interfaces darcy parents: 14856 diff changeset	2	* Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
14670 964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	4	*
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	5	* This code is free software; you can redistribute it and/or modify it
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	6	* under the terms of the GNU General Public License version 2 only, as
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	7	* published by the Free Software Foundation. Oracle designates this
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	8	* particular file as subject to the "Classpath" exception as provided
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	9	* by Oracle in the LICENSE file that accompanied this code.
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	10	*
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	11	* This code is distributed in the hope that it will be useful, but WITHOUT
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	14	* version 2 for more details (a copy is included in the LICENSE file that
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	15	* accompanied this code).
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	16	*
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	17	* You should have received a copy of the GNU General Public License version
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	18	* 2 along with this work; if not, write to the Free Software Foundation,
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	20	*
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	22	* or visit www.oracle.com if you need additional information or have any
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	23	* questions.
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	24	*/
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	25	package java.util.function;
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	26
18571 8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	27	import java.util.Objects;
8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	28	import java.util.Comparator;
8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	29
14670 964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	30	/**
19040 7b25fde2a4ed 8019840: Spec updates for java.util.function mduigou parents: 18584 diff changeset	31	* Represents an operation upon two operands of the same type, producing a result
7b25fde2a4ed 8019840: Spec updates for java.util.function mduigou parents: 18584 diff changeset	32	* of the same type as the operands. This is a specialization of
7b25fde2a4ed 8019840: Spec updates for java.util.function mduigou parents: 18584 diff changeset	33	* {@link BiFunction} for the case where the operands and the result are all of
7b25fde2a4ed 8019840: Spec updates for java.util.function mduigou parents: 18584 diff changeset	34	* the same type.
14670 964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	35	*
19040 7b25fde2a4ed 8019840: Spec updates for java.util.function mduigou parents: 18584 diff changeset	36	* <p>This is a <a href="package-summary.html">functional interface</a>
7b25fde2a4ed 8019840: Spec updates for java.util.function mduigou parents: 18584 diff changeset	37	* whose functional method is {@link #apply(Object, Object)}.
7b25fde2a4ed 8019840: Spec updates for java.util.function mduigou parents: 18584 diff changeset	38	*
7b25fde2a4ed 8019840: Spec updates for java.util.function mduigou parents: 18584 diff changeset	39	* @param <T> the type of the operands and result of the operator
14670 964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	40	*
16036 a30224365db2 8009102: Several docs warnings in Project Lambda APIs darcy parents: 16011 diff changeset	41	* @see BiFunction
19040 7b25fde2a4ed 8019840: Spec updates for java.util.function mduigou parents: 18584 diff changeset	42	* @see UnaryOperator
14670 964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	43	* @since 1.8
964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	44	*/
15647 314007859004 8005623: Retrofit FunctionalInterface annotations to core platform interfaces darcy parents: 14856 diff changeset	45	@FunctionalInterface
16011 890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes mduigou parents: 15647 diff changeset	46	public interface BinaryOperator<T> extends BiFunction<T,T,T> {
18571 8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	47	/**
8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	48	* Returns a {@link BinaryOperator} which returns the lesser of two elements
19040 7b25fde2a4ed 8019840: Spec updates for java.util.function mduigou parents: 18584 diff changeset	49	* according to the specified {@code Comparator}.
18571 8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	50	*
19040 7b25fde2a4ed 8019840: Spec updates for java.util.function mduigou parents: 18584 diff changeset	51	* @param <T> the type of the input arguments of the comparator
7b25fde2a4ed 8019840: Spec updates for java.util.function mduigou parents: 18584 diff changeset	52	* @param comparator a {@code Comparator} for comparing the two values
18571 8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	53	* @return a {@code BinaryOperator} which returns the lesser of its operands,
8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	54	* according to the supplied {@code Comparator}
8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	55	* @throws NullPointerException if the argument is null
8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	56	*/
19040 7b25fde2a4ed 8019840: Spec updates for java.util.function mduigou parents: 18584 diff changeset	57	public static <T> BinaryOperator<T> minBy(Comparator<? super T> comparator) {
18571 8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	58	Objects.requireNonNull(comparator);
8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	59	return (a, b) -> comparator.compare(a, b) <= 0 ? a : b;
8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	60	}
8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	61
8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	62	/**
8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	63	* Returns a {@link BinaryOperator} which returns the greater of two elements
19040 7b25fde2a4ed 8019840: Spec updates for java.util.function mduigou parents: 18584 diff changeset	64	* according to the specified {@code Comparator}.
18571 8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	65	*
19040 7b25fde2a4ed 8019840: Spec updates for java.util.function mduigou parents: 18584 diff changeset	66	* @param <T> the type of the input arguments of the comparator
7b25fde2a4ed 8019840: Spec updates for java.util.function mduigou parents: 18584 diff changeset	67	* @param comparator a {@code Comparator} for comparing the two values
18571 8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	68	* @return a {@code BinaryOperator} which returns the greater of its operands,
8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	69	* according to the supplied {@code Comparator}
8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	70	* @throws NullPointerException if the argument is null
8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	71	*/
19040 7b25fde2a4ed 8019840: Spec updates for java.util.function mduigou parents: 18584 diff changeset	72	public static <T> BinaryOperator<T> maxBy(Comparator<? super T> comparator) {
18571 8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	73	Objects.requireNonNull(comparator);
8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	74	return (a, b) -> comparator.compare(a, b) >= 0 ? a : b;
8e3cb3c46ae8 8009736: Comparator API cleanup henryjen parents: 16036 diff changeset	75	}
14670 964ac9f1463c 8001634: Initial set of functional interface types mduigou parents: diff changeset	76	}

author	mduigou
	Tue, 23 Jul 2013 13:20:11 -0700
changeset 19040	7b25fde2a4ed
parent 18584	430628bf6412
permissions	-rw-r--r--