java.lang.Object java.io.OutputStream java.io.FilterOutputStream java.io.PrintStream
public class PrintStream
A PrintStream
adds functionality to another output stream, namely the ability to print representations of various data values conveniently. Two other features are provided as well. Unlike other output streams, a PrintStream
never throws an IOException
; instead, exceptional situations merely set an internal flag that can be tested via the checkError
method. Optionally, a PrintStream
can be created so as to flush automatically; this means that the flush
method is automatically invoked after a byte array is written, one of the println
methods is invoked, or a newline character or byte ('\n'
) is written.
All characters printed by a PrintStream
are converted into bytes using the platform's default character encoding. The
class should be used in situations that require writing characters rather than bytes.PrintWriter
PrintStream(File file)
PrintStream(File file, String csn)
PrintStream(OutputStream out)
PrintStream(OutputStream out, boolean autoFlush)
PrintStream(OutputStream out, boolean autoFlush, String encoding)
PrintStream(String fileName)
PrintStream(String fileName, String csn)
PrintStream
append(char c)
PrintStream
append(CharSequence csq)
PrintStream
append(CharSequence csq, int start, int end)
boolean
checkError()
void
close()
void
flush()
PrintStream
format(Locale l, String format, Object... args)
PrintStream
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)
PrintStream
printf(Locale l, String format, Object... args)
PrintStream
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()
true
. void
write(byte[] buf, int off, int len)
len
bytes from the specified byte array starting at offset off
to this stream. void
write(int b)
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
PrintStream
public PrintStream(OutputStream out)
out
- The output stream to which values and objects will be printed
PrintWriter.PrintWriter(java.io.OutputStream)
public PrintStream(OutputStream out, boolean autoFlush)
out
- The output stream to which values and objects will be printed
autoFlush
- A boolean; if true, the output buffer will be flushed whenever a byte array is written, one of the println
methods is invoked, or a newline character or byte ('\n'
) is written
PrintWriter.PrintWriter(java.io.OutputStream, boolean)
public PrintStream(OutputStream out, boolean autoFlush, String encoding) throws UnsupportedEncodingException
out
- The output stream to which values and objects will be printed
autoFlush
- A boolean; if true, the output buffer will be flushed whenever a byte array is written, one of the println
methods is invoked, or a newline character or byte ('\n'
) is written
encoding
- The name of a supported character encoding
UnsupportedEncodingException
- If the named encoding is not supported
public PrintStream(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 print stream. 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(fileName)
denies write access to the file
public PrintStream(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 print stream. 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(fileName)
denies write access to the file
UnsupportedEncodingException
- If the named charset is not supported
public PrintStream(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 print stream. 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 PrintStream(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 print stream. 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 presentand 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 FilterOutputStream
OutputStream.flush()
public void close()
close
in interface Closeable
close
in class FilterOutputStream
OutputStream.close()
public boolean checkError()
true
when the underlying output stream throws an IOException
other than InterruptedIOException
, and when the setError
method is invoked. If an operation on the underlying output stream throws an InterruptedIOException
, then the PrintStream
converts the exception back into an interrupt by doing:
Thread.currentThread().interrupt();or the equivalent.
IOException
other than InterruptedIOException
, or the setError
method has been invoked
protected void setError()
true
.
public void write(int b)
flush
method will be invoked.
Note that the byte is written as given; to write a character that will be translated according to the platform's default character encoding, use the print(char)
or println(char)
methods.
write
in class FilterOutputStream
b
- The byte to be written
print(char)
, println(char)
public void write(byte[] buf, int off, int len)
len
bytes from the specified byte array starting at offset off
to this stream. If automatic flushing is enabled then the flush
method will be invoked.
Note that the bytes will be written as given; to write characters that will be translated according to the platform's default character encoding, use the print(char)
or println(char)
methods.
write
in class FilterOutputStream
buf
- A byte array
off
- Offset from which to start taking bytes
len
- Number of bytes to write
FilterOutputStream.write(int)
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
to be printed
public void println(char x)
print(char)
and then println()
.
x
- The char
to be printed.
public void println(int x)
print(int)
and then println()
.
x
- The int
to be printed.
public void println(long x)
print(long)
and then println()
.
x
- a The long
to be printed.
public void println(float x)
print(float)
and then println()
.
x
- The float
to be printed.
public void println(double x)
print(double)
and then println()
.
x
- The double
to be printed.
public void println(char[] x)
print(char[])
and then println()
.
x
- an array of chars to print.
public void println(String x)
print(String)
and then println()
.
x
- The String
to be printed.
public void println(Object x)
print(Object)
and then println()
.
x
- The Object
to be printed.
public PrintStream 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 PrintStream 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 PrintStream 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 PrintStream 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 PrintStream append(CharSequence csq)
An invocation of this method of the form out.append(csq) behaves in exactly the same way as the invocation
out.print(csq.toString())
Depending on the specification of toString for the character sequence csq, the entire sequence may not be appended. appended. For instance, invoking then toString method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit.
append
in interface Appendable
csq
- The character sequence to append. If csq is null, then the four characters "null" are appended to this output stream.
public PrintStream 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.print(csq.subSequence(start, end).toString())
append
in interface Appendable
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 PrintStream append(char c)
An invocation of this method of the form out.append(c) behaves in exactly the same way as the invocation
out.print(c)
append
in interface Appendable
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