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
The following commit(s) were added to refs/heads/master by this push:
new 93228b3 Add UncheckedFilterInputStream.
93228b3 is described below
commit 93228b37d348f8aecebcabb64228eb41bd1d9947
Author: Gary Gregory <[email protected]>
AuthorDate: Mon Jul 12 13:57:14 2021 -0400
Add UncheckedFilterInputStream.
---
src/changes/changes.xml | 3 +
.../io/input/UncheckedFilterInputStream.java | 146 +++++++++++++++++++++
.../io/input/UncheckedFilterInputStreamTest.java | 144 ++++++++++++++++++++
3 files changed, 293 insertions(+)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 94de675..7d7a78e 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -66,6 +66,9 @@ The <action> type attribute can be add,update,fix,remove.
<action dev="ggregory" type="add" due-to="Gary Gregory">
Add StringInputStream.
</action>
+ <action dev="ggregory" type="add" due-to="Gary Gregory">
+ Add UncheckedFilterInputStream.
+ </action>
<!-- UPDATE -->
<action dev="ggregory" type="update" due-to="Dependabot">
Bump Maven Javadoc plugin from 3.2.0 to 3.3.0.
diff --git
a/src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java
b/src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java
new file mode 100644
index 0000000..85f3d6c
--- /dev/null
+++ b/src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java
@@ -0,0 +1,146 @@
+/*
+ * 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.input;
+
+import java.io.BufferedReader;
+import java.io.FilterInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.UncheckedIOException;
+
+/**
+ * A {@link BufferedReader} that throws {@link UncheckedIOException} instead
of {@link IOException}.
+ *
+ * @see BufferedReader
+ * @see IOException
+ * @see UncheckedIOException
+ * @since 2.12.0
+ */
+public class UncheckedFilterInputStream extends FilterInputStream {
+
+ /**
+ * Creates a {@code UncheckedFilterInputStream}.
+ *
+ * @param inputStream the underlying input stream, or {@code null} if this
instance is to be created without an
+ * underlying stream.
+ * @return a new UncheckedFilterInputStream.
+ */
+ public static UncheckedFilterInputStream on(final InputStream inputStream)
{
+ return new UncheckedFilterInputStream(inputStream);
+ }
+
+ /**
+ * Creates a {@code UncheckedFilterInputStream}.
+ *
+ * @param inputStream the underlying input stream, or {@code null} if this
instance is to be created without an
+ * underlying stream.
+ */
+ public UncheckedFilterInputStream(final InputStream inputStream) {
+ super(inputStream);
+ }
+
+ /**
+ * Calls this method's super and rethrow {@link IOException} as {@link
UncheckedIOException}.
+ */
+ @Override
+ public int available() throws UncheckedIOException {
+ try {
+ return super.available();
+ } catch (final IOException e) {
+ throw uncheck(e);
+ }
+ }
+
+ /**
+ * Calls this method's super and rethrow {@link IOException} as {@link
UncheckedIOException}.
+ */
+ @Override
+ public void close() throws UncheckedIOException {
+ try {
+ super.close();
+ } catch (final IOException e) {
+ throw uncheck(e);
+ }
+ }
+
+ /**
+ * Calls this method's super and rethrow {@link IOException} as {@link
UncheckedIOException}.
+ */
+ @Override
+ public int read() throws UncheckedIOException {
+ try {
+ return super.read();
+ } catch (final IOException e) {
+ throw uncheck(e);
+ }
+ }
+
+ /**
+ * Calls this method's super and rethrow {@link IOException} as {@link
UncheckedIOException}.
+ */
+ @Override
+ public int read(final byte[] b) throws UncheckedIOException {
+ try {
+ return super.read(b);
+ } catch (final IOException e) {
+ throw uncheck(e);
+ }
+ }
+
+ /**
+ * Calls this method's super and rethrow {@link IOException} as {@link
UncheckedIOException}.
+ */
+ @Override
+ public int read(final byte[] b, final int off, final int len) throws
UncheckedIOException {
+ try {
+ return super.read(b, off, len);
+ } catch (final IOException e) {
+ throw uncheck(e);
+ }
+ }
+
+ /**
+ * Calls this method's super and rethrow {@link IOException} as {@link
UncheckedIOException}.
+ */
+ @Override
+ public synchronized void reset() throws UncheckedIOException {
+ try {
+ super.reset();
+ } catch (final IOException e) {
+ throw uncheck(e);
+ }
+ }
+
+ /**
+ * Calls this method's super and rethrow {@link IOException} as {@link
UncheckedIOException}.
+ */
+ @Override
+ public long skip(final long n) throws UncheckedIOException {
+ try {
+ return super.skip(n);
+ } catch (final IOException e) {
+ throw uncheck(e);
+ }
+ }
+
+ private UncheckedIOException uncheck(final IOException e) {
+ return new UncheckedIOException(e);
+ }
+
+}
diff --git
a/src/test/java/org/apache/commons/io/input/UncheckedFilterInputStreamTest.java
b/src/test/java/org/apache/commons/io/input/UncheckedFilterInputStreamTest.java
new file mode 100644
index 0000000..b518c67
--- /dev/null
+++
b/src/test/java/org/apache/commons/io/input/UncheckedFilterInputStreamTest.java
@@ -0,0 +1,144 @@
+/*
+ * 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.input;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+import java.io.BufferedInputStream;
+import java.io.IOException;
+import java.io.UncheckedIOException;
+
+import org.apache.commons.io.IOUtils;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Tests {@link UncheckedFilterInputStream}.
+ */
+public class UncheckedFilterInputStreamTest {
+
+ private UncheckedFilterInputStream stringInputStream;
+ private UncheckedFilterInputStream brokenInputStream;
+ private IOException exception = new IOException("test exception");
+
+ @SuppressWarnings("resource")
+ @BeforeEach
+ public void beforeEach() {
+ stringInputStream = UncheckedFilterInputStream.on(new
BufferedInputStream(new StringInputStream("01")));
+ exception = new IOException("test exception");
+ brokenInputStream = UncheckedFilterInputStream.on(new
BrokenInputStream(exception));
+ }
+
+ @Test
+ public void testClose() {
+ stringInputStream.close();
+ assertThrows(UncheckedIOException.class, () ->
brokenInputStream.read());
+ }
+
+ @Test
+ public void testCloseThrows() {
+ assertEquals(exception, assertThrows(UncheckedIOException.class, () ->
brokenInputStream.close()).getCause());
+ }
+
+ @Test
+ public void testMarkReset() {
+ stringInputStream.mark(10);
+ final int c = stringInputStream.read();
+ stringInputStream.reset();
+ assertEquals(c, stringInputStream.read());
+ }
+
+ @Test
+ public void testRead() {
+ try (final UncheckedFilterInputStream uncheckedReader =
UncheckedFilterInputStream.on(stringInputStream)) {
+ assertEquals('0', uncheckedReader.read());
+ assertEquals('1', uncheckedReader.read());
+ assertEquals(IOUtils.EOF, uncheckedReader.read());
+ assertEquals(IOUtils.EOF, uncheckedReader.read());
+ }
+ }
+
+ @Test
+ public void testReadByteArray() {
+ try (final UncheckedFilterInputStream uncheckedReader =
UncheckedFilterInputStream.on(stringInputStream)) {
+ final byte[] array = new byte[1];
+ assertEquals(1, uncheckedReader.read(array));
+ assertEquals('0', array[0]);
+ array[0] = 0;
+ assertEquals(1, uncheckedReader.read(array));
+ assertEquals('1', array[0]);
+ array[0] = 0;
+ assertEquals(IOUtils.EOF, uncheckedReader.read(array));
+ assertEquals(0, array[0]);
+ assertEquals(IOUtils.EOF, uncheckedReader.read(array));
+ assertEquals(0, array[0]);
+ }
+ }
+
+ @Test
+ public void testReadByteArrayIndexed() {
+ try (final UncheckedFilterInputStream uncheckedReader =
UncheckedFilterInputStream.on(stringInputStream)) {
+ final byte[] array = new byte[1];
+ assertEquals(1, uncheckedReader.read(array, 0, 1));
+ assertEquals('0', array[0]);
+ array[0] = 0;
+ assertEquals(1, uncheckedReader.read(array, 0, 1));
+ assertEquals('1', array[0]);
+ array[0] = 0;
+ assertEquals(IOUtils.EOF, uncheckedReader.read(array, 0, 1));
+ assertEquals(0, array[0]);
+ assertEquals(IOUtils.EOF, uncheckedReader.read(array, 0, 1));
+ assertEquals(0, array[0]);
+ }
+ }
+
+ @Test
+ public void testReadByteArrayIndexedThrows() {
+ assertEquals(exception, assertThrows(UncheckedIOException.class, () ->
brokenInputStream.read(new byte[1], 0, 1)).getCause());
+ }
+
+ @Test
+ public void testReadByteArrayThrows() {
+ assertEquals(exception, assertThrows(UncheckedIOException.class, () ->
brokenInputStream.read(new byte[1])).getCause());
+ }
+
+ @Test
+ public void testReadThrows() {
+ assertEquals(exception, assertThrows(UncheckedIOException.class, () ->
brokenInputStream.read()).getCause());
+ }
+
+ @Test
+ public void testResetThrows() {
+ try (UncheckedFilterInputStream closedReader =
UncheckedFilterInputStream.on(ClosedInputStream.CLOSED_INPUT_STREAM)) {
+ closedReader.close();
+ assertThrows(UncheckedIOException.class, () ->
brokenInputStream.reset());
+ }
+ }
+
+ @Test
+ public void testSkip() {
+ assertEquals(1, stringInputStream.skip(1));
+ }
+
+ @Test
+ public void testSkipThrows() {
+ assertEquals(exception, assertThrows(UncheckedIOException.class, () ->
brokenInputStream.skip(1)).getCause());
+ }
+
+}
