Package com.globalmentor.io

Class PrintStreamWriter

java.lang.Object

java.io.Writer

com.globalmentor.io.PrintStreamWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class PrintStreamWriter
extends Writer

Converts a PrintStream to a Writer.

This class delegates to PrintStream.print(String) for writing strings, maintaining the charset of the underlying print stream. This is especially important to maintain the charset of System.out and System.err, which virtually impossible to determine especially in earlier versions of Java. Contrast this with PrintWriter, which does not maintain the underlying charset of the PrintStream.

Author:

Garret Wilson

API Note:

Note that if System.out or System.err is being redirected, the charset may continue to be set to the console charset, which may not necessarily be the system default charset and may not be appropriate for saving to a file. This is a Java limitation and is for the most part unavoidable. It may thus be better to avoid redirecting output and instead provide options for explicitly saving to an external file with some specified or default charset. See How to find charset of System.err if stdout is redirected? for more discussion.

See Also:

• System.out
• System.err

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
PrintStreamWriter(PrintStream printStream)	Print stream constructor.
PrintStreamWriter(PrintStream printStream, boolean closeStreamOnClose)	Print stream and optional closing constructor.

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
void	write(char[] cbuf)
void	write(char[] cbuf, int off, int len)
void	write(int c)
void	write(String str)
void	write(String str, int off, int len)

Methods inherited from class java.io.Writer

append, append, append

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PrintStreamWriter

public PrintStreamWriter(@Nonnull
 PrintStream printStream)

Print stream constructor.

API Note:

If writing to System.out or System.err it probably more appropriate to use the PrintStreamWriter(PrintStream, boolean) constructor with a close argument of false.

Parameters:

printStream - The print stream to convert.

See Also:

• Why don't we close `System.out` Stream after using it?

PrintStreamWriter

public PrintStreamWriter(@Nonnull
 PrintStream printStream,
 boolean closeStreamOnClose)

Print stream and optional closing constructor.

API Note:

Setting the close option to false is useful if wrapping System.out or System.err, as these streams are provided by the JVM and should not be closed by the application.

Parameters:

printStream - The print stream to convert.

closeStreamOnClose - true if the given print stream should be closed when the writer is closed, or false if the print stream should be left open.

See Also:

• Why don't we close `System.out` Stream after using it?

Method Details

write

public void write(int c)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(char[] cbuf)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(char[] cbuf,
 int off,
 int len)
           throws IOException

Specified by:

write in class Writer

Throws:

IOException

write

public void write(String str)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(String str,
 int off,
 int len)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Writer

Throws:

IOException