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 684c25b32ff67c5a61d00d5eb6439cb89fdbc776 Author: Gary Gregory <gardgreg...@gmail.com> AuthorDate: Thu Oct 10 11:44:06 2019 -0400 [IO-630] Deprecate `org.apache.commons.io.output.NullOutputStream.NullOutputStream()` in favor of `org.apache.commons.io.output.NullOutputStream.NULL_OUTPUT_STREAM`. --- src/changes/changes.xml | 3 +++ src/main/java/org/apache/commons/io/FileUtils.java | 2 +- .../java/org/apache/commons/io/output/NullOutputStream.java | 12 ++++++++++++ .../java/org/apache/commons/io/output/NullPrintStream.java | 3 +-- src/test/java/org/apache/commons/io/IOUtilsCopyTestCase.java | 2 +- .../org/apache/commons/io/input/CountingInputStreamTest.java | 2 +- .../apache/commons/io/output/CountingOutputStreamTest.java | 2 +- .../org/apache/commons/io/output/NullOutputStreamTest.java | 2 +- 8 files changed, 21 insertions(+), 7 deletions(-) diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 82a75b1..ac8815f 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -140,6 +140,9 @@ The <action> type attribute can be add,update,fix,remove. <action issue="IO-628" dev="ggregory" type="update" due-to="Allon Mureinik"> Migration to JUnit Jupiter #97. </action> + <action issue="IO-630" dev="ggregory" type="update" due-to="Gary Gregory"> + Deprecate `org.apache.commons.io.output.NullOutputStream.NullOutputStream()` in favor of `org.apache.commons.io.output.NullOutputStream.NULL_OUTPUT_STREAM`. + </action> </release> <release version="2.6" date="2017-10-15" description="Java 7 required, Java 9 supported."> diff --git a/src/main/java/org/apache/commons/io/FileUtils.java b/src/main/java/org/apache/commons/io/FileUtils.java index 9792a24..def8e93 100644 --- a/src/main/java/org/apache/commons/io/FileUtils.java +++ b/src/main/java/org/apache/commons/io/FileUtils.java @@ -298,7 +298,7 @@ public class FileUtils { throw new IllegalArgumentException("Checksums can't be computed on directories"); } try (InputStream in = new CheckedInputStream(new FileInputStream(file), checksum)) { - IOUtils.copy(in, new NullOutputStream()); + IOUtils.copy(in, NullOutputStream.NULL_OUTPUT_STREAM); } return checksum; } 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 def39ba..89f36f7 100644 --- a/src/main/java/org/apache/commons/io/output/NullOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/NullOutputStream.java @@ -29,6 +29,18 @@ import java.io.OutputStream; public class NullOutputStream extends OutputStream { /** + * Deprecated in favor of {@link #NULL_OUTPUT_STREAM}. + * + * TODO: Will be private in 3.0. + * + * @deprecated Use {@link #NULL_OUTPUT_STREAM}. + */ + @Deprecated + public NullOutputStream() { + super(); + } + + /** * A singleton. */ public static final NullOutputStream NULL_OUTPUT_STREAM = new NullOutputStream(); 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 73d1334..8942a5b 100644 --- a/src/main/java/org/apache/commons/io/output/NullPrintStream.java +++ b/src/main/java/org/apache/commons/io/output/NullPrintStream.java @@ -37,9 +37,8 @@ public class NullPrintStream extends PrintStream { /** * Constructs an instance. */ - @SuppressWarnings("resource") public NullPrintStream() { - super(new NullOutputStream()); + super(NullOutputStream.NULL_OUTPUT_STREAM); } } diff --git a/src/test/java/org/apache/commons/io/IOUtilsCopyTestCase.java b/src/test/java/org/apache/commons/io/IOUtilsCopyTestCase.java index 755e93c..29cf3de 100644 --- a/src/test/java/org/apache/commons/io/IOUtilsCopyTestCase.java +++ b/src/test/java/org/apache/commons/io/IOUtilsCopyTestCase.java @@ -83,7 +83,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 = new NullOutputStream(); + final OutputStream out = NullOutputStream.NULL_OUTPUT_STREAM; // Test copy() method assertEquals(-1, IOUtils.copy(in, out)); diff --git a/src/test/java/org/apache/commons/io/input/CountingInputStreamTest.java b/src/test/java/org/apache/commons/io/input/CountingInputStreamTest.java index 31a4072..c47e3e9 100644 --- a/src/test/java/org/apache/commons/io/input/CountingInputStreamTest.java +++ b/src/test/java/org/apache/commons/io/input/CountingInputStreamTest.java @@ -76,7 +76,7 @@ public class CountingInputStreamTest { final long size = (long)Integer.MAX_VALUE + (long)1; final NullInputStream mock = new NullInputStream(size); final CountingInputStream cis = new CountingInputStream(mock); - final OutputStream out = new NullOutputStream(); + final OutputStream out = NullOutputStream.NULL_OUTPUT_STREAM; // Test integer methods IOUtils.copyLarge(cis, out); 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 b66c046..6885bf9 100644 --- a/src/test/java/org/apache/commons/io/output/CountingOutputStreamTest.java +++ b/src/test/java/org/apache/commons/io/output/CountingOutputStreamTest.java @@ -81,7 +81,7 @@ public class CountingOutputStreamTest { final long size = (long)Integer.MAX_VALUE + (long)1; final NullInputStream mock = new NullInputStream(size); - final OutputStream nos = new NullOutputStream(); + final OutputStream nos = NullOutputStream.NULL_OUTPUT_STREAM; final CountingOutputStream cos = new CountingOutputStream(nos); // Test integer methods 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 868bfe6..fc3a1a6 100644 --- a/src/test/java/org/apache/commons/io/output/NullOutputStreamTest.java +++ b/src/test/java/org/apache/commons/io/output/NullOutputStreamTest.java @@ -40,7 +40,7 @@ public class NullOutputStreamTest { @Test public void testNewInstance() throws IOException { - try (final NullOutputStream nos = new NullOutputStream()) { + try (final NullOutputStream nos = NullOutputStream.NULL_OUTPUT_STREAM) { process(nos); } }