Added in API level 1

PrintStream

public class PrintStream
extends FilterOutputStream implements Appendable, Closeable

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

Wraps an existing OutputStream and provides convenience methods for writing common data types in a human readable format. This is not to be confused with DataOutputStream which is used for encoding common data types so that they can be read back in. No IOException is thrown by this class. Instead, callers should use checkError() to see if a problem has occurred in this stream.

Summary

Inherited fields

From class


    java.io.FilterOutputStream

Public constructors
`PrintStream(OutputStream out)` Constructs a new `PrintStream` with `out` as its target stream.
`PrintStream(OutputStream out, boolean autoFlush)` Constructs a new `PrintStream` with `out` as its target stream.
`PrintStream(OutputStream out, boolean autoFlush, String charsetName)` Constructs a new `PrintStream` with `out` as its target stream and using the character encoding `charsetName` while writing.
`PrintStream(File file)` Constructs a new `PrintStream` with `file` as its target.
`PrintStream(File file, String charsetName)` Constructs a new `PrintStream` with `file` as its target.
`PrintStream(String fileName)` Constructs a new `PrintStream` with the file identified by `fileName` as its target.
`PrintStream(String fileName, String charsetName)` Constructs a new `PrintStream` with the file identified by `fileName` as its target.

Public methods
`PrintStream`	`append(char c)` Appends the char `c`.
`PrintStream`	`append(CharSequence charSequence, int start, int end)` Appends a subsequence of CharSequence `charSequence`, or `"null"`.
`PrintStream`	`append(CharSequence charSequence)` Appends the CharSequence `charSequence`, or `"null"`.
`boolean`	`checkError()` Flushes this stream and returns the value of the error flag.
`void`	`close()` Closes this print stream.
`void`	`flush()` Ensures that all pending data is sent out to the target stream.
`PrintStream`	`format(Locale l, String format, Object... args)` Writes a string formatted by an intermediate `Formatter` to this stream using the specified locale, format string and arguments.
`PrintStream`	`format(String format, Object... args)` Formats `args` according to the format string `format`, and writes the result to this stream.
`void`	`print(float f)` Prints the string representation of the float `f`.
`void`	`print(double d)` Prints the string representation of the double `d`.
`void`	`print(String str)` Prints a string to the target stream.
`void`	`print(Object o)` Prints the string representation of the Object `o`, or `"null"`.
`void`	`print(char c)` Prints the string representation of the char `c`.
`void`	`print(char[] chars)` Prints the string representation of the character array `chars`.
`void`	`print(long l)` Prints the string representation of the long `l`.
`void`	`print(int i)` Prints the string representation of the int `i`.
`void`	`print(boolean b)` Prints the string representation of the boolean `b`.
`PrintStream`	`printf(Locale l, String format, Object... args)` Prints a formatted string.
`PrintStream`	`printf(String format, Object... args)` Prints a formatted string.
`void`	`println()` Prints a newline.
`void`	`println(float f)` Prints the string representation of the float `f` followed by a newline.
`void`	`println(int i)` Prints the string representation of the int `i` followed by a newline.
`void`	`println(long l)` Prints the string representation of the long `l` followed by a newline.
`void`	`println(Object o)` Prints the string representation of the Object `o`, or `"null"`, followed by a newline.
`void`	`println(char[] chars)` Prints the string representation of the character array `chars` followed by a newline.
`void`	`println(String str)` Prints a string followed by a newline.
`void`	`println(char c)` Prints the string representation of the char `c` followed by a newline.
`void`	`println(double d)` Prints the string representation of the double `d` followed by a newline.
`void`	`println(boolean b)` Prints the string representation of the boolean `b` followed by a newline.
`void`	`write(int oneByte)` Writes one byte to the target stream.
`void`	`write(byte[] buffer, int offset, int length)` Writes `count` bytes from `buffer` starting at `offset` to the target stream.

Protected methods
`void`	`clearError()` Sets the error state of the stream to false.
`void`	`setError()` Sets the error flag of this print stream to true.

Inherited methods

From class


  
    java.io.FilterOutputStream

From class


  
    java.io.OutputStream

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this `Object`.
`boolean`	`equals(Object o)` Compares this instance with the specified object and indicates if they are equal.
`void`	`finalize()` Invoked when the garbage collector has detected that this instance is no longer reachable.
`final Class<?>`	`getClass()` Returns the unique instance of `Class` that represents this object's class.
`int`	`hashCode()` Returns an integer hash code for this object.
`final void`	`notify()` Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
`final void`	`notifyAll()` Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
`String`	`toString()` Returns a string containing a concise, human-readable description of this object.
`final void`	`wait()` Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
`final void`	`wait(long millis, int nanos)` Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
`final void`	`wait(long millis)` Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface


  
    java.io.Closeable

From interface


  
    java.io.Flushable

From interface


  
    java.lang.Appendable

From interface


  
    java.lang.AutoCloseable

Public constructors

PrintStream

Added in API level 1

PrintStream (OutputStream out)

Constructs a new PrintStream with out as its target stream. By default, the new print stream does not automatically flush its contents to the target stream when a newline is encountered.

Parameters
`out`	`OutputStream`: the target output stream.

Throws
`NullPointerException`	if `out` is `null`.

PrintStream

Added in API level 1

PrintStream (OutputStream out, 
                boolean autoFlush)

Constructs a new PrintStream with out as its target stream. The parameter autoFlush determines if the print stream automatically flushes its contents to the target stream when a newline is encountered.

Parameters
`out`	`OutputStream`: the target output stream.
`autoFlush`	`boolean`: indicates whether to flush contents upon encountering a newline sequence.

Throws
`NullPointerException`	if `out` is `null`.

PrintStream

Added in API level 1

PrintStream (OutputStream out, 
                boolean autoFlush, 
                String charsetName)

Constructs a new PrintStream with out as its target stream and using the character encoding charsetName while writing. The parameter autoFlush determines if the print stream automatically flushes its contents to the target stream when a newline is encountered.

Parameters
`out`	`OutputStream`: the target output stream.
`autoFlush`	`boolean`: indicates whether or not to flush contents upon encountering a newline sequence.
`charsetName`	`String`: the non-null string describing the desired character encoding.

Throws
`NullPointerException`	if `out` or `charsetName` are `null`.
`UnsupportedEncodingException`	if the encoding specified by `charsetName` is not supported.

PrintStream

Added in API level 1

PrintStream (File file)

Constructs a new PrintStream with file as its target. The VM's default character set is used for character encoding.

Parameters
`file`	`File`: the target file. If the file already exists, its contents are removed, otherwise a new file is created.

Throws
`FileNotFoundException`	if an error occurs while opening or creating the target file.

PrintStream

Added in API level 1

PrintStream (File file, 
                String charsetName)

Constructs a new PrintStream with file as its target. The character set named charsetName is used for character encoding.

Parameters
`file`	`File`: the target file. If the file already exists, its contents are removed, otherwise a new file is created.
`charsetName`	`String`: the name of the character set used for character encoding.

Throws
`FileNotFoundException`	if an error occurs while opening or creating the target file.
`NullPointerException`	if `charsetName` is `null`.
`UnsupportedEncodingException`	if the encoding specified by `charsetName` is not supported.

PrintStream

Added in API level 1

PrintStream (String fileName)

Constructs a new PrintStream with the file identified by fileName as its target. The VM's default character set is used for character encoding.

Parameters
`fileName`	`String`: the target file's name. If the file already exists, its contents are removed, otherwise a new file is created.

Throws
`FileNotFoundException`	if an error occurs while opening or creating the target file.

PrintStream

Added in API level 1

PrintStream (String fileName, 
                String charsetName)

Constructs a new PrintStream with the file identified by fileName as its target. The character set named charsetName is used for character encoding.

Parameters
`fileName`	`String`: the target file's name. If the file already exists, its contents are removed, otherwise a new file is created.
`charsetName`	`String`: the name of the character set used for character encoding.

Throws
`FileNotFoundException`	if an error occurs while opening or creating the target file.
`NullPointerException`	if `charsetName` is `null`.
`UnsupportedEncodingException`	if the encoding specified by `charsetName` is not supported.

Public methods

append

Added in API level 1

PrintStream append (char c)

Appends the char c.

Parameters
`c`	`char`: the character to append.

Returns
`PrintStream`	this stream.

append

Added in API level 1

PrintStream append (CharSequence charSequence, 
                int start, 
                int end)

Appends a subsequence of CharSequence charSequence, or "null".

Parameters
`charSequence`	`CharSequence`: the character sequence appended to the target stream.
`start`	`int`: the index of the first char in the character sequence appended to the target stream.
`end`	`int`: the index of the character following the last character of the subsequence appended to the target stream.

Returns
`PrintStream`	this stream.

Throws
`IndexOutOfBoundsException`	if `start > end`, `start < 0`, `end < 0` or either `start` or `end` are greater or equal than the length of `charSequence`.

append

Added in API level 1

PrintStream append (CharSequence charSequence)

Appends the CharSequence charSequence, or "null".

Parameters
`charSequence`	`CharSequence`: the character sequence to append.

Returns
`PrintStream`	this stream.

checkError

Added in API level 1

boolean checkError ()

Flushes this stream and returns the value of the error flag.

Returns
`boolean`	`true` if either an `IOException` has been thrown previously or if `setError()` has been called; `false` otherwise.

See also:

setError()

close

Added in API level 1

void close ()

Closes this print stream. Flushes this stream and then closes the target stream. If an I/O error occurs, this stream's error state is set to true.

flush

Added in API level 1

void flush ()

Ensures that all pending data is sent out to the target stream. It also flushes the target stream. If an I/O error occurs, this stream's error state is set to true.

format

Added in API level 1

PrintStream format (Locale l, 
                String format, 
                Object... args)

Writes a string formatted by an intermediate Formatter to this stream using the specified locale, format string and arguments.

Parameters
`l`	`Locale`: the locale used in the method. No localization will be applied if `l` is `null`.
`format`	`String`: the format string (see `format(String, Object...)`)
`args`	`Object`: the list of arguments passed to the formatter. If there are more arguments than required by `format`, additional arguments are ignored.

Returns
`PrintStream`	this stream.

Throws
`IllegalFormatException`	if the format string is illegal or incompatible with the arguments, if there are not enough arguments or if any other error regarding the format string or arguments is detected.
`NullPointerException`	if `format == null`

format

Added in API level 1

PrintStream format (String format, 
                Object... args)

Formats args according to the format string format, and writes the result to this stream. This method uses the user's default locale. See "Be wary of the default locale".

Parameters
`format`	`String`: the format string (see `format(String, Object...)`)
`args`	`Object`: the list of arguments passed to the formatter. If there are more arguments than required by `format`, additional arguments are ignored.

Returns
`PrintStream`	this stream.

Throws
`IllegalFormatException`	if the format string is illegal or incompatible with the arguments, if there are not enough arguments or if any other error regarding the format string or arguments is detected.
`NullPointerException`	if `format == null`

print

Added in API level 1

void print (float f)

Prints the string representation of the float f.

Parameters
`f`	`float`

print

Added in API level 1

void print (double d)

Prints the string representation of the double d.

Parameters
`d`	`double`

print

Added in API level 1

void print (String str)

Prints a string to the target stream. The string is converted to an array of bytes using the encoding chosen during the construction of this stream. The bytes are then written to the target stream with write(int).

If an I/O error occurs, this stream's error state is set to true.

Parameters
`str`	`String`: the string to print to the target stream.

See also:

write(int)

print

Added in API level 1

void print (Object o)

Prints the string representation of the Object o, or "null".

Parameters
`o`	`Object`

print

Added in API level 1

void print (char c)

Prints the string representation of the char c.

Parameters
`c`	`char`

print

Added in API level 1

void print (char[] chars)

Prints the string representation of the character array chars.

Parameters
`chars`	`char`

print

Added in API level 1

void print (long l)

Prints the string representation of the long l.

Parameters
`l`	`long`

print

Added in API level 1

void print (int i)

Prints the string representation of the int i.

Parameters
`i`	`int`

print

Added in API level 1

void print (boolean b)

Prints the string representation of the boolean b.

Parameters
`b`	`boolean`

printf

Added in API level 1

PrintStream printf (Locale l, 
                String format, 
                Object... args)

Prints a formatted string. The behavior of this method is the same as this stream's #format(Locale, String, Object...) method.

Parameters
`l`	`Locale`: the locale used in the method. No localization will be applied if `l` is `null`.
`format`	`String`: the format string (see `format(String, Object...)`)
`args`	`Object`: the list of arguments passed to the formatter. If there are more arguments than required by `format`, additional arguments are ignored.

Returns
`PrintStream`	this stream.

Throws
`IllegalFormatException`	if the format string is illegal or incompatible with the arguments, if there are not enough arguments or if any other error regarding the format string or arguments is detected.
`NullPointerException`	if `format == null`.

printf

Added in API level 1

PrintStream printf (String format, 
                Object... args)

Prints a formatted string. The behavior of this method is the same as this stream's #format(String, Object...) method.

The Locale used is the user's default locale. See "Be wary of the default locale".

Parameters
`format`	`String`: the format string (see `format(String, Object...)`)
`args`	`Object`: the list of arguments passed to the formatter. If there are more arguments than required by `format`, additional arguments are ignored.

Returns
`PrintStream`	this stream.

Throws
`IllegalFormatException`	if the format string is illegal or incompatible with the arguments, if there are not enough arguments or if any other error regarding the format string or arguments is detected.
`NullPointerException`	if `format == null`

println

Added in API level 1

void println ()

Prints a newline.

println

Added in API level 1

void println (float f)

Prints the string representation of the float f followed by a newline.

Parameters
`f`	`float`

println

Added in API level 1

void println (int i)

Prints the string representation of the int i followed by a newline.

Parameters
`i`	`int`

println

Added in API level 1

void println (long l)

Prints the string representation of the long l followed by a newline.

Parameters
`l`	`long`

println

Added in API level 1

void println (Object o)

Prints the string representation of the Object o, or "null", followed by a newline.

Parameters
`o`	`Object`

println

Added in API level 1

void println (char[] chars)

Prints the string representation of the character array chars followed by a newline.

Parameters
`chars`	`char`

println

Added in API level 1

void println (String str)

Prints a string followed by a newline. The string is converted to an array of bytes using the encoding chosen during the construction of this stream. The bytes are then written to the target stream with write(int).

If an I/O error occurs, this stream's error state is set to true.

Parameters
`str`	`String`: the string to print to the target stream.

See also:

write(int)

println

Added in API level 1

void println (char c)

Prints the string representation of the char c followed by a newline.

Parameters
`c`	`char`

println

Added in API level 1

void println (double d)

Prints the string representation of the double d followed by a newline.

Parameters
`d`	`double`

println

Added in API level 1

void println (boolean b)

Prints the string representation of the boolean b followed by a newline.

Parameters
`b`	`boolean`

write

Added in API level 1

void write (int oneByte)

Writes one byte to the target stream. Only the least significant byte of the integer oneByte is written. This stream is flushed if oneByte is equal to the character '\n' and this stream is set to autoFlush.

This stream's error flag is set to true if it is closed or an I/O error occurs.

Parameters
`oneByte`	`int`: the byte to be written

write

Added in API level 1

void write (byte[] buffer, 
                int offset, 
                int length)

Writes count bytes from buffer starting at offset to the target stream. If autoFlush is set, this stream gets flushed after writing the buffer.

This stream's error flag is set to true if this stream is closed or an I/O error occurs.

Parameters
`buffer`	`byte`: the buffer to be written.
`offset`	`int`: the index of the first byte in `buffer` to write.
`length`	`int`: the number of bytes in `buffer` to write.

Throws
`IndexOutOfBoundsException`	if `offset < 0` or `count < 0`, or if `offset + count` is bigger than the length of `buffer`.

See also:

flush()

Protected methods

clearError

Added in API level 9

void clearError ()

Sets the error state of the stream to false.

setError

Added in API level 1

void setError ()

Sets the error flag of this print stream to true.

This site uses cookies to store your preferences for site-specific language and display options.

Apr	MAY	Jun
	20
2015	2016	2017

PrintStream

Summary

Inherited fields

Public constructors

Public methods

Protected methods

Inherited methods

Public constructors

PrintStream

PrintStream

PrintStream

PrintStream

PrintStream

PrintStream

PrintStream

Public methods

append

append

append

checkError

close

flush

format

format

print

print

print

print

print

print

print

print

print

printf

printf

println

println

println

println

println

println

println

println

println

println

write

write

Protected methods

clearError

setError

Interfaces

Classes

Exceptions

Errors