public class

PrintStream

extends OutputStream
java.lang.Object
   ↳ java.io.OutputStream
     ↳ java.io.PrintStream

Class Overview

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.

Summary

Public Constructors
PrintStream(OutputStream out)
Create a new print stream.
Public Methods
boolean checkError()
Flush the stream and check its error state.
void close()
Close the stream.
void flush()
Flush the stream.
void print(long l)
Print a long integer.
void print(String s)
Print a string.
void print(int i)
Print an integer.
void print(boolean b)
Print a boolean value.
void print(char c)
Print a character.
void print(Object obj)
Print an object.
void print(char[] s)
Print an array of characters.
void println(Object x)
Print an Object and then terminate the line.
void println(char x)
Print a character and then terminate the line.
void println(int x)
Print an integer and then terminate the line.
void println(String x)
Print a String and then terminate the line.
void println(boolean x)
Print a boolean and then terminate the line.
void println(char[] x)
Print an array of characters and then terminate the line.
void println(long x)
Print a long and then terminate the line.
void println()
Terminate the current line by writing the line separator string.
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.
Protected Methods
void setError()
Set the error state of the stream to true.
[Expand]
Inherited Methods
From class java.io.OutputStream
From class java.lang.Object

Public Constructors

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

Public Methods

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, and when the setError method is invoked.

Returns
  • True if and only if this stream has encountered an IOException, or the setError method has been invoked

public void close ()

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

See Also

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.

See Also

public void print (long l)

Print a long integer. The string produced by valueOf(long) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters
l The long to be printed
See Also

public void print (String s)

Print a string. If the argument is null then the string "null" is printed. Otherwise, the string's characters are converted into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters
s The String to be printed

public void print (int i)

Print an integer. The string produced by valueOf(int) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters
i The int to be printed
See Also

public void print (boolean b)

Print a boolean value. The string produced by valueOf(boolean) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters
b The boolean to be printed

public void print (char c)

Print a character. The character is translated into one or more bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters
c The char to be printed

public void print (Object obj)

Print an object. The string produced by the valueOf(Object) method is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters
obj The Object to be printed
See Also

public void print (char[] s)

Print an array of characters. The characters are converted into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the write(int) method.

Parameters
s The array of chars to be printed
Throws
NullPointerException If s is null

public void println (Object x)

Print an Object and then terminate the line. This method behaves as though it invokes print(Object) and then println().

Parameters
x The Object to be printed.

public void println (char x)

Print a character and then terminate the line. This method behaves as though it invokes print(char) and then println().

Parameters
x The char to be printed.

public void println (int x)

Print an integer and then terminate the line. This method behaves as though it invokes print(int) and then println().

Parameters
x The int to be printed.

public void println (String x)

Print a String and then terminate the line. This method behaves as though it invokes print(String) and then println().

Parameters
x The String to be printed.

public void println (boolean x)

Print a boolean and then terminate the line. This method behaves as though it invokes print(boolean) and then println().

Parameters
x The boolean to be printed

public void println (char[] x)

Print an array of characters and then terminate the line. This method behaves as though it invokes print(char[]) and then println().

Parameters
x an array of chars to print.

public void println (long x)

Print a long and then terminate the line. This method behaves as though it invokes print(long) and then println().

Parameters
x a The long to be printed.

public void println ()

Terminate the current line by writing the line separator string. The line separator string is defined by the system property line.separator, and is not necessarily a single newline character ('\n').

public void write (byte[] buf, int off, int len)

Write len bytes from the specified byte array starting at offset off to this stream. If automatic flushing is enabled then the flush method will be invoked.

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

Parameters
buf A byte array
off Offset from which to start taking bytes
len Number of bytes to 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.

Parameters
b The byte to be written
See Also

Protected Methods

protected void setError ()

Set the error state of the stream to true.