| java.lang.Object
 java.io.Writer
java.io.PrintWriter
| PrintWriter | | public class PrintWriter extends Writer (Code) | | 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
PrintWriter.checkError checkError() .
version:
1.49, 05/05/07
author:
Frank Yellin
author:
Mark Reinhold
since:
JDK1.1 |
| Field Summary | |
| protected Writer | out
The underlying character-output stream of this
PrintWriter. |
| Constructor Summary | |
| public | PrintWriter(Writer out)
Creates a new PrintWriter, without automatic line flushing. | | public | PrintWriter(Writer out, boolean autoFlush)
Creates a new PrintWriter. | | public | PrintWriter(OutputStream out)
Creates a new PrintWriter, without automatic line flushing, from an
existing OutputStream. | | public | PrintWriter(OutputStream out, boolean autoFlush)
Creates a new PrintWriter from an existing OutputStream. | | public | PrintWriter(String fileName)
Creates a new PrintWriter, without automatic line flushing, with the
specified file name. | | public | PrintWriter(String fileName, String csn)
Creates a new PrintWriter, without automatic line flushing, with the
specified file name and charset. | | public | PrintWriter(File file)
Creates a new PrintWriter, without automatic line flushing, with the
specified file. | | public | PrintWriter(File file, String csn)
Creates a new PrintWriter, without automatic line flushing, with the
specified file and charset. |
| Method Summary | |
| public PrintWriter | append(CharSequence csq)
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. | | public PrintWriter | append(CharSequence csq, int start, int end)
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())
Parameters:
csq - The character sequence from which a subsequence will beappended. | | public PrintWriter | append(char c)
Appends the specified character to this writer. | | public boolean | checkError()
Flushes the stream if it's not closed and checks its error state. | | protected void | clearError()
Clears the error state of this stream. | | public void | close()
Closes the stream and releases any system resources associated
with it. | | public void | flush()
Flushes the stream. | | public PrintWriter | format(String format, Object... args)
Writes a formatted string to this writer using the specified format
string and arguments. | | public PrintWriter | format(Locale l, String format, Object... args)
Writes a formatted string to this writer using the specified format
string and arguments. | | public void | print(boolean b)
Prints a boolean value. | | public void | print(char c)
Prints a character. | | public void | print(int i)
Prints an integer. | | public void | print(long l)
Prints a long integer. | | public void | print(float f)
Prints a floating-point number. | | public void | print(double d)
Prints a double-precision floating-point number. | | public void | print(char s)
Prints an array of characters. | | public void | print(String s)
Prints a string. | | public void | print(Object obj)
Prints an object. | | public PrintWriter | printf(String format, Object... args)
A convenience method to write a formatted string to this writer using
the specified format string and arguments. | | public PrintWriter | printf(Locale l, String format, Object... args)
A convenience method to write a formatted string to this writer using
the specified format string and arguments. | | public void | println()
Terminates the current line by writing the line separator string. | | public void | println(boolean x)
Prints a boolean value and then terminates the line. | | public void | println(char x)
Prints a character and then terminates the line. | | public void | println(int x)
Prints an integer and then terminates the line. | | public void | println(long x)
Prints a long integer and then terminates the line. | | public void | println(float x)
Prints a floating-point number and then terminates the line. | | public void | println(double x)
Prints a double-precision floating-point number and then terminates the
line. | | public void | println(char x)
Prints an array of characters and then terminates the line. | | public void | println(String x)
Prints a String and then terminates the line. | | public void | println(Object x)
Prints an Object and then terminates the line. | | protected void | setError()
Indicates that an error has occurred. | | public void | write(int c)
Writes a single character. | | public void | write(char buf, int off, int len)
Writes A Portion of an array of characters. | | public void | write(char buf)
Writes an array of characters. | | public void | write(String s, int off, int len)
Writes a portion of a string. | | public void | write(String s)
Writes a string. |
| out | | protected Writer out(Code) | | The underlying character-output stream of this
PrintWriter.
since:
1.2 |
| PrintWriter | | public PrintWriter(Writer out)(Code) | | Creates a new PrintWriter, without automatic line flushing.
Parameters:
out - A character-output stream |
| PrintWriter | | public PrintWriter(Writer out, boolean autoFlush)(Code) | | Creates a new PrintWriter.
Parameters:
out - A character-output stream
Parameters:
autoFlush - A boolean; if true, the println,printf, or format methods willflush the output buffer |
| PrintWriter | | public PrintWriter(OutputStream out, boolean autoFlush)(Code) | | 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.
Parameters:
out - An output stream
Parameters:
autoFlush - A boolean; if true, the println,printf, or format methods willflush the output buffer
See Also: java.io.OutputStreamWriter.OutputStreamWriter(java.io.OutputStream) |
| PrintWriter | | public PrintWriter(String fileName) throws FileNotFoundException(Code) | | Creates a new PrintWriter, without automatic line flushing, with the
specified file name. This convenience constructor creates the necessary
intermediate
java.io.OutputStreamWriter OutputStreamWriter ,
which will encode characters using the
for this
instance of the Java virtual machine.
Parameters:
fileName - The 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 bewritten to the file and is buffered.
throws:
FileNotFoundException - If the given string does not denote an existing, writableregular file and a new regular file of that name cannot becreated, or if some other error occurs while opening orcreating the file
throws:
SecurityException - If a security manager is present and SecurityManager.checkWrite checkWrite(fileName) denies writeaccess to the file
since:
1.5 |
| PrintWriter | | public PrintWriter(String fileName, String csn) throws FileNotFoundException, UnsupportedEncodingException(Code) | | Creates a new PrintWriter, without automatic line flushing, with the
specified file name and charset. This convenience constructor creates
the necessary intermediate
java.io.OutputStreamWriterOutputStreamWriter , which will encode characters using the provided
charset.
Parameters:
fileName - The 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 bewritten to the file and is buffered.
Parameters:
csn - The name of a supported
throws:
FileNotFoundException - If the given string does not denote an existing, writableregular file and a new regular file of that name cannot becreated, or if some other error occurs while opening orcreating the file
throws:
SecurityException - If a security manager is present and SecurityManager.checkWrite checkWrite(fileName) denies writeaccess to the file
throws:
UnsupportedEncodingException - If the named charset is not supported
since:
1.5 |
| PrintWriter | | public PrintWriter(File file) throws FileNotFoundException(Code) | | Creates a new PrintWriter, without automatic line flushing, with the
specified file. This convenience constructor creates the necessary
intermediate
java.io.OutputStreamWriter OutputStreamWriter ,
which will encode characters using the
for this
instance of the Java virtual machine.
Parameters:
file - The file to use as the destination of this writer. If the fileexists then it will be truncated to zero size; otherwise, a newfile will be created. The output will be written to the fileand is buffered.
throws:
FileNotFoundException - If the given file object does not denote an existing, writableregular file and a new regular file of that name cannot becreated, or if some other error occurs while opening orcreating the file
throws:
SecurityException - If a security manager is present and SecurityManager.checkWrite checkWrite(file.getPath())denies write access to the file
since:
1.5 |
| PrintWriter | | public PrintWriter(File file, String csn) throws FileNotFoundException, UnsupportedEncodingException(Code) | | Creates a new PrintWriter, without automatic line flushing, with the
specified file and charset. This convenience constructor creates the
necessary intermediate
java.io.OutputStreamWriterOutputStreamWriter , which will encode characters using the provided
charset.
Parameters:
file - The file to use as the destination of this writer. If the fileexists then it will be truncated to zero size; otherwise, a newfile will be created. The output will be written to the fileand is buffered.
Parameters:
csn - The name of a supported
throws:
FileNotFoundException - If the given file object does not denote an existing, writableregular file and a new regular file of that name cannot becreated, or if some other error occurs while opening orcreating the file
throws:
SecurityException - If a security manager is present and SecurityManager.checkWrite checkWrite(file.getPath())denies write access to the file
throws:
UnsupportedEncodingException - If the named charset is not supported
since:
1.5 |
| append | | public PrintWriter append(CharSequence csq)(Code) | | 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.
Parameters:
csq - The character sequence to append. If csq isnull, then the four characters "null" areappended to this writer. This writer
since:
1.5 |
| append | | public PrintWriter append(CharSequence csq, int start, int end)(Code) | | 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())
Parameters:
csq - The character sequence from which a subsequence will beappended. If csq is null, then characterswill be appended as if csq contained the fourcharacters "null".
Parameters:
start - The index of the first character in the subsequence
Parameters:
end - The index of the character following the last character in thesubsequence This writer
throws:
IndexOutOfBoundsException - If start or end are negative, startis greater than end, or end is greater thancsq.length()
since:
1.5 |
| append | | public PrintWriter append(char c)(Code) | | 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)
Parameters:
c - The 16-bit character to append This writer
since:
1.5 |
| checkError | | public boolean checkError()(Code) | | Flushes the stream if it's not closed and checks its error state.
true if the print stream has encountered an error,either on the underlying output stream or during a formatconversion. |
| close | | public void close()(Code) | | Closes the stream and releases any system resources associated
with it. Closing a previously closed stream has no effect.
See Also: PrintWriter.checkError() |
| format | | public PrintWriter format(String format, Object... args)(Code) | | 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
java.util.Locale.getDefault Locale.getDefault() , regardless of any
previous invocations of other formatting methods on this object.
Parameters:
format - A format string as described in Format string syntax.
Parameters:
args - Arguments referenced by the format specifiers in the formatstring. If there are more arguments than format specifiers, theextra arguments are ignored. The number of arguments isvariable and may be zero. The maximum number of arguments islimited by the maximum dimension of a Java array as defined bythe JavaVirtual Machine Specification. The behaviour on anull argument depends on the conversion.
throws:
IllegalFormatException - If a format string contains an illegal syntax, a formatspecifier that is incompatible with the given arguments,insufficient arguments given the format string, or otherillegal conditions. For specification of all possibleformatting errors, see the Details section of theFormatter class specification.
throws:
NullPointerException - If the format is null This writer
since:
1.5 |
| format | | public PrintWriter format(Locale l, String format, Object... args)(Code) | | 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.
Parameters:
l - The to apply duringformatting. If l is null then no localizationis applied.
Parameters:
format - A format string as described in Format string syntax.
Parameters:
args - Arguments referenced by the format specifiers in the formatstring. If there are more arguments than format specifiers, theextra arguments are ignored. The number of arguments isvariable and may be zero. The maximum number of arguments islimited by the maximum dimension of a Java array as defined bythe JavaVirtual Machine Specification. The behaviour on anull argument depends on the conversion.
throws:
IllegalFormatException - If a format string contains an illegal syntax, a formatspecifier that is incompatible with the given arguments,insufficient arguments given the format string, or otherillegal conditions. For specification of all possibleformatting errors, see the Details section of theformatter class specification.
throws:
NullPointerException - If the format is null This writer
since:
1.5 |
| print | | public void print(boolean b)(Code) | | 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
PrintWriter.write(int) method.
Parameters:
b - The boolean to be printed |
| print | | public void print(char c)(Code) | | 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
PrintWriter.write(int) method.
Parameters:
c - The char to be printed |
| print | | public void print(char s)(Code) | | 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
PrintWriter.write(int)
method.
Parameters:
s - The array of chars to be printed
throws:
NullPointerException - If s is null |
| print | | public void print(String s)(Code) | | 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
PrintWriter.write(int) method.
Parameters:
s - The String to be printed |
| printf | | public PrintWriter printf(String format, Object... args)(Code) | | 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)
Parameters:
format - A format string as described in Format string syntax.
Parameters:
args - Arguments referenced by the format specifiers in the formatstring. If there are more arguments than format specifiers, theextra arguments are ignored. The number of arguments isvariable and may be zero. The maximum number of arguments islimited by the maximum dimension of a Java array as defined bythe JavaVirtual Machine Specification. The behaviour on anull argument depends on the conversion.
throws:
IllegalFormatException - If a format string contains an illegal syntax, a formatspecifier that is incompatible with the given arguments,insufficient arguments given the format string, or otherillegal conditions. For specification of all possibleformatting errors, see the Details section of theformatter class specification.
throws:
NullPointerException - If the format is null This writer
since:
1.5 |
| printf | | public PrintWriter printf(Locale l, String format, Object... args)(Code) | | 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)
Parameters:
l - The to apply duringformatting. If l is null then no localizationis applied.
Parameters:
format - A format string as described in Format string syntax.
Parameters:
args - Arguments referenced by the format specifiers in the formatstring. If there are more arguments than format specifiers, theextra arguments are ignored. The number of arguments isvariable and may be zero. The maximum number of arguments islimited by the maximum dimension of a Java array as defined bythe JavaVirtual Machine Specification. The behaviour on anull argument depends on the conversion.
throws:
IllegalFormatException - If a format string contains an illegal syntax, a formatspecifier that is incompatible with the given arguments,insufficient arguments given the format string, or otherillegal conditions. For specification of all possibleformatting errors, see the Details section of theformatter class specification.
throws:
NullPointerException - If the format is null This writer
since:
1.5 |
| println | | public void println()(Code) | | 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').
|
| println | | public void println(double x)(Code) | | Prints a double-precision floating-point number and then terminates the
line. This method behaves as though it invokes
PrintWriter.print(double) and then
PrintWriter.println() .
Parameters:
x - the double value to be printed |
| println | | public void println(Object x)(Code) | | 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
PrintWriter.print(String) and then
PrintWriter.println() .
Parameters:
x - The Object to be printed. |
| write | | public void write(int c)(Code) | | Writes a single character.
Parameters:
c - int specifying a character to be written. |
| write | | public void write(char buf, int off, int len)(Code) | | Writes A Portion of an array of characters.
Parameters:
buf - Array of characters
Parameters:
off - Offset from which to start writing characters
Parameters:
len - Number of characters to write |
| write | | public void write(char buf)(Code) | | Writes an array of characters. This method cannot be inherited from the
Writer class because it must suppress I/O exceptions.
Parameters:
buf - Array of characters to be written |
| write | | public void write(String s, int off, int len)(Code) | | Writes a portion of a string.
Parameters:
s - A String
Parameters:
off - Offset from which to start writing characters
Parameters:
len - Number of characters to write |
| write | | public void write(String s)(Code) | | Writes a string. This method cannot be inherited from the Writer class
because it must suppress I/O exceptions.
Parameters:
s - String to be written |
|
|