1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.io.function;
19
20 import java.io.IOException;
21 import java.io.UncheckedIOException;
22 import java.util.Objects;
23 import java.util.function.BinaryOperator;
24
25 /**
26 * Like {@link BinaryOperator} but throws {@link IOException}.
27 *
28 * @param <T> the type of the operands and result of the operator.
29 * @see IOBiFunction
30 * @see BinaryOperator
31 * @since 2.12.0
32 */
33 @FunctionalInterface
34 public interface IOBinaryOperator<T> extends IOBiFunction<T, T, T> {
35
36 /**
37 * Creates a {@link IOBinaryOperator} which returns the greater of two elements according to the specified
38 * {@code Comparator}.
39 *
40 * @param <T> the type of the input arguments of the comparator
41 * @param comparator a {@code Comparator} for comparing the two values
42 * @return a {@code BinaryOperator} which returns the greater of its operands, according to the supplied
43 * {@code Comparator}
44 * @throws NullPointerException if the argument is null
45 */
46 static <T> IOBinaryOperator<T> maxBy(final IOComparator<? super T> comparator) {
47 Objects.requireNonNull(comparator);
48 return (a, b) -> comparator.compare(a, b) >= 0 ? a : b;
49 }
50
51 /**
52 * Creates a {@link IOBinaryOperator} which returns the lesser of two elements according to the specified
53 * {@code Comparator}.
54 *
55 * @param <T> the type of the input arguments of the comparator
56 * @param comparator a {@code Comparator} for comparing the two values
57 * @return a {@code BinaryOperator} which returns the lesser of its operands, according to the supplied
58 * {@code Comparator}
59 * @throws NullPointerException if the argument is null
60 */
61 static <T> IOBinaryOperator<T> minBy(final IOComparator<? super T> comparator) {
62 Objects.requireNonNull(comparator);
63 return (a, b) -> comparator.compare(a, b) <= 0 ? a : b;
64 }
65
66 /**
67 * Creates a {@link BinaryOperator} for this instance that throws {@link UncheckedIOException} instead of
68 * {@link IOException}.
69 *
70 * @return an unchecked BiFunction.
71 */
72 default BinaryOperator<T> asBinaryOperator() {
73 return (t, u) -> Uncheck.apply(this, t, u);
74 }
75 }