| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
OutputStream out = …;
PrintWriter p = new PrintWriter(out);
Based on 15 examples
OutputStream out = …;
boolean autoFlush = …;
PrintWriter p = new PrintWriter(out, autoFlush);
Based on 15 examples
StringWriter stringWriter = …;
PrintWriter printWriter = new PrintWriter(stringWriter);
Based on 14 examples
public class PrintWriter extends Writer
Prints formatted representations of objects to a text-output stream. This class implements all of the print methods found in {@link PrintStream}. It does not contain methods for writing raw bytes, for which a program should use unencoded byte streams.
Unlike the {@link 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 {@link #checkError checkError()}.
Field Summary | |
---|---|
protected Writer |
out
The underlying character-output stream of this PrintWriter . |
Fields inherited from class java.io.Writer |
---|
lock |
Constructor Summary | |
---|---|
PrintWriter(File file) Creates a new PrintWriter, without automatic line flushing, with the specified file. |
|
PrintWriter(File file, String csn) Creates a new PrintWriter, without automatic line flushing, with the specified file and charset. |
|
PrintWriter(OutputStream out) Creates a new PrintWriter, without automatic line flushing, from an existing OutputStream. |
|
PrintWriter(OutputStream out, boolean autoFlush) Creates a new PrintWriter from an existing OutputStream. |
|
PrintWriter(String fileName) Creates a new PrintWriter, without automatic line flushing, with the specified file name. |
|
PrintWriter(String fileName, String csn) Creates a new PrintWriter, without automatic line flushing, with the specified file name and charset. |
|
PrintWriter(Writer out) Creates a new PrintWriter, without automatic line flushing. |
|
PrintWriter(Writer out, boolean autoFlush) Creates a new PrintWriter. |
Method Summary | |
---|---|
PrintWriter |
append(char c) Appends the specified character to this writer. |
PrintWriter |
append(CharSequence csq) Appends the specified character sequence to this writer. |
PrintWriter |
append(CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this writer. |
boolean |
Flushes the stream if it's not closed and checks its error state. |
protected void |
Clears the error state of this stream. |
void |
close() Closes the stream and releases any system resources associated with it. |
void |
flush() Flushes the stream. |
PrintWriter |
Writes a formatted string to this writer using the specified format string and arguments. |
PrintWriter |
Writes a formatted string to this writer using the specified format string and arguments. |
void |
print(boolean b) Prints a boolean value. |
void |
print(char c) Prints a character. |
void |
print(char[] s) Prints an array of characters. |
void |
print(double d) Prints a double-precision floating-point number. |
void |
print(float f) Prints a floating-point number. |
void |
print(int i) Prints an integer. |
void |
print(long l) Prints a long integer. |
void |
Prints an object. |
void |
Prints a string. |
PrintWriter |
A convenience method to write a formatted string to this writer using the specified format string and arguments. |
PrintWriter |
A convenience method to write a formatted string to this writer using the specified format string and arguments. |
void |
println() Terminates the current line by writing the line separator string. |
void |
println(boolean x) Prints a boolean value and then terminates the line. |
void |
println(char x) Prints a character and then terminates the line. |
void |
println(char[] x) Prints an array of characters and then terminates the line. |
void |
println(double x) Prints a double-precision floating-point number and then terminates the line. |
void |
println(float x) Prints a floating-point number and then terminates the line. |
void |
println(int x) Prints an integer and then terminates the line. |
void |
println(long x) Prints a long integer and then terminates the line. |
void |
Prints an Object and then terminates the line. |
void |
Prints a String and then terminates the line. |
protected void |
setError() Indicates that an error has occurred. |
void |
write(char[] buf) Writes an array of characters. |
void |
write(char[] buf, int off, int len) Writes A Portion of an array of characters. |
void |
write(int c) Writes a single character. |
void |
Writes a string. |
void |
Writes a portion of a string. |
Methods inherited from class java.io.Writer |
---|
append, append, append, close, flush, write, write, write, write, write |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected Writer out
PrintWriter
.
Constructor Detail |
---|
public PrintWriter(File file) throws FileNotFoundException
file
- 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.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 filepublic PrintWriter(File file, String csn) throws FileNotFoundException, UnsupportedEncodingException
file
- 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.csn
- The name of a supported {@linkplain java.nio.charset.Charset
charset}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 fileUnsupportedEncodingException
- If the named charset is not supportedpublic PrintWriter(OutputStream out)
out
- An output streampublic PrintWriter(OutputStream out, boolean autoFlush)
out
- An output streamautoFlush
- A boolean; if true, the println,
printf, or format methods will
flush the output bufferpublic PrintWriter(String fileName) throws FileNotFoundException
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 be
written to the file and is buffered.FileNotFoundException
- 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 filepublic PrintWriter(String fileName, String csn) throws FileNotFoundException, UnsupportedEncodingException
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 be
written to the file and is buffered.csn
- The name of a supported {@linkplain java.nio.charset.Charset
charset}FileNotFoundException
- 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 fileUnsupportedEncodingException
- If the named charset is not supportedpublic PrintWriter(Writer out)
out
- A character-output streampublic PrintWriter(Writer out, boolean autoFlush)
out
- A character-output streamautoFlush
- A boolean; if true, the println,
printf, or format methods will
flush the output bufferMethod Detail |
---|
public PrintWriter append(char c)
An invocation of this method of the form out.append(c) behaves in exactly the same way as the invocation
out.write(c)
append
in class Writer
c
- The 16-bit character to appendpublic PrintWriter append(CharSequence csq)
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.
append
in class Writer
csq
- The character sequence to append. If csq is
null, then the four characters "null" are
appended to this writer.public PrintWriter append(CharSequence csq, int start, int end)
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())
append
in class Writer
csq
- The 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".start
- The index of the first character in the subsequenceend
- The index of the character following the last character in the
subsequencepublic boolean checkError()
true
if the print stream has encountered an error,
either on the underlying output stream or during a format
conversion.protected void clearError()
This method will cause subsequent invocations of {@link #checkError()} to return false until another write operation fails and invokes {@link #setError()}.
public void close()
close
in class Writer
public void flush()
flush
in class Writer
public PrintWriter format(Locale l, String format, Object[] args)
l
- The {@linkplain java.util.Locale locale} to apply during
formatting. If l is null then no localization
is applied.format
- A format string as described in Format string syntax.args
- Arguments 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.public PrintWriter format(String format, Object[] args)
The locale always used is the one returned by {@link java.util.Locale#getDefault() Locale.getDefault()}, regardless of any previous invocations of other formatting methods on this object.
format
- A format string as described in Format string syntax.args
- Arguments 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.public void print(boolean b)
{@link
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 {@link
#write(int)}
method.
b
- The boolean
to be printedpublic void print(char c)
{@link
#write(int)}
method.
c
- The char
to be printedpublic void print(char[] s)
{@link #write(int)}
method.
s
- The array of chars to be printedpublic void print(double d)
{@link 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 {@link
#write(int)}
method.
d
- The double
to be printedpublic void print(float f)
{@link
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 {@link #write(int)}
method.
f
- The float
to be printedpublic void print(int i)
{@link
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 {@link #write(int)}
method.
i
- The int
to be printedpublic void print(long l)
{@link
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 {@link #write(int)}
method.
l
- The long
to be printedpublic void print(Object obj)
{@link
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 {@link #write(int)}
method.
obj
- The Object
to be printedpublic void print(String s)
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
{@link #write(int)}
method.
s
- The String
to be printedpublic PrintWriter printf(Locale l, String format, Object[] args)
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)
l
- The {@linkplain java.util.Locale locale} to apply during
formatting. If l is null then no localization
is applied.format
- A format string as described in Format string syntax.args
- Arguments 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.public PrintWriter printf(String format, Object[] args)
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)
format
- A format string as described in Format string syntax.args
- Arguments 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.public void println()
line.separator
, and is not necessarily a single newline
character ('\n'
).
public void println(boolean x)
{@link #print(boolean)}
and then
{@link #println()}
.
x
- the boolean
value to be printedpublic void println(char x)
{@link #print(char)}
and then {@link
#println()}
.
x
- the char
value to be printedpublic void println(char[] x)
{@link #print(char[])}
and then
{@link #println()}
.
x
- the array of char
values to be printedpublic void println(double x)
{@link
#print(double)}
and then {@link #println()}
.
x
- the double
value to be printedpublic void println(float x)
{@link #print(float)}
and then
{@link #println()}
.
x
- the float
value to be printedpublic void println(int x)
{@link #print(int)}
and then {@link
#println()}
.
x
- the int
value to be printedpublic void println(long x)
{@link #print(long)}
and then
{@link #println()}
.
x
- the long
value to be printedpublic void println(Object x)
{@link #print(String)}
and then
{@link #println()}
.
x
- The Object
to be printed.public void println(String x)
{@link #print(String)}
and then
{@link #println()}
.
x
- the String
value to be printedprotected void setError()
This method will cause subsequent invocations of {@link #checkError()} to return true until {@link #clearError()} is invoked.
public void write(char[] buf)
write
in class Writer
buf
- Array of characters to be writtenpublic void write(char[] buf, int off, int len)
write
in class Writer
buf
- Array of charactersoff
- Offset from which to start writing characterslen
- Number of characters to writepublic void write(int c)
write
in class Writer
c
- int specifying a character to be written.public void write(String s)
write
in class Writer
s
- String to be writtenpublic void write(String s, int off, int len)
write
in class Writer
s
- A Stringoff
- Offset from which to start writing characterslen
- Number of characters to write
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |