This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git
commit 4ce3d39b065db87c7b8e9ced1bbf897deec6b4ce
Author: Gary Gregory <gardgreg...@gmail.com>
AuthorDate: Sun Aug 7 22:36:23 2022 -0400
Add IOComparator
---
src/changes/changes.xml | 2 +-
.../apache/commons/io/function/IOComparator.java | 57 ++++++++++++++++++++
.../org/apache/commons/io/function/Uncheck.java | 18 +++++++
.../commons/io/function/IOComparatorTest.java | 63 ++++++++++++++++++++++
.../apache/commons/io/function/TestConstants.java | 28 +++++++---
5 files changed, 159 insertions(+), 9 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index f89b2812..f6c240ae 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -360,7 +360,7 @@ The <action> type attribute can be add,update,fix,remove.
Add IOExceptionList.checkEmpty(List, Object).
</action>
<action dev="ggregory" type="add" due-to="Gary Gregory">
- Add IOBiConsumer, IOTriConsumer.
+ Add IOBiConsumer, IOTriConsumer, IOComparator.
</action>
<action dev="ggregory" type="add" due-to="Gary Gregory">
Add and reuse IOConsumer forAll(*), forEach(*), and forEachIndexed(*).
diff --git a/src/main/java/org/apache/commons/io/function/IOComparator.java
b/src/main/java/org/apache/commons/io/function/IOComparator.java
new file mode 100644
index 00000000..01a5132c
--- /dev/null
+++ b/src/main/java/org/apache/commons/io/function/IOComparator.java
@@ -0,0 +1,57 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.commons.io.function;
+
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.util.Comparator;
+
+/**
+ * Like {@link Comparator} but throws {@link IOException}.
+ *
+ * @param <T> the type of objects that may be compared by this comparator
+ *
+ * @see Comparator
+ * @since 2.12.0
+ */
+@FunctionalInterface
+public interface IOComparator<T> {
+
+ /**
+ * Creates a {@link Comparator} for this instance that throws {@link
UncheckedIOException} instead of
+ * {@link IOException}.
+ *
+ * @return an UncheckedIOException BiFunction.
+ */
+ default Comparator<T> asComparator() {
+ return (t, u) -> Uncheck.compare(this, t, u);
+ }
+
+ /**
+ * Like {@link Comparator#compare(Object, Object)} but throws {@link
IOException}.
+ *
+ * @param o1 the first object to be compared.
+ * @param o2 the second object to be compared.
+ * @return a negative integer, zero, or a positive integer as the first
argument is less than, equal to, or greater than
+ * the second.
+ * @throws NullPointerException if an argument is null and this comparator
does not permit null arguments
+ * @throws ClassCastException if the arguments' types prevent them from
being compared by this comparator.
+ * @throws IOException if an I/O error occurs.
+ */
+ int compare(T o1, T o2) throws IOException;
+}
diff --git a/src/main/java/org/apache/commons/io/function/Uncheck.java
b/src/main/java/org/apache/commons/io/function/Uncheck.java
index 81b3b4ad..89ca0d49 100644
--- a/src/main/java/org/apache/commons/io/function/Uncheck.java
+++ b/src/main/java/org/apache/commons/io/function/Uncheck.java
@@ -165,6 +165,24 @@ public class Uncheck {
}
}
+ /**
+ * Compares the arguments with the comparator.
+ *
+ * @param <T> the first function argument type.
+ * @param comparator the function.
+ * @param t the first function argument.
+ * @param u the second function argument.
+ * @return the comparator result.
+ * @throws UncheckedIOException if an I/O error occurs.
+ */
+ public static <T> int compare(final IOComparator<T> comparator, final T t,
final T u) {
+ try {
+ return comparator.compare(t, u);
+ } catch (final IOException e) {
+ throw wrap(e);
+ }
+ }
+
/**
* Gets the result from an IO supplier.
*
diff --git a/src/test/java/org/apache/commons/io/function/IOComparatorTest.java
b/src/test/java/org/apache/commons/io/function/IOComparatorTest.java
new file mode 100644
index 00000000..b263f5d1
--- /dev/null
+++ b/src/test/java/org/apache/commons/io/function/IOComparatorTest.java
@@ -0,0 +1,63 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.commons.io.function;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+import org.junit.jupiter.api.Test;
+
+/**
+ * Tests {@link IOComparator}.
+ */
+public class IOComparatorTest {
+
+ /** {@link Files#size(Path)} throws IOException */
+ static final IOComparator<Path> PATH_SIZE_COMP = (final Path t, final Path
u) -> Long.compare(Files.size(t), Files.size(u));
+
+ /** {@link Path#toRealPath(java.nio.file.LinkOption...)} throws
IOException */
+ static final IOComparator<Path> REAL_PATH_COMP = (final Path t, final Path
u) -> t.toRealPath().compareTo(u);
+
+ @Test
+ public void testAsComparator() throws IOException {
+ assertEquals(0,
REAL_PATH_COMP.asComparator().compare(TestConstants.ABS_PATH_A,
TestConstants.ABS_PATH_A));
+ assertThrows(UncheckedIOException.class,
+ () ->
TestConstants.THROWING_IO_COMPARATOR.asComparator().compare(TestConstants.ABS_PATH_A,
TestConstants.ABS_PATH_B));
+ }
+
+ @Test
+ public void testCompareLong() throws IOException {
+ assertEquals(0, REAL_PATH_COMP.compare(TestConstants.ABS_PATH_A,
TestConstants.ABS_PATH_A));
+ }
+
+ @Test
+ public void testComparePath() throws IOException {
+ assertEquals(0, PATH_SIZE_COMP.compare(TestConstants.ABS_PATH_A,
TestConstants.ABS_PATH_A));
+ }
+
+ @Test
+ public void testThrowing() throws IOException {
+ assertThrows(IOException.class, () ->
TestConstants.THROWING_IO_COMPARATOR.compare(TestConstants.ABS_PATH_A,
TestConstants.ABS_PATH_B));
+ }
+
+}
diff --git a/src/test/java/org/apache/commons/io/function/TestConstants.java
b/src/test/java/org/apache/commons/io/function/TestConstants.java
index 545e71e3..c361e878 100644
--- a/src/test/java/org/apache/commons/io/function/TestConstants.java
+++ b/src/test/java/org/apache/commons/io/function/TestConstants.java
@@ -19,6 +19,8 @@ package org.apache.commons.io.function;
import java.io.IOException;
import java.io.UncheckedIOException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
import java.util.function.Predicate;
/**
@@ -26,27 +28,33 @@ import java.util.function.Predicate;
*/
class TestConstants {
- static IOConsumer<Object> THROWING_IO_CONSUMER = t -> {
+ static final Path ABS_PATH_A = Paths.get("LICENSE.txt").toAbsolutePath();
+
+ static final Path ABS_PATH_B = Paths.get("NOTICE.txt").toAbsolutePath();
+
+ static IOBiConsumer<Object, Object> THROWING_IO_BI_CONSUMER = (t, u) -> {
throw new IOException("Failure");
};
- static IOFunction<Object, Object> THROWING_IO_FUNCTION = t -> {
+ static IOBiFunction<Object, Object, Object> THROWING_IO_BI_FUNCTION = (t,
u) -> {
throw new IOException("Failure");
};
- static IOBiFunction<Object, Object, Object> THROWING_IO_BI_FUNCTION = (t,
u) -> {
+ static IOComparator<Object> THROWING_IO_COMPARATOR = (t, u) ->
throwIOException();
+
+ static IOConsumer<Object> THROWING_IO_CONSUMER = t -> {
throw new IOException("Failure");
};
- static IOTriFunction<Object, Object, Object, Object>
THROWING_IO_TRI_FUNCTION = (t, u, v) -> {
+ static IOFunction<Object, Object> THROWING_IO_FUNCTION = t -> {
throw new IOException("Failure");
};
- static IOQuadFunction<Object, Object, Object, Object, Object>
THROWING_IO_QUAD_FUNCTION = (t, u, v, w) -> {
+ static IOPredicate<Object> THROWING_IO_PREDICATE = t -> {
throw new IOException("Failure");
};
- static IOSupplier<Object> THROWING_IO_SUPPLIER = () -> {
+ static IOQuadFunction<Object, Object, Object, Object, Object>
THROWING_IO_QUAD_FUNCTION = (t, u, v, w) -> {
throw new IOException("Failure");
};
@@ -54,7 +62,7 @@ class TestConstants {
throw new IOException("Failure");
};
- static IOBiConsumer<Object, Object> THROWING_IO_BI_CONSUMER = (t, u) -> {
+ static IOSupplier<Object> THROWING_IO_SUPPLIER = () -> {
throw new IOException("Failure");
};
@@ -62,7 +70,7 @@ class TestConstants {
throw new IOException("Failure");
};
- static IOPredicate<Object> THROWING_IO_PREDICATE = t -> {
+ static IOTriFunction<Object, Object, Object, Object>
THROWING_IO_TRI_FUNCTION = (t, u, v) -> {
throw new IOException("Failure");
};
@@ -70,4 +78,8 @@ class TestConstants {
throw new UncheckedIOException(new IOException("Failure"));
};
+ private static <T> T throwIOException() throws IOException {
+ throw new IOException("Failure");
+ }
+
}
