Deprecate hudson.util.NullStream (#8128)

jenkinsci · Jun 14, 2023 · ffd2afe · ffd2afe
1 parent 9be693d
commit ffd2afe
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 19 deletions.
diff --git a/core/src/main/java/hudson/Proc.java b/core/src/main/java/hudson/Proc.java
@@ -33,7 +33,6 @@
 import hudson.util.DaemonThreadFactory;
 import hudson.util.ExceptionCatchingThreadFactory;
 import hudson.util.NamingThreadFactory;
-import hudson.util.NullStream;
 import hudson.util.ProcessTree;
 import hudson.util.StreamCopyThread;
 import java.io.File;
@@ -429,7 +428,7 @@ private static String calcName(String[] cmd) {
         }
 
         public static final InputStream SELFPUMP_INPUT = new NullInputStream(0);
-        public static final OutputStream SELFPUMP_OUTPUT = new NullStream();
+        public static final OutputStream SELFPUMP_OUTPUT = OutputStream.nullOutputStream();
     }
 
     /**

diff --git a/core/src/main/java/hudson/model/JDK.java b/core/src/main/java/hudson/model/JDK.java
@@ -34,11 +34,11 @@
 import hudson.tools.ToolInstaller;
 import hudson.tools.ToolProperty;
 import hudson.util.FormValidation;
-import hudson.util.NullStream;
 import hudson.util.StreamTaskListener;
 import hudson.util.XStream2;
 import java.io.File;
 import java.io.IOException;
+import java.io.OutputStream;
 import java.lang.reflect.Constructor;
 import java.util.Arrays;
 import java.util.Collections;
@@ -164,7 +164,7 @@ public JDK forEnvironment(EnvVars environment) {
      */
     public static boolean isDefaultJDKValid(Node n) {
         try {
-            TaskListener listener = new StreamTaskListener(new NullStream());
+            TaskListener listener = new StreamTaskListener(OutputStream.nullOutputStream());
             Launcher launcher = n.createLauncher(listener);
             return launcher.launch().cmds("java", "-fullversion").stdout(listener).join() == 0;
         } catch (IOException | InterruptedException e) {

diff --git a/core/src/main/java/hudson/slaves/SlaveComputer.java b/core/src/main/java/hudson/slaves/SlaveComputer.java
@@ -56,7 +56,6 @@
 import hudson.security.ACLContext;
 import hudson.slaves.OfflineCause.ChannelTermination;
 import hudson.util.Futures;
-import hudson.util.NullStream;
 import hudson.util.RingBufferLogHandler;
 import hudson.util.StreamTaskListener;
 import hudson.util.VersionNumber;
@@ -386,7 +385,7 @@ public OutputStream openLogFile() {
             return log;
         } catch (IOException e) {
             logger.log(Level.SEVERE, "Failed to create log file " + getLogFile(), e);
-            return new NullStream();
+            return OutputStream.nullOutputStream();
         }
     }
 

diff --git a/core/src/main/java/hudson/tasks/Maven.java b/core/src/main/java/hudson/tasks/Maven.java
@@ -51,14 +51,14 @@
 import hudson.tools.ToolProperty;
 import hudson.util.ArgumentListBuilder;
 import hudson.util.FormValidation;
-import hudson.util.NullStream;
 import hudson.util.StreamTaskListener;
 import hudson.util.VariableResolver;
 import hudson.util.VariableResolver.ByMap;
 import hudson.util.VariableResolver.Union;
 import hudson.util.XStream2;
 import java.io.File;
 import java.io.IOException;
+import java.io.OutputStream;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
@@ -665,7 +665,7 @@ private static File getExeFile(String execName, String home) {
          */
         public boolean getExists() {
             try {
-                return getExecutable(new LocalLauncher(new StreamTaskListener(new NullStream()))) != null;
+                return getExecutable(new LocalLauncher(new StreamTaskListener(OutputStream.nullOutputStream()))) != null;
             } catch (IOException | InterruptedException e) {
                 return false;
             }

diff --git a/core/src/main/java/hudson/util/IOUtils.java b/core/src/main/java/hudson/util/IOUtils.java
@@ -35,8 +35,9 @@ public class IOUtils {
      * Drains the input stream and closes it.
      */
     public static void drain(InputStream in) throws IOException {
-        org.apache.commons.io.IOUtils.copy(in, new NullStream());
-        in.close();
+        try (in; OutputStream out = OutputStream.nullOutputStream()) {
+            org.apache.commons.io.IOUtils.copy(in, out);
+        }
     }
 
     public static void copy(File src, OutputStream out) throws IOException {

diff --git a/core/src/main/java/hudson/util/NullStream.java b/core/src/main/java/hudson/util/NullStream.java
@@ -28,7 +28,9 @@
 
 /**
  * @author Kohsuke Kawaguchi
+ * @deprecated use {@link OutputStream#nullOutputStream}
  */
+@Deprecated
 public final class NullStream extends OutputStream {
     public NullStream() {}
 

diff --git a/core/src/main/java/hudson/util/StreamTaskListener.java b/core/src/main/java/hudson/util/StreamTaskListener.java
@@ -149,7 +149,7 @@ public StreamTaskListener(@NonNull Writer w) throws IOException {
      */
     @Deprecated
     public StreamTaskListener() throws IOException {
-        this(new NullStream());
+        this(OutputStream.nullOutputStream());
     }
 
     public static StreamTaskListener fromStdout() {

diff --git a/core/src/test/java/hudson/FilePathTest.java b/core/src/test/java/hudson/FilePathTest.java
@@ -43,7 +43,6 @@
 import hudson.os.WindowsUtil;
 import hudson.remoting.VirtualChannel;
 import hudson.slaves.WorkspaceList;
-import hudson.util.NullStream;
 import hudson.util.StreamTaskListener;
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
@@ -78,7 +77,6 @@
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipOutputStream;
 import org.apache.commons.io.FileUtils;
-import org.apache.commons.io.output.NullOutputStream;
 import org.apache.tools.ant.Project;
 import org.apache.tools.ant.taskdefs.Chmod;
 import org.junit.Ignore;
@@ -99,7 +97,9 @@ public class FilePathTest {
     @Test public void copyTo() throws Exception {
         File tmp = temp.newFile();
         FilePath f = new FilePath(channels.french, tmp.getPath());
-        f.copyTo(new NullStream());
+        try (OutputStream out = OutputStream.nullOutputStream()) {
+            f.copyTo(out);
+        }
         assertTrue("target does not exist", tmp.exists());
         assertTrue("could not delete target " + tmp.getPath(), tmp.delete());
     }
@@ -260,8 +260,10 @@ public void close() {
     @Test public void archiveBug() throws Exception {
             FilePath d = new FilePath(channels.french, temp.getRoot().getPath());
             d.child("test").touch(0);
-            d.zip(NullOutputStream.NULL_OUTPUT_STREAM);
-            d.zip(NullOutputStream.NULL_OUTPUT_STREAM, "**/*");
+            try (OutputStream out = OutputStream.nullOutputStream()) {
+                d.zip(out);
+                d.zip(out, "**/*");
+            }
     }
 
     @Test public void normalization() {

diff --git a/core/src/test/java/hudson/util/io/TarArchiverTest.java b/core/src/test/java/hudson/util/io/TarArchiverTest.java
@@ -33,7 +33,6 @@
 import hudson.Launcher.LocalLauncher;
 import hudson.Util;
 import hudson.model.TaskListener;
-import hudson.util.NullStream;
 import hudson.util.StreamTaskListener;
 import java.io.File;
 import java.io.IOException;
@@ -117,7 +116,9 @@ private static void run(FilePath dir, String... cmds) throws InterruptedExceptio
         assumeFalse(Functions.isWindows());
         File dir = tmp.getRoot();
         Util.createSymlink(dir, "nonexistent", "link", TaskListener.NULL);
-        new FilePath(dir).tar(new NullStream(), "**");
+        try (OutputStream out = OutputStream.nullOutputStream()) {
+            new FilePath(dir).tar(out, "**");
+        }
     }
 
 
@@ -132,7 +133,9 @@ private static void run(FilePath dir, String... cmds) throws InterruptedExceptio
         Thread t1 = new Thread(runnable1);
         t1.start();
 
-        new FilePath(tmp.getRoot()).tar(new NullStream(), "**");
+        try (OutputStream out = OutputStream.nullOutputStream()) {
+            new FilePath(tmp.getRoot()).tar(out, "**");
+        }
 
         runnable1.doFinish();
         t1.join();