java.lang.Object java.io.Writer java.io.PrintWriter
public class PrintWriter
Print 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()
.
protected Writer
out
PrintWriter
. Constructor Summary PrintWriter(File file)
PrintWriter(File file, String csn)
PrintWriter(OutputStream out)
PrintWriter(OutputStream out, boolean autoFlush)
PrintWriter(String fileName)
PrintWriter(String fileName, String csn)
PrintWriter(Writer out)
PrintWriter(Writer out, boolean autoFlush)
PrintWriter
append(char c)
PrintWriter
append(CharSequence csq)
PrintWriter
append(CharSequence csq, int start, int end)
boolean
checkError()
void
close()
void
flush()
PrintWriter
format(Locale l, String format, Object... args)
PrintWriter
format(String format, Object... args)
void
print(boolean b)
void
print(char c)
void
print(char[] s)
void
print(double d)
void
print(float f)
void
print(int i)
void
print(long l)
void
print(Object obj)
void
print(String s)
PrintWriter
printf(Locale l, String format, Object... args)
PrintWriter
printf(String format, Object... args)
void
println()
void
println(boolean x)
void
println(char x)
void
println(char[] x)
void
println(double x)
void
println(float x)
void
println(int x)
void
println(long x)
void
println(Object x)
void
println(String x)
protected void
setError()
void
write(char[] buf)
void
write(char[] buf, int off, int len)
void
write(int c)
void
write(String s)
void
write(String s, int off, int len)
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
out
protected Writer out
PrintWriter
.
public PrintWriter(Writer out)
out
- A character-output stream
public PrintWriter(Writer out, boolean autoFlush)
out
- A character-output stream
autoFlush
- A boolean; if true, the println, printf, or format methods will flush the output buffer
public PrintWriter(OutputStream out)
out
- An output stream
OutputStreamWriter.OutputStreamWriter(java.io.OutputStream)
public PrintWriter(OutputStream out, boolean autoFlush)
out
- An output stream
autoFlush
- A boolean; if true, the println, printf, or format methods will flush the output buffer
OutputStreamWriter.OutputStreamWriter(java.io.OutputStream)
public PrintWriter(String fileName) throws FileNotFoundException
OutputStreamWriter
, which will encode characters using the default charset for this instance of the Java virtual machine.
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 file
SecurityException
- If a security manager is present and checkWrite(fileName)
denies write access to the file
public PrintWriter(String fileName, String csn) throws FileNotFoundException, UnsupportedEncodingException
OutputStreamWriter
, which will encode characters using the provided charset.
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 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 file
SecurityException
- If a security manager is present and checkWrite(fileName)
denies write access to the file
UnsupportedEncodingException
- If the named charset is not supported
public PrintWriter(File file) throws FileNotFoundException
OutputStreamWriter
, which will encode characters using the default charset for this instance of the Java virtual machine.
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 file
SecurityException
- If a security manager is present and checkWrite(file.getPath())
denies write access to the file
public PrintWriter(File file, String csn) throws FileNotFoundException, UnsupportedEncodingException
OutputStreamWriter
, which will encode characters using the provided charset.
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 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 file
SecurityException
- If a security manager is present and checkWrite(file.getPath())
denies write access to the file
UnsupportedEncodingException
- If the named charset is not supported
public void flush()
flush
in interface Flushable
flush
in class Writer
checkError()
public void close()
close
in interface Closeable
close
in class Writer
checkError()
public boolean checkError()
protected void setError()
public void write(int c)
write
in class Writer
c
- int specifying a character to be written.
public void write(char[] buf, int off, int len)
write
in class Writer
buf
- Array of characters
off
- Offset from which to start writing characters
len
- Number of characters to write
public void write(char[] buf)
write
in class Writer
buf
- Array of characters to be written
public void write(String s, int off, int len)
write
in class Writer
s
- A String
off
- Offset from which to start writing characters
len
- Number of characters to write
public void write(String s)
write
in class Writer
s
- String to be written
public void print(boolean b)
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.
b
- The boolean
to be printed
public void print(char c)
write(int)
method.
c
- The char
to be printed
public void print(int i)
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.
i
- The int
to be printed
Integer.toString(int)
public void print(long l)
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.
l
- The long
to be printed
Long.toString(long)
public void print(float f)
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.
f
- The float
to be printed
Float.toString(float)
public void print(double d)
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.
d
- The double
to be printed
Double.toString(double)
public void print(char[] s)
write(int)
method.
s
- The array of chars to be printed
NullPointerException
- If s
is null
public 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 write(int)
method.
s
- The String
to be printed
public void print(Object obj)
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.
obj
- The Object
to be printed
Object.toString()
public void println()
line.separator
, and is not necessarily a single newline character ('\n'
).
public void println(boolean x)
print(boolean)
and then println()
.
x
- the boolean
value to be printed
public void println(char x)
print(char)
and then println()
.
x
- the char
value to be printed
public void println(int x)
print(int)
and then println()
.
x
- the int
value to be printed
public void println(long x)
print(long)
and then println()
.
x
- the long
value to be printed
public void println(float x)
print(float)
and then println()
.
x
- the float
value to be printed
public void println(double x)
print(double)
and then println()
.
x
- the double
value to be printed
public void println(char[] x)
print(char[])
and then println()
.
x
- the array of char
values to be printed
public void println(String x)
print(String)
and then println()
.
x
- the String
value to be printed
public void println(Object x)
print(Object)
and then println()
.
x
- the Object
value to be printed
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.
IllegalFormatException
- 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.
NullPointerException
- If the format is null
public 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 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.
IllegalFormatException
- 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.
NullPointerException
- If the format is null
public PrintWriter format(String format, Object... args)
The locale always used is the one returned by 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.
IllegalFormatException
- 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.
NullPointerException
- If the format is null
public PrintWriter format(Locale l, String format, Object... args)
l
- The 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.
IllegalFormatException
- 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.
NullPointerException
- If the format is null
public 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 interface Appendable
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 interface Appendable
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 subsequence
end
- The index of the character following the last character in the subsequence
IndexOutOfBoundsException
- If start or end are negative, start is greater than end, or end is greater than csq.length()
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 interface Appendable
append
in class Writer
c
- The 16-bit character to append
Copyright © 2004, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4