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.Comparator;
23
24 /**
25 * Like {@link Comparator} but throws {@link IOException}.
26 *
27 * @param <T> the type of objects that may be compared by this comparator
28 *
29 * @see Comparator
30 * @since 2.12.0
31 */
32 @FunctionalInterface
33 public interface IOComparator<T> {
34
35 /**
36 * Creates a {@link Comparator} for this instance that throws {@link UncheckedIOException} instead of
37 * {@link IOException}.
38 *
39 * @return an UncheckedIOException BiFunction.
40 */
41 default Comparator<T> asComparator() {
42 return (t, u) -> Uncheck.compare(this, t, u);
43 }
44
45 /**
46 * Like {@link Comparator#compare(Object, Object)} but throws {@link IOException}.
47 *
48 * @param o1 the first object to be compared.
49 * @param o2 the second object to be compared.
50 * @return a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than
51 * the second.
52 * @throws NullPointerException if an argument is null and this comparator does not permit null arguments
53 * @throws ClassCastException if the arguments' types prevent them from being compared by this comparator.
54 * @throws IOException if an I/O error occurs.
55 */
56 int compare(T o1, T o2) throws IOException;
57 }