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 ac5b3bb Add NullOutputStream.INSTANCE and deprecate
NULL_OUTPUT_STREAM.
ac5b3bb is described below
commit ac5b3bbedaf6890cef4a81c50c6ecfa22c945300
Author: Gary Gregory <[email protected]>
AuthorDate: Mon Jul 12 14:50:03 2021 -0400
Add NullOutputStream.INSTANCE and deprecate NULL_OUTPUT_STREAM.
---
src/changes/changes.xml | 3 +++
src/main/java/org/apache/commons/io/IOUtils.java | 2 +-
.../org/apache/commons/io/output/NullOutputStream.java | 14 ++++++++++++--
.../java/org/apache/commons/io/output/NullPrintStream.java | 2 +-
.../apache/commons/io/output/ThresholdingOutputStream.java | 2 +-
.../java/org/apache/commons/io/IOUtilsCopyTestCase.java | 2 +-
src/test/java/org/apache/commons/io/IOUtilsTestCase.java | 2 +-
.../apache/commons/io/input/ObservableInputStreamTest.java | 2 +-
.../apache/commons/io/output/CountingOutputStreamTest.java | 2 +-
.../org/apache/commons/io/output/NullOutputStreamTest.java | 4 ++--
.../apache/commons/io/test/ThrowOnCloseOutputStream.java | 2 +-
11 files changed, 25 insertions(+), 12 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index be6b6af..f690430 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -87,6 +87,9 @@ The <action> type attribute can be add,update,fix,remove.
<action dev="ggregory" type="add" due-to="Gary Gregory">
Add ClosedWriter.INSTANCE and deprecate CLOSED_WRITER.
</action>
+ <action dev="ggregory" type="add" due-to="Gary Gregory">
+ Add NullOutputStream.INSTANCE and deprecate NULL_OUTPUT_STREAM.
+ </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/IOUtils.java
b/src/main/java/org/apache/commons/io/IOUtils.java
index 1bfdf69..e41225a 100644
--- a/src/main/java/org/apache/commons/io/IOUtils.java
+++ b/src/main/java/org/apache/commons/io/IOUtils.java
@@ -772,7 +772,7 @@ public class IOUtils {
*/
public static long consume(final InputStream input)
throws IOException {
- return copyLarge(input, NullOutputStream.NULL_OUTPUT_STREAM,
getByteArray());
+ return copyLarge(input, NullOutputStream.INSTANCE, getByteArray());
}
/**
diff --git a/src/main/java/org/apache/commons/io/output/NullOutputStream.java
b/src/main/java/org/apache/commons/io/output/NullOutputStream.java
index ee0579b..6678b63 100644
--- a/src/main/java/org/apache/commons/io/output/NullOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/NullOutputStream.java
@@ -39,9 +39,19 @@ public class NullOutputStream extends OutputStream {
}
/**
- * The singleton.
+ * The singleton instance.
+ *
+ * @since 2.12.0
+ */
+ public static final NullOutputStream INSTANCE = new NullOutputStream();
+
+ /**
+ * The singleton instance.
+ *
+ * @deprecated Use {@link #INSTANCE}.
*/
- public static final NullOutputStream NULL_OUTPUT_STREAM = new
NullOutputStream();
+ @Deprecated
+ public static final NullOutputStream NULL_OUTPUT_STREAM = INSTANCE;
/**
* Does nothing - output to {@code /dev/null}.
diff --git a/src/main/java/org/apache/commons/io/output/NullPrintStream.java
b/src/main/java/org/apache/commons/io/output/NullPrintStream.java
index c916584..8f833c9 100644
--- a/src/main/java/org/apache/commons/io/output/NullPrintStream.java
+++ b/src/main/java/org/apache/commons/io/output/NullPrintStream.java
@@ -39,7 +39,7 @@ public class NullPrintStream extends PrintStream {
*/
public NullPrintStream() {
// Relies on the default charset which is OK since we are not actually
writing.
- super(NullOutputStream.NULL_OUTPUT_STREAM);
+ super(NullOutputStream.INSTANCE);
}
}
diff --git
a/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java
b/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java
index 4791f8e..3992d9c 100644
--- a/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java
@@ -40,7 +40,7 @@ public class ThresholdingOutputStream extends OutputStream {
/**
* Noop output stream getter function.
*/
- private static final IOFunction<ThresholdingOutputStream, OutputStream>
NOOP_OS_GETTER = os -> NullOutputStream.NULL_OUTPUT_STREAM;
+ private static final IOFunction<ThresholdingOutputStream, OutputStream>
NOOP_OS_GETTER = os -> NullOutputStream.INSTANCE;
/**
* The threshold at which the event will be triggered.
diff --git a/src/test/java/org/apache/commons/io/IOUtilsCopyTestCase.java
b/src/test/java/org/apache/commons/io/IOUtilsCopyTestCase.java
index 0452e34..2be2e29 100644
--- a/src/test/java/org/apache/commons/io/IOUtilsCopyTestCase.java
+++ b/src/test/java/org/apache/commons/io/IOUtilsCopyTestCase.java
@@ -87,7 +87,7 @@ public class IOUtilsCopyTestCase {
public void testCopy_inputStreamToOutputStream_IO84() throws Exception {
final long size = (long)Integer.MAX_VALUE + (long)1;
final InputStream in = new NullInputStream(size);
- final OutputStream out = NullOutputStream.NULL_OUTPUT_STREAM;
+ final OutputStream out = NullOutputStream.INSTANCE;
// Test copy() method
assertEquals(-1, IOUtils.copy(in, out));
diff --git a/src/test/java/org/apache/commons/io/IOUtilsTestCase.java
b/src/test/java/org/apache/commons/io/IOUtilsTestCase.java
index 1c59ded..9e61e0d 100644
--- a/src/test/java/org/apache/commons/io/IOUtilsTestCase.java
+++ b/src/test/java/org/apache/commons/io/IOUtilsTestCase.java
@@ -500,7 +500,7 @@ public class IOUtilsTestCase {
public void testConsume() throws Exception {
final long size = (long) Integer.MAX_VALUE + (long) 1;
final InputStream in = new NullInputStream(size);
- final OutputStream out = NullOutputStream.NULL_OUTPUT_STREAM;
+ final OutputStream out = NullOutputStream.INSTANCE;
// Test copy() method
assertEquals(-1, IOUtils.copy(in, out));
diff --git
a/src/test/java/org/apache/commons/io/input/ObservableInputStreamTest.java
b/src/test/java/org/apache/commons/io/input/ObservableInputStreamTest.java
index 30d63ed..f01618d 100644
--- a/src/test/java/org/apache/commons/io/input/ObservableInputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/input/ObservableInputStreamTest.java
@@ -283,7 +283,7 @@ public class ObservableInputStreamTest {
try (final ObservableInputStream ois = new ObservableInputStream(new
ByteArrayInputStream(buffer),
lengthObserver, methodCountObserver)) {
assertEquals(IOUtils.DEFAULT_BUFFER_SIZE,
- IOUtils.copy(ois, NullOutputStream.NULL_OUTPUT_STREAM,
bufferSize));
+ IOUtils.copy(ois, NullOutputStream.INSTANCE, bufferSize));
}
assertEquals(IOUtils.DEFAULT_BUFFER_SIZE, lengthObserver.getTotal());
assertEquals(1, methodCountObserver.getClosedCount());
diff --git
a/src/test/java/org/apache/commons/io/output/CountingOutputStreamTest.java
b/src/test/java/org/apache/commons/io/output/CountingOutputStreamTest.java
index f670851..bfc242d 100644
--- a/src/test/java/org/apache/commons/io/output/CountingOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/CountingOutputStreamTest.java
@@ -76,7 +76,7 @@ public class CountingOutputStreamTest {
final long size = (long) Integer.MAX_VALUE + (long) 1;
final NullInputStream mock = new NullInputStream(size);
- final CountingOutputStream cos = new
CountingOutputStream(NullOutputStream.NULL_OUTPUT_STREAM);
+ final CountingOutputStream cos = new
CountingOutputStream(NullOutputStream.INSTANCE);
// Test integer methods
IOUtils.copyLarge(mock, cos);
diff --git
a/src/test/java/org/apache/commons/io/output/NullOutputStreamTest.java
b/src/test/java/org/apache/commons/io/output/NullOutputStreamTest.java
index fc3a1a6..052c7b2 100644
--- a/src/test/java/org/apache/commons/io/output/NullOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/NullOutputStreamTest.java
@@ -40,14 +40,14 @@ public class NullOutputStreamTest {
@Test
public void testNewInstance() throws IOException {
- try (final NullOutputStream nos = NullOutputStream.NULL_OUTPUT_STREAM)
{
+ try (final NullOutputStream nos = NullOutputStream.INSTANCE) {
process(nos);
}
}
@Test
public void testSingleton() throws IOException {
- try (final NullOutputStream nos = NullOutputStream.NULL_OUTPUT_STREAM)
{
+ try (final NullOutputStream nos = NullOutputStream.INSTANCE) {
process(nos);
}
}
diff --git
a/src/test/java/org/apache/commons/io/test/ThrowOnCloseOutputStream.java
b/src/test/java/org/apache/commons/io/test/ThrowOnCloseOutputStream.java
index 949bd4b..a28702d 100644
--- a/src/test/java/org/apache/commons/io/test/ThrowOnCloseOutputStream.java
+++ b/src/test/java/org/apache/commons/io/test/ThrowOnCloseOutputStream.java
@@ -31,7 +31,7 @@ public class ThrowOnCloseOutputStream extends
ProxyOutputStream {
* Default ctor.
*/
public ThrowOnCloseOutputStream() {
- super(NullOutputStream.NULL_OUTPUT_STREAM);
+ super(NullOutputStream.INSTANCE);
}
/**
