132

I need to specify an OutputStream for an API I'm using, but I don't actually have a need for the output. Does Java have an OutputStream equivalent to > /dev/null?

palacsint
  • 28,416
  • 10
  • 82
  • 109
Brandon Yarbrough
  • 37,021
  • 23
  • 116
  • 145

9 Answers9

125

Java 11+:

OutputStream.nullOutputStream()

Java 11-:

/** Writes to nowhere. */
public class NullOutputStream extends OutputStream {
  @Override
  public void write(int b) throws IOException {}
}
Dave Jarvis
  • 30,436
  • 41
  • 178
  • 315
McDowell
  • 107,573
  • 31
  • 204
  • 267
  • 17
    This can also be easily implemented wherever you need it using something like this: `OutputStream nullOutputStream = new OutputStream() { @Override public void write(int b) { } };` – Hank Schultz Sep 04 '15 at 14:02
  • for performance reasons you should also override the other wirte(...) methods, see comments in the java.io.OutputStream source code – neoexpert Dec 13 '22 at 13:18
71

Apache Commons IO has the following:

https://commons.apache.org/proper/commons-io/javadocs/api-2.5/org/apache/commons/io/output/NullOutputStream.html

Dave Jarvis
  • 30,436
  • 41
  • 178
  • 315
Jonathan Holloway
  • 62,090
  • 32
  • 125
  • 150
53

Since Java 11, there is a static utility that does exactly what you need, a static factory method OutputStream.nullOutputStream():

Returns a new OutputStream which discards all bytes. The returned stream is initially open. The stream is closed by calling the close() method. Subsequent calls to close() have no effect.

Stephan202
  • 59,965
  • 13
  • 127
  • 133
leventov
  • 14,760
  • 11
  • 69
  • 98
46

It's not mentioned yet, so I'll also add Guava's ByteStreams.nullOutputStream(), as some might prefer Guava over Apache Commons IO or already have it in their project.

Note: If you use an older version of Guava (from 1.0 to 13.0), you want to use com.google.io.NullOutputStream.

petertc
  • 3,607
  • 1
  • 31
  • 36
haylem
  • 22,460
  • 3
  • 67
  • 96
15

Rehashing the answers already provided -

Java does not have a NullOutputStream class. You could however roll your own OutputStream that ignores any data written to it - in other words write(int b), write(byte[] b) and write(byte[] b, int off, int len) will have empty method bodies. This is what the Common IO NullOutputStream class does.

palacsint
  • 28,416
  • 10
  • 82
  • 109
Vineet Reynolds
  • 76,006
  • 17
  • 150
  • 174
  • here http://alvinalexander.com/java/jwarehouse/commons-io-2.0/src/main/java/org/apache/commons/io/output/NullOutputStream.java.shtml – Aftershock Sep 02 '14 at 11:06
5

Java 11 added OutputStream.nullOutputStream()

Gunter Zeilinger
  • 131
  • 1
  • 2
  • 4
3

No, but it is pretty easy to implement.

See this question "How to remove System.out.println from codebase"

And then you just have to:

System.setOut( DevNull.out );

Or something like that :)

System.setOut(PrintStream)

Community
  • 1
  • 1
OscarRyz
  • 196,001
  • 113
  • 385
  • 569
2

There is new boy in the town, that takes care of this like a charm, just few lines of code should work. Its JDK 11 and nullWriter() has been introduced there, that takes care of this. Here goes the code to deal with same old problem, new way without worrying about Operating System(OS).

String fileContent = "Welcome to StackOverflow readers !! Here goes the question link...";
Writer writer = Writer.nullWriter();
writer.write(fileContent);
writer.close();

Hope this may help someone!

Brandon Yarbrough
  • 37,021
  • 23
  • 116
  • 145
Red Boy
  • 5,429
  • 3
  • 28
  • 41
0

I believe that this is what you're looking for, I was looking for the same thing: This is for redirecting output streams from standard error, standard out in ProcessBuilder objects.

Blockquote

pb.redirectError( ProcessBuilder.Redirect.appendTo( new File( "NUL:" ) ) );
  • Dom
Dominik
  • 1