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 6a65e0d Add ClosedReader.INSTANCE and deprecate CLOSED_READER.
6a65e0d is described below
commit 6a65e0d93c86b1b1ba2e7d642687311a30a26589
Author: Gary Gregory <gardgreg...@gmail.com>
AuthorDate: Mon Jul 12 14:28:04 2021 -0400
Add ClosedReader.INSTANCE and deprecate CLOSED_READER.
---
src/changes/changes.xml | 3 +++
.../org/apache/commons/io/input/CloseShieldReader.java | 2 +-
.../java/org/apache/commons/io/input/ClosedReader.java | 18 ++++++++++++++----
.../org/apache/commons/io/input/TaggedReaderTest.java | 4 ++--
.../commons/io/input/UncheckedBufferedReaderTest.java | 4 ++--
.../commons/io/input/UncheckedFilterReaderTest.java | 4 ++--
6 files changed, 24 insertions(+), 11 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 793132b..4859f43 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -75,6 +75,9 @@ The <action> type attribute can be add,update,fix,remove.
<action dev="ggregory" type="add" due-to="Gary Gregory">
Add ClosedInputStream.INSTANCE and deprecate CLOSED_INPUT_STREAM.
</action>
+ <action dev="ggregory" type="add" due-to="Gary Gregory">
+ Add ClosedReader.INSTANCE and deprecate CLOSED_READER.
+ </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/CloseShieldReader.java
b/src/main/java/org/apache/commons/io/input/CloseShieldReader.java
index 51b1268..375ae20 100644
--- a/src/main/java/org/apache/commons/io/input/CloseShieldReader.java
+++ b/src/main/java/org/apache/commons/io/input/CloseShieldReader.java
@@ -60,7 +60,7 @@ public class CloseShieldReader extends ProxyReader {
*/
@Override
public void close() {
- in = ClosedReader.CLOSED_READER;
+ in = ClosedReader.INSTANCE;
}
}
diff --git a/src/main/java/org/apache/commons/io/input/ClosedReader.java
b/src/main/java/org/apache/commons/io/input/ClosedReader.java
index dc906b8..2a0234c 100644
--- a/src/main/java/org/apache/commons/io/input/ClosedReader.java
+++ b/src/main/java/org/apache/commons/io/input/ClosedReader.java
@@ -33,16 +33,26 @@ import java.io.Reader;
public class ClosedReader extends Reader {
/**
- * A singleton.
+ * The singleton instance.
+ *
+ * @since 2.12.0
+ */
+ public static final ClosedReader INSTANCE = new ClosedReader();
+
+ /**
+ * The singleton instance.
+ *
+ * @deprecated {@link #INSTANCE}.
*/
- public static final ClosedReader CLOSED_READER = new ClosedReader();
+ @Deprecated
+ public static final ClosedReader CLOSED_READER = INSTANCE;
/**
* Returns -1 to indicate that the stream is closed.
*
* @param cbuf ignored
- * @param off ignored
- * @param len ignored
+ * @param off ignored
+ * @param len ignored
* @return always -1
*/
@Override
diff --git a/src/test/java/org/apache/commons/io/input/TaggedReaderTest.java
b/src/test/java/org/apache/commons/io/input/TaggedReaderTest.java
index d4e97fb..4106bed 100644
--- a/src/test/java/org/apache/commons/io/input/TaggedReaderTest.java
+++ b/src/test/java/org/apache/commons/io/input/TaggedReaderTest.java
@@ -36,7 +36,7 @@ public class TaggedReaderTest {
@Test
public void testEmptyReader() throws IOException {
- try (final Reader reader = new
TaggedReader(ClosedReader.CLOSED_READER)) {
+ try (final Reader reader = new TaggedReader(ClosedReader.INSTANCE)) {
assertFalse(reader.ready());
assertEquals(-1, reader.read());
assertEquals(-1, reader.read(new char[1]));
@@ -109,7 +109,7 @@ public class TaggedReaderTest {
@Test
public void testOtherException() throws Exception {
final IOException exception = new IOException("test exception");
- try (final TaggedReader reader = new
TaggedReader(ClosedReader.CLOSED_READER)) {
+ try (final TaggedReader reader = new
TaggedReader(ClosedReader.INSTANCE)) {
assertFalse(reader.isCauseOf(exception));
assertFalse(reader.isCauseOf(new TaggedIOException(exception,
UUID.randomUUID())));
diff --git
a/src/test/java/org/apache/commons/io/input/UncheckedBufferedReaderTest.java
b/src/test/java/org/apache/commons/io/input/UncheckedBufferedReaderTest.java
index ce1ff7f..7c01427 100644
--- a/src/test/java/org/apache/commons/io/input/UncheckedBufferedReaderTest.java
+++ b/src/test/java/org/apache/commons/io/input/UncheckedBufferedReaderTest.java
@@ -74,7 +74,7 @@ public class UncheckedBufferedReaderTest {
@Test
public void testMarkThrows() {
- try (UncheckedBufferedReader closedReader =
UncheckedBufferedReader.on(ClosedReader.CLOSED_READER)) {
+ try (UncheckedBufferedReader closedReader =
UncheckedBufferedReader.on(ClosedReader.INSTANCE)) {
closedReader.close();
assertThrows(UncheckedIOException.class, () ->
closedReader.mark(1));
}
@@ -191,7 +191,7 @@ public class UncheckedBufferedReaderTest {
@Test
public void testResetThrows() {
- try (UncheckedBufferedReader closedReader =
UncheckedBufferedReader.on(ClosedReader.CLOSED_READER)) {
+ try (UncheckedBufferedReader closedReader =
UncheckedBufferedReader.on(ClosedReader.INSTANCE)) {
closedReader.close();
assertThrows(UncheckedIOException.class, () ->
ucBrokenReader.reset());
}
diff --git
a/src/test/java/org/apache/commons/io/input/UncheckedFilterReaderTest.java
b/src/test/java/org/apache/commons/io/input/UncheckedFilterReaderTest.java
index 55f2b00..a1ffed6 100644
--- a/src/test/java/org/apache/commons/io/input/UncheckedFilterReaderTest.java
+++ b/src/test/java/org/apache/commons/io/input/UncheckedFilterReaderTest.java
@@ -67,7 +67,7 @@ public class UncheckedFilterReaderTest {
@Test
public void testMarkThrows() {
- try (UncheckedFilterReader closedReader =
UncheckedFilterReader.on(ClosedReader.CLOSED_READER)) {
+ try (UncheckedFilterReader closedReader =
UncheckedFilterReader.on(ClosedReader.INSTANCE)) {
closedReader.close();
assertThrows(UncheckedIOException.class, () ->
closedReader.mark(1));
}
@@ -170,7 +170,7 @@ public class UncheckedFilterReaderTest {
@Test
public void testResetThrows() {
- try (UncheckedFilterReader closedReader =
UncheckedFilterReader.on(ClosedReader.CLOSED_READER)) {
+ try (UncheckedFilterReader closedReader =
UncheckedFilterReader.on(ClosedReader.INSTANCE)) {
closedReader.close();
assertThrows(UncheckedIOException.class, () ->
ucBrokenReader.reset());
}
