You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2021/07/11 14:28:29 UTC
[commons-io] 01/02: Add UncheckedBufferedReader.
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 e3a960c1ce98dcaebef1ca42ce79001608fdeef8
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Jul 11 10:27:54 2021 -0400
Add UncheckedBufferedReader.
---
src/changes/changes.xml | 3 +
.../commons/io/input/UncheckedBufferedReader.java | 188 ++++++++++++++++++
.../io/input/UncheckedBufferedReaderTest.java | 210 +++++++++++++++++++++
3 files changed, 401 insertions(+)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index ebb472e..aa80316 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -54,6 +54,9 @@ The <action> type attribute can be add,update,fix,remove.
<action dev="ggregory" type="add" due-to="Gary Gregory">
Add BrokenReader.INSTANCE.
</action>
+ <action dev="ggregory" type="add" due-to="Gary Gregory">
+ Add UncheckedBufferedReader.
+ </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/UncheckedBufferedReader.java b/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java
new file mode 100644
index 0000000..8aebc2a
--- /dev/null
+++ b/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java
@@ -0,0 +1,188 @@
+/*
+ * 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.IOException;
+import java.io.Reader;
+import java.io.UncheckedIOException;
+import java.nio.CharBuffer;
+
+/**
+ * A {@link BufferedReader} that throws {@link UncheckedIOException} instead of {@link IOException}.
+ *
+ * @see BufferedReader
+ * @see IOException
+ * @see UncheckedIOException
+ * @since 2.12.0
+ */
+public class UncheckedBufferedReader extends BufferedReader {
+
+ /**
+ * Creates a new buffered reader.
+ *
+ * @param reader a Reader object providing the underlying stream.
+ * @return a new UncheckedBufferedReader.
+ * @throws NullPointerException if {@code reader} is {@code null}.
+ */
+ public static UncheckedBufferedReader on(final Reader reader) {
+ return new UncheckedBufferedReader(reader);
+ }
+
+ /**
+ * Creates a buffering character-input stream that uses a default-sized input buffer.
+ *
+ * @param reader A Reader
+ */
+ public UncheckedBufferedReader(final Reader reader) {
+ super(reader);
+ }
+
+ /**
+ * Creates a buffering character-input stream that uses an input buffer of the specified size.
+ *
+ * @param reader A Reader
+ * @param bufferSize Input-buffer size
+ *
+ * @exception IllegalArgumentException If {@code bufferSize <= 0}
+ */
+ public UncheckedBufferedReader(final Reader reader, final int bufferSize) {
+ super(reader, bufferSize);
+ }
+
+ /**
+ * 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 new UncheckedIOException(e);
+ }
+ }
+
+ /**
+ * Calls this method's super and rethrow {@link IOException} as {@link UncheckedIOException}.
+ */
+ @Override
+ public void mark(final int readAheadLimit) throws UncheckedIOException {
+ try {
+ super.mark(readAheadLimit);
+ } catch (final IOException e) {
+ throw new UncheckedIOException(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 new UncheckedIOException(e);
+ }
+ }
+
+ /**
+ * Calls this method's super and rethrow {@link IOException} as {@link UncheckedIOException}.
+ */
+ @Override
+ public int read(final char[] cbuf) throws UncheckedIOException {
+ try {
+ return super.read(cbuf);
+ } catch (final IOException e) {
+ throw new UncheckedIOException(e);
+ }
+ }
+
+ /**
+ * Calls this method's super and rethrow {@link IOException} as {@link UncheckedIOException}.
+ */
+ @Override
+ public int read(final char[] cbuf, final int off, final int len) throws UncheckedIOException {
+ try {
+ return super.read(cbuf, off, len);
+ } catch (final IOException e) {
+ throw new UncheckedIOException(e);
+ }
+ }
+
+ /**
+ * Calls this method's super and rethrow {@link IOException} as {@link UncheckedIOException}.
+ */
+ @Override
+ public int read(final CharBuffer target) throws UncheckedIOException {
+ try {
+ return super.read(target);
+ } catch (final IOException e) {
+ throw new UncheckedIOException(e);
+ }
+ }
+
+ /**
+ * Calls this method's super and rethrow {@link IOException} as {@link UncheckedIOException}.
+ */
+ @Override
+ public String readLine() throws UncheckedIOException {
+ try {
+ return super.readLine();
+ } catch (final IOException e) {
+ throw new UncheckedIOException(e);
+ }
+ }
+
+ /**
+ * Calls this method's super and rethrow {@link IOException} as {@link UncheckedIOException}.
+ */
+ @Override
+ public boolean ready() throws UncheckedIOException {
+ try {
+ return super.ready();
+ } catch (final IOException e) {
+ throw new UncheckedIOException(e);
+ }
+ }
+
+ /**
+ * Calls this method's super and rethrow {@link IOException} as {@link UncheckedIOException}.
+ */
+ @Override
+ public void reset() throws UncheckedIOException {
+ try {
+ super.reset();
+ } catch (final IOException e) {
+ throw new UncheckedIOException(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 new UncheckedIOException(e);
+ }
+ }
+
+}
diff --git a/src/test/java/org/apache/commons/io/input/UncheckedBufferedReaderTest.java b/src/test/java/org/apache/commons/io/input/UncheckedBufferedReaderTest.java
new file mode 100644
index 0000000..ce1ff7f
--- /dev/null
+++ b/src/test/java/org/apache/commons/io/input/UncheckedBufferedReaderTest.java
@@ -0,0 +1,210 @@
+/*
+ * 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 static org.junit.jupiter.api.Assertions.assertTrue;
+
+import java.io.IOException;
+import java.io.StringReader;
+import java.io.UncheckedIOException;
+import java.nio.CharBuffer;
+
+import org.apache.commons.io.IOUtils;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Tests {@link UncheckedFilterReader}.
+ */
+public class UncheckedBufferedReaderTest {
+
+ private UncheckedBufferedReader ucStringReader;
+ private UncheckedBufferedReader ucBrokenReader;
+ private IOException exception = new IOException("test exception");
+
+ @SuppressWarnings("resource")
+ @BeforeEach
+ public void beforeEach() {
+ ucStringReader = UncheckedBufferedReader.on(new StringReader("01"));
+ exception = new IOException("test exception");
+ ucBrokenReader = UncheckedBufferedReader.on(new BrokenReader(exception));
+ }
+
+ @Test
+ public void testBufferSize() {
+ try (UncheckedBufferedReader uncheckedReader = new UncheckedBufferedReader(new StringReader("0123456789"), 2)) {
+ assertEquals('0', uncheckedReader.read());
+ }
+ }
+
+ @Test
+ public void testClose() {
+ ucStringReader.close();
+ assertThrows(UncheckedIOException.class, () -> ucBrokenReader.read());
+ }
+
+ @Test
+ public void testCloseThrows() {
+ assertEquals(exception, assertThrows(UncheckedIOException.class, () -> ucBrokenReader.close()).getCause());
+ }
+
+ @Test
+ public void testMarkReset() {
+ ucStringReader.mark(10);
+ final int c = ucStringReader.read();
+ ucStringReader.reset();
+ assertEquals(c, ucStringReader.read());
+ }
+
+ @Test
+ public void testMarkThrows() {
+ try (UncheckedBufferedReader closedReader = UncheckedBufferedReader.on(ClosedReader.CLOSED_READER)) {
+ closedReader.close();
+ assertThrows(UncheckedIOException.class, () -> closedReader.mark(1));
+ }
+ }
+
+ @Test
+ public void testRead() {
+ try (final UncheckedBufferedReader uncheckedReader = UncheckedBufferedReader.on(ucStringReader)) {
+ assertEquals('0', uncheckedReader.read());
+ assertEquals('1', uncheckedReader.read());
+ assertEquals(IOUtils.EOF, uncheckedReader.read());
+ assertEquals(IOUtils.EOF, uncheckedReader.read());
+ }
+ }
+
+ @Test
+ public void testReadCharArray() {
+ try (final UncheckedBufferedReader uncheckedReader = UncheckedBufferedReader.on(ucStringReader)) {
+ final char[] array = new char[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 testReadCharArrayIndexed() {
+ try (final UncheckedBufferedReader uncheckedReader = UncheckedBufferedReader.on(ucStringReader)) {
+ final char[] array = new char[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 testReadCharArrayIndexedThrows() {
+ assertEquals(exception, assertThrows(UncheckedIOException.class, () -> ucBrokenReader.read(new char[1], 0, 1)).getCause());
+ }
+
+ @Test
+ public void testReadCharArrayThrows() {
+ assertEquals(exception, assertThrows(UncheckedIOException.class, () -> ucBrokenReader.read(new char[1])).getCause());
+ }
+
+ @Test
+ public void testReadCharBuffer() {
+ try (final UncheckedBufferedReader uncheckedReader = UncheckedBufferedReader.on(ucStringReader)) {
+ final CharBuffer buffer = CharBuffer.wrap(new char[1]);
+ assertEquals(1, uncheckedReader.read(buffer));
+ buffer.flip();
+ assertEquals('0', buffer.charAt(0));
+ buffer.put(0, (char) 0);
+ assertEquals(1, uncheckedReader.read(buffer));
+ buffer.flip();
+ assertEquals('1', buffer.charAt(0));
+ buffer.put(0, (char) 0);
+ assertEquals(IOUtils.EOF, uncheckedReader.read(buffer));
+ buffer.flip();
+ assertEquals(0, buffer.length());
+ assertEquals(0, uncheckedReader.read(buffer));
+ buffer.flip();
+ assertEquals(0, buffer.length());
+ }
+ }
+
+ @Test
+ public void testReadCharBufferThrows() {
+ assertEquals(exception, assertThrows(UncheckedIOException.class, () -> ucBrokenReader.read(CharBuffer.wrap(new char[1]))).getCause());
+ }
+
+ @Test
+ public void testReadLine() {
+ try (final UncheckedBufferedReader uncheckedReader = UncheckedBufferedReader.on(ucStringReader)) {
+ assertEquals("01", uncheckedReader.readLine());
+ assertEquals(IOUtils.EOF, uncheckedReader.read());
+ assertEquals(IOUtils.EOF, uncheckedReader.read());
+ }
+ }
+
+ @Test
+ public void testReadLineThrows() {
+ assertEquals(exception, assertThrows(UncheckedIOException.class, () -> ucBrokenReader.readLine()).getCause());
+ }
+
+ @Test
+ public void testReadThrows() {
+ assertEquals(exception, assertThrows(UncheckedIOException.class, () -> ucBrokenReader.read()).getCause());
+ }
+
+ @Test
+ public void testReady() {
+ assertTrue(ucStringReader.ready());
+ }
+
+ @Test
+ public void testReadyThrows() {
+ assertEquals(exception, assertThrows(UncheckedIOException.class, () -> ucBrokenReader.ready()).getCause());
+ }
+
+ @Test
+ public void testResetThrows() {
+ try (UncheckedBufferedReader closedReader = UncheckedBufferedReader.on(ClosedReader.CLOSED_READER)) {
+ closedReader.close();
+ assertThrows(UncheckedIOException.class, () -> ucBrokenReader.reset());
+ }
+ }
+
+ @Test
+ public void testSkip() {
+ assertEquals(1, ucStringReader.skip(1));
+ }
+
+ @Test
+ public void testSkipThrows() {
+ assertEquals(exception, assertThrows(UncheckedIOException.class, () -> ucBrokenReader.skip(1)).getCause());
+ }
+
+}