| java.lang.Object
 java.io.OutputStream
java.io.FilterOutputStream
java.io.PrintStream
| PrintStream | | public class PrintStream extends FilterOutputStream implements Appendable,Closeable(Code) | | 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
PrintWriter class should be used in situations that require writing
characters rather than bytes.
version:
1.46, 07/05/05
author:
Frank Yellin
author:
Mark Reinhold
since:
JDK1.0 |
| Constructor Summary | |
| public | PrintStream(OutputStream out)
Creates a new print stream. | | public | PrintStream(OutputStream out, boolean autoFlush)
Creates a new print stream. | | public | PrintStream(OutputStream out, boolean autoFlush, String encoding)
Creates a new print stream. | | public | PrintStream(String fileName)
Creates a new print stream, without automatic line flushing, with the
specified file name. | | public | PrintStream(String fileName, String csn)
Creates a new print stream, without automatic line flushing, with the
specified file name and charset. | | public | PrintStream(File file)
Creates a new print stream, without automatic line flushing, with the
specified file. | | public | PrintStream(File file, String csn)
Creates a new print stream, without automatic line flushing, with the
specified file and charset. |
| Method Summary | |
| public PrintStream | append(CharSequence csq)
Appends the specified character sequence to this output stream.
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. | | public PrintStream | append(CharSequence csq, int start, int end)
Appends a subsequence of the specified character sequence to this output
stream. | | public PrintStream | append(char c)
Appends the specified character to this output stream. | | public boolean | checkError()
Flushes the stream and checks its error state. | | protected void | clearError()
Clears the internal error state of this stream. | | public void | close()
Closes the stream. | | public void | flush()
Flushes the stream. | | public PrintStream | format(String format, Object... args)
Writes a formatted string to this output stream using the specified
format string and arguments.
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. | | public PrintStream | format(Locale l, String format, Object... args)
Writes a formatted string to this output stream using the specified
format string and arguments.
Parameters:
l - The to apply duringformatting. | | 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 PrintStream | printf(String format, Object... args)
A convenience method to write a formatted string to this output stream
using the specified format string and arguments.
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. | | public PrintStream | printf(Locale l, String format, Object... args)
A convenience method to write a formatted string to this output stream
using the specified format string and arguments.
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. | | public void | println()
Terminates the current line by writing the line separator string. | | public void | println(boolean x)
Prints a boolean and then terminate the line. | | public void | println(char x)
Prints a character and then terminate the line. | | public void | println(int x)
Prints an integer and then terminate the line. | | public void | println(long x)
Prints a long and then terminate the line. | | public void | println(float x)
Prints a float and then terminate the line. | | public void | println(double x)
Prints a double and then terminate the line. | | public void | println(char x)
Prints an array of characters and then terminate the line. | | public void | println(String x)
Prints a String and then terminate the line. | | public void | println(Object x)
Prints an Object and then terminate the line. | | protected void | setError()
Sets the error state of the stream to true. | | public void | write(int b)
Writes the specified byte to this stream. | | public void | write(byte buf, int off, int len)
Writes len bytes from the specified byte array starting at
offset off to this stream. |
| PrintStream | | public PrintStream(OutputStream out, boolean autoFlush)(Code) | | Creates a new print stream.
Parameters:
out - The output stream to which values and objects will beprinted
Parameters:
autoFlush - A boolean; if true, the output buffer will be flushedwhenever a byte array is written, one of theprintln methods is invoked, or a newlinecharacter or byte ('\n') is written
See Also: java.io.PrintWriter.PrintWriter(java.io.OutputStreamboolean) |
| PrintStream | | public PrintStream(OutputStream out, boolean autoFlush, String encoding) throws UnsupportedEncodingException(Code) | | Creates a new print stream.
Parameters:
out - The output stream to which values and objects will beprinted
Parameters:
autoFlush - A boolean; if true, the output buffer will be flushedwhenever a byte array is written, one of theprintln methods is invoked, or a newlinecharacter or byte ('\n') is written
Parameters:
encoding - The name of a supportedcharacter encoding
throws:
UnsupportedEncodingException - If the named encoding is not supported
since:
1.4 |
| PrintStream | | public PrintStream(String fileName) throws FileNotFoundException(Code) | | Creates a new print stream, without automatic line flushing, with the
specified file name. This convenience constructor creates
the necessary intermediate
java.io.OutputStreamWriterOutputStreamWriter , 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 printstream. If the file exists, then it will be truncated tozero size; otherwise, a new file will be created. The outputwill be written to the file and 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(fileName) denies writeaccess to the file
since:
1.5 |
| PrintStream | | public PrintStream(String fileName, String csn) throws FileNotFoundException, UnsupportedEncodingException(Code) | | Creates a new print stream, 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 printstream. If the file exists, then it will be truncated tozero size; otherwise, a new file will be created. The outputwill be written to the file and 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(fileName) denies writeaccess to the file
throws:
UnsupportedEncodingException - If the named charset is not supported
since:
1.5 |
| PrintStream | | public PrintStream(File file) throws FileNotFoundException(Code) | | Creates a new print stream, 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 print stream. If thefile exists, then it will be truncated to zero size; otherwise,a new file will be created. The output will be written to thefile and 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 |
| PrintStream | | public PrintStream(File file, String csn) throws FileNotFoundException, UnsupportedEncodingException(Code) | | Creates a new print stream, 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 print stream. If thefile exists, then it will be truncated to zero size; otherwise,a new file will be created. The output will be written to thefile and 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 presentand 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 PrintStream append(CharSequence csq)(Code) | | Appends the specified character sequence to this output stream.
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. For instance, invoking then 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 output stream. This output stream
since:
1.5 |
| append | | public PrintStream append(CharSequence csq, int start, int end)(Code) | | Appends a subsequence of the specified character sequence to this output
stream.
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())
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 output stream
throws:
IndexOutOfBoundsException - If start or end are negative, startis greater than end, or end is greater thancsq.length()
since:
1.5 |
| append | | public PrintStream append(char c)(Code) | | Appends the specified character to this output stream.
An invocation of this method of the form out.append(c)
behaves in exactly the same way as the invocation
out.print(c)
Parameters:
c - The 16-bit character to append This output stream
since:
1.5 |
| checkError | | public boolean checkError()(Code) | | Flushes the stream and checks its error state. The internal error state
is set to 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.
true if and only if this stream has encountered anIOException other thanInterruptedIOException, or thesetError method has been invoked |
| clearError | | protected void clearError()(Code) | | Clears the internal error state of this stream.
This method will cause subsequent invocations of
PrintStream.checkError() to return false until another write
operation fails and invokes
PrintStream.setError() .
since:
1.6 |
| close | | public void close()(Code) | | Closes the stream. This is done by flushing the stream and then closing
the underlying output stream.
See Also: java.io.OutputStream.close |
| flush | | public void flush()(Code) | | Flushes the stream. This is done by writing any buffered output bytes to
the underlying output stream and then flushing that stream.
See Also: java.io.OutputStream.flush |
| format | | public PrintStream format(String format, Object... args)(Code) | | Writes a formatted string to this output stream using the specified
format string and arguments.
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 output stream
since:
1.5 |
| format | | public PrintStream format(Locale l, String format, Object... args)(Code) | | Writes a formatted string to this output stream using the specified
format string and arguments.
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 output stream
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
PrintStream.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
PrintStream.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
PrintStream.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
PrintStream.write(int) method.
Parameters:
s - The String to be printed |
| printf | | public PrintStream printf(String format, Object... args)(Code) | | A convenience method to write a formatted string to this output stream
using the specified format string and arguments.
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 output stream
since:
1.5 |
| printf | | public PrintStream printf(Locale l, String format, Object... args)(Code) | | A convenience method to write a formatted string to this output stream
using the specified format string and arguments.
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 output stream
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(Object x)(Code) | | Prints an Object and then terminate the line. This method calls
at first String.valueOf(x) to get the printed object's string value,
then behaves as
though it invokes
PrintStream.print(String) and then
PrintStream.println() .
Parameters:
x - The Object to be printed. |
| write | | public void write(int b)(Code) | | Writes the specified byte to this stream. If the byte is a newline and
automatic flushing is enabled then the 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.
Parameters:
b - The byte to be written
See Also: PrintStream.print(char)
See Also: PrintStream.println(char) |
| write | | public void write(byte buf, int off, int len)(Code) | | Writes 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.
Parameters:
buf - A byte array
Parameters:
off - Offset from which to start taking bytes
Parameters:
len - Number of bytes to write |
|
|