java.io
Class PrintStream

java.lang.Object   
  java.io.OutputStream   
      java.io.FilterOutputStream   
          java.io.PrintStream

All Implemented Interfaces:

Closeable , Flushable , Appendable

Direct Known Subclasses:

LogStream

public class PrintStream
extends FilterOutputStream   
implements Appendable   , Closeable   

A PrintStream adds functionality to another output stream, namely the ability to print representations of various data values conveniently. Two other features are provided as well. Unlike other output streams, a PrintStream never throws an IOException; instead, exceptional situations merely set an internal flag that can be tested via the checkError method. Optionally, a PrintStream can be created so as to flush automatically; this means that the flush method is automatically invoked after a byte array is written, one of the println methods is invoked, or a newline character or byte ('\n') is written.

All characters printed by a PrintStream are converted into bytes using the platform's default character encoding. The PrintWriter class should be used in situations that require writing characters rather than bytes.

Since:

JDK1.0

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

PrintStream (File file)
Creates a new print stream, without automatic line flushing, with the specified file.

PrintStream (File file, String csn)
Creates a new print stream, without automatic line flushing, with the specified file and charset.

PrintStream (OutputStream out)
Create a new print stream.

PrintStream (OutputStream out, boolean autoFlush)
Create a new print stream.

PrintStream (OutputStream out, boolean autoFlush, String encoding)
Create a new print stream.

PrintStream (String fileName)
Creates a new print stream, without automatic line flushing, with the specified file name.

PrintStream (String fileName, String csn)
Creates a new print stream, without automatic line flushing, with the specified file name and charset.

Method Summary

PrintStream	append (char c) Appends the specified character to this output stream.
PrintStream	append (CharSequence csq) Appends the specified character sequence to this output stream.
PrintStream	append (CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this output stream.
boolean	checkError () Flush the stream and check its error state.
void	close () Close the stream.
void	flush () Flush the stream.
PrintStream	format (Locale l, String format, Object ... args) Writes a formatted string to this output stream using the specified format string and arguments.
PrintStream	format (String format, Object ... args) Writes a formatted string to this output stream using the specified format string and arguments.
void	print (boolean b) Print a boolean value.
void	print (char c) Print a character.
void	print (char[] s) Print an array of characters.
void	print (double d) Print a double-precision floating-point number.
void	print (float f) Print a floating-point number.
void	print (int i) Print an integer.
void	print (long l) Print a long integer.
void	print (Object obj) Print an object.
void	print (String s) Print a string.
PrintStream	printf (Locale l, String format, Object ... args) A convenience method to write a formatted string to this output stream using the specified format string and arguments.
PrintStream	printf (String format, Object ... args) A convenience method to write a formatted string to this output stream using the specified format string and arguments.
void	println () Terminate the current line by writing the line separator string.
void	println (boolean x) Print a boolean and then terminate the line.
void	println (char x) Print a character and then terminate the line.
void	println (char[] x) Print an array of characters and then terminate the line.
void	println (double x) Print a double and then terminate the line.
void	println (float x) Print a float and then terminate the line.
void	println (int x) Print an integer and then terminate the line.
void	println (long x) Print a long and then terminate the line.
void	println (Object x) Print an Object and then terminate the line.
void	println (String x) Print a String and then terminate the line.
protected void	setError () Set the error state of the stream to true.
void	write (byte[] buf, int off, int len) Write len bytes from the specified byte array starting at offset off to this stream.
void	write (int b) Write the specified byte to this stream.

Methods inherited from class java.io.FilterOutputStream

write

Methods inherited from class java.lang.Object

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

Constructor Detail

PrintStream

public PrintStream(OutputStream    out)

Create a new print stream. This stream will not flush automatically.

Parameters:

out - The output stream to which values and objects will be printed

See Also:

PrintWriter.PrintWriter(java.io.OutputStream)

PrintStream

public PrintStream(OutputStream    out,
                   boolean autoFlush)

Create a new print stream.

Parameters:

out - The output stream to which values and objects will be printed

autoFlush - A boolean; if true, the output buffer will be flushed whenever a byte array is written, one of the println methods is invoked, or a newline character or byte ('\n') is written

See Also:

PrintWriter.PrintWriter(java.io.OutputStream, boolean)

PrintStream

public PrintStream(OutputStream    out,
                   boolean autoFlush,
                   String    encoding)
            throws UnsupportedEncodingException   

Create a new print stream.

Parameters:

out - The output stream to which values and objects will be printed

autoFlush - A boolean; if true, the output buffer will be flushed whenever a byte array is written, one of the println methods is invoked, or a newline character or byte ('\n') is written

encoding - The name of a supported character encoding

Throws:

UnsupportedEncodingException - If the named encoding is not supported

PrintStream

public PrintStream(String    fileName)
            throws FileNotFoundException   

Creates a new print stream, without automatic line flushing, with the specified file name. This convenience constructor creates the necessary intermediate OutputStreamWriter , which will encode characters using the default charset for this instance of the Java virtual machine.

Parameters:

fileName - The name of the file to use as the destination of this print stream. If the file exists, then it will be truncated to zero size; otherwise, a new file will be created. The output will be written to the file and is buffered.

Throws:

FileNotFoundException - If the given file object does not denote an existing, writable regular file and a new regular file of that name cannot be created, or if some other error occurs while opening or creating the file

SecurityException - If a security manager is present and checkWrite(fileName) denies write access to the file

Since:

1.5

PrintStream

public PrintStream(String    fileName,
                   String    csn)
            throws FileNotFoundException   ,
                   UnsupportedEncodingException   

Creates a new print stream, without automatic line flushing, with the specified file name and charset. This convenience constructor creates the necessary intermediate OutputStreamWriter , which will encode characters using the provided charset.

Parameters:

fileName - The name of the file to use as the destination of this print stream. If the file exists, then it will be truncated to zero size; otherwise, a new file will be created. The output will be written to the file and is buffered.

csn - The name of a supported charset

Throws:

FileNotFoundException - If the given file object does not denote an existing, writable regular file and a new regular file of that name cannot be created, or if some other error occurs while opening or creating the file

SecurityException - If a security manager is present and checkWrite(fileName) denies write access to the file

UnsupportedEncodingException - If the named charset is not supported

Since:

1.5

PrintStream

public PrintStream(File    file)
            throws FileNotFoundException   

Creates a new print stream, without automatic line flushing, with the specified file. This convenience constructor creates the necessary intermediate OutputStreamWriter , which will encode characters using the default charset for this instance of the Java virtual machine.

Parameters:

file - The file to use as the destination of this print stream. If the file exists, then it will be truncated to zero size; otherwise, a new file will be created. The output will be written to the file and is buffered.

Throws:

FileNotFoundException - If the given file object does not denote an existing, writable regular file and a new regular file of that name cannot be created, or if some other error occurs while opening or creating the file

SecurityException - If a security manager is present and checkWrite(file.getPath()) denies write access to the file

Since:

1.5

PrintStream

public PrintStream(File    file,
                   String    csn)
            throws FileNotFoundException   ,
                   UnsupportedEncodingException   

Creates a new print stream, without automatic line flushing, with the specified file and charset. This convenience constructor creates the necessary intermediate OutputStreamWriter , which will encode characters using the provided charset.

Parameters:

file - The file to use as the destination of this print stream. If the file exists, then it will be truncated to zero size; otherwise, a new file will be created. The output will be written to the file and is buffered.

csn - The name of a supported charset

Throws:

FileNotFoundException - If the given file object does not denote an existing, writable regular file and a new regular file of that name cannot be created, or if some other error occurs while opening or creating the file

SecurityException - If a security manager is presentand checkWrite(file.getPath()) denies write access to the file

UnsupportedEncodingException - If the named charset is not supported

Since:

1.5

Method Detail

flush

public void flush()

Flush the stream. This is done by writing any buffered output bytes to the underlying output stream and then flushing that stream.

Specified by:

flush in interface Flushable

Overrides:

flush in class FilterOutputStream

See Also:

OutputStream.flush()

close

public void close()

Close the stream. This is done by flushing the stream and then closing the underlying output stream.

Specified by:

close in interface Closeable

Overrides:

close in class FilterOutputStream

See Also:

OutputStream.close()

checkError

public boolean checkError()

Flush the stream and check its error state. The internal error state is set to true when the underlying output stream throws an IOException other than InterruptedIOException, and when the setError method is invoked. If an operation on the underlying output stream throws an InterruptedIOException, then the PrintStream converts the exception back into an interrupt by doing:

     Thread.currentThread().interrupt();
 

or the equivalent.

Returns:

True if and only if this stream has encountered an IOException other than InterruptedIOException, or the setError method has been invoked

setError

protected void setError()

Set the error state of the stream to true.

Since:

JDK1.1

write

public void write(int b)

Write the specified byte to this stream. If the byte is a newline and automatic flushing is enabled then the flush method will be invoked.

Note that the byte is written as given; to write a character that will be translated according to the platform's default character encoding, use the print(char) or println(char) methods.

Overrides:

write in class FilterOutputStream

Parameters:

b - The byte to be written

See Also:

print(char) , println(char)

write