public class java.io
PrintWriter


Show All Login
Java SE 6
  
Extends: Writer
Details
Prints formatted representations of objects to a text-output stream. This class implements all of the print methods found in PrintStream. It does not contain methods for writing raw bytes, for which a program should use unencoded byte streams.

Unlike the PrintStream class, if automatic flushing is enabled it will be done only when one of the println, printf, or format methods is invoked, rather than whenever a newline character happens to be output. These methods use the platform's own notion of line separator rather than the newline character.

Methods in this class never throw I/O exceptions, although some of its constructors may. The client may inquire as to whether any errors have occurred by invoking checkError().
version1.43, 08/07/06
sinceJDK1.1


Fields
protected Writer out Details
The underlying character-output stream of this PrintWriter.
since1.2

Constructors
public PrintWriter(Writer out) Details
Creates a new PrintWriter, without automatic line flushing.
outA character-output stream
public PrintWriter(Writer out, boolean autoFlush) Details
Creates a new PrintWriter.
outA character-output stream
autoFlushA boolean; if true, the println, printf, or format methods will flush the output buffer
public PrintWriter(OutputStream out) Details
Creates a new PrintWriter, without automatic line flushing, from an existing OutputStream. This convenience constructor creates the necessary intermediate OutputStreamWriter, which will convert characters into bytes using the default character encoding.
outAn output stream
See also OutputStreamWriter(java.io.OutputStream)
public PrintWriter(OutputStream out, boolean autoFlush) Details
Creates a new PrintWriter from an existing OutputStream. This convenience constructor creates the necessary intermediate OutputStreamWriter, which will convert characters into bytes using the default character encoding.
outAn output stream
autoFlushA boolean; if true, the println, printf, or format methods will flush the output buffer
See also OutputStreamWriter(java.io.OutputStream)
public PrintWriter(String fileName) throws FileNotFoundException Details
Creates a new PrintWriter, 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.
fileNameThe name of the file to use as the destination of this writer. 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.
ThrowsFileNotFoundException: If the given string 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
ThrowsSecurityException: If a security manager is present and checkWrite(fileName) denies write access to the file
since1.5
public PrintWriter(String fileName, String csn) throws FileNotFoundException, UnsupportedEncodingException Details
Creates a new PrintWriter, 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.
fileNameThe name of the file to use as the destination of this writer. 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.
csnThe name of a supported charset
ThrowsFileNotFoundException: If the given string 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
ThrowsSecurityException: If a security manager is present and checkWrite(fileName) denies write access to the file
ThrowsUnsupportedEncodingException: If the named charset is not supported
since1.5
public PrintWriter(File file) throws FileNotFoundException Details
Creates a new PrintWriter, 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.
fileThe file to use as the destination of this writer. 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.
ThrowsFileNotFoundException: 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
ThrowsSecurityException: If a security manager is present and checkWrite(file.getPath()) denies write access to the file
since1.5
public PrintWriter(File file, String csn) throws FileNotFoundException, UnsupportedEncodingException Details
Creates a new PrintWriter, 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.
fileThe file to use as the destination of this writer. 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.
csnThe name of a supported charset
ThrowsFileNotFoundException: 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
ThrowsSecurityException: If a security manager is present and checkWrite(file.getPath()) denies write access to the file
ThrowsUnsupportedEncodingException: If the named charset is not supported
since1.5

Methods
public PrintWriter append(CharSequence csq) Details
Appends the specified character sequence to this writer.

An invocation of this method of the form out.append(csq) behaves in exactly the same way as the invocation

     out.write(csq.toString()) 

Depending on the specification of toString for the character sequence csq, the entire sequence may not be appended. For instance, invoking the toString method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit.
csqThe character sequence to append. If csq is null, then the four characters "null" are appended to this writer.
returnThis writer
since1.5

public PrintWriter append(CharSequence csq, int start, int end) Details
Appends a subsequence of the specified character sequence to this writer.

An invocation of this method of the form out.append(csq, start, end) when csq is not null, behaves in exactly the same way as the invocation

     out.write(csq.subSequence(start, end).toString()) 
csqThe character sequence from which a subsequence will be appended. If csq is null, then characters will be appended as if csq contained the four characters "null".
startThe index of the first character in the subsequence
endThe index of the character following the last character in the subsequence
returnThis writer
ThrowsIndexOutOfBoundsException: If start or end are negative, start is greater than end, or end is greater than csq.length()
since1.5
public PrintWriter append(char c) Details
Appends the specified character to this writer.

An invocation of this method of the form out.append(c) behaves in exactly the same way as the invocation

     out.write(c) 
cThe 16-bit character to append
returnThis writer
since1.5
public boolean checkError() Details
Flushes the stream if it's not closed and checks its error state.
returntrue if the print stream has encountered an error, either on the underlying output stream or during a format conversion.
protected void clearError() Details
Clears the error state of this stream.

This method will cause subsequent invocations of #checkError() to return false until another write operation fails and invokes #setError().
since1.6

public void close() Details
Closes the stream and releases any system resources associated with it. Closing a previously closed stream has no effect.
See also checkError()
public void flush() Details
Flushes the stream.
See also checkError()
public PrintWriter format(String format, Object[] args) Details
Writes a formatted string to this writer using the specified format string and arguments. If automatic flushing is enabled, calls to this method will flush the output buffer.

The locale always used is the one returned by Locale.getDefault(), regardless of any previous invocations of other formatting methods on this object.
formatA format string as described in Format string syntax.
argsArguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by the Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.
ThrowsIllegalFormatException: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the Formatter class specification.
ThrowsNullPointerException: If the format is null
returnThis writer
since1.5

public PrintWriter format(Locale l, String format, Object[] args) Details
Writes a formatted string to this writer using the specified format string and arguments. If automatic flushing is enabled, calls to this method will flush the output buffer.
lThe locale to apply during formatting. If l is null then no localization is applied.
formatA format string as described in Format string syntax.
argsArguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by the Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.
ThrowsIllegalFormatException: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.
ThrowsNullPointerException: If the format is null
returnThis writer
since1.5
public void print(boolean b) Details
Prints a boolean value. The string produced by java.lang.String#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.
bThe boolean to be printed
public void print(char c) Details
Prints 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.
cThe char to be printed
public void print(int i) Details
Prints an integer. The string produced by java.lang.String#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.
iThe int to be printed
See also toString(int)
public void print(long l) Details
Prints a long integer. The string produced by java.lang.String#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.
lThe long to be printed
See also toString(long)
public void print(float f) Details
Prints a floating-point number. The string produced by java.lang.String#valueOf(float) 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.
fThe float to be printed
See also toString(float)
public void print(double d) Details
Prints a double-precision floating-point number. The string produced by java.lang.String#valueOf(double) 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.
dThe double to be printed
See also toString(double)
public void print(char[] s) Details
Prints 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.
sThe array of chars to be printed
ThrowsNullPointerException: If s is null
public void print(String s) Details
Prints 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.
sThe String to be printed
public void print(Object obj) Details
Prints an object. The string produced by the java.lang.String#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.
objThe Object to be printed
See also toString()
public PrintWriter printf(String format, Object[] args) Details
A convenience method to write a formatted string to this writer using the specified format string and arguments. If automatic flushing is enabled, calls to this method will flush the output buffer.

An invocation of this method of the form out.printf(format, args) behaves in exactly the same way as the invocation

     out.format(format, args) 
formatA format string as described in Format string syntax.
argsArguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by the Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.
ThrowsIllegalFormatException: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.
ThrowsNullPointerException: If the format is null
returnThis writer
since1.5
public PrintWriter printf(Locale l, String format, Object[] args) Details
A convenience method to write a formatted string to this writer using the specified format string and arguments. If automatic flushing is enabled, calls to this method will flush the output buffer.

An invocation of this method of the form out.printf(l, format, args) behaves in exactly the same way as the invocation

     out.format(l, format, args) 
lThe locale to apply during formatting. If l is null then no localization is applied.
formatA format string as described in Format string syntax.
argsArguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by the Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.
ThrowsIllegalFormatException: If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.
ThrowsNullPointerException: If the format is null
returnThis writer
since1.5
public void println()
Terminates 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 println(boolean x) Details
Prints a boolean value and then terminates the line. This method behaves as though it invokes #print(boolean) and then #println().
xthe boolean value to be printed
public void println(char x) Details
Prints a character and then terminates the line. This method behaves as though it invokes #print(char) and then #println().
xthe char value to be printed
public void println(int x) Details
Prints an integer and then terminates the line. This method behaves as though it invokes #print(int) and then #println().
xthe int value to be printed
public void println(long x) Details
Prints a long integer and then terminates the line. This method behaves as though it invokes #print(long) and then #println().
xthe long value to be printed
public void println(float x) Details
Prints a floating-point number and then terminates the line. This method behaves as though it invokes #print(float) and then #println().
xthe float value to be printed
public void println(double x) Details
Prints a double-precision floating-point number and then terminates the line. This method behaves as though it invokes #print(double) and then #println().
xthe double value to be printed
public void println(char[] x) Details
Prints an array of characters and then terminates the line. This method behaves as though it invokes #print(char[]) and then #println().
xthe array of char values to be printed
public void println(String x) Details
Prints a String and then terminates the line. This method behaves as though it invokes #print(String) and then #println().
xthe String value to be printed
public void println(Object x) Details
Prints an Object and then terminates the line. This method calls at first String.valueOf(x) to get the printed object's string value, then behaves as though it invokes #print(String) and then #println().
xThe Object to be printed.
public void write(int c) Details
Writes a single character.
cint specifying a character to be written.
public void write(char[] buf, int off, int len) Details
Writes A Portion of an array of characters.
bufArray of characters
offOffset from which to start writing characters
lenNumber of characters to write
public void write(char[] buf) Details
Writes an array of characters. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.
bufArray of characters to be written
public void write(String s, int off, int len) Details
Writes a portion of a string.
sA String
offOffset from which to start writing characters
lenNumber of characters to write
public void write(String s) Details
Writes a string. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.
sString to be written

Properties
protected void setError()
Indicates that an error has occurred.

This method will cause subsequent invocations of #checkError() to return true until #clearError() is invoked.