Class PrintWriter
- java.lang.Object
-
- java.io.Writer
-
- java.io.PrintWriter
-
- All Implemented Interfaces:
Closeable,Flushable,Appendable,AutoCloseable
public class PrintWriter extends Writer
Prints formatted representations of objects to a text-output stream. This class implements all of the print methods found inPrintStream. It does not contain methods for writing raw bytes, for which a program should use unencoded byte streams.Unlike the
PrintStreamclass, 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().- Since:
- JDK1.1
-
-
Constructor Summary
Constructors Constructor Description 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(Writer out)Creates a new PrintWriter, without automatic line flushing.PrintWriter(Writer out, boolean autoFlush)Creates a new PrintWriter.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PrintWriterappend(char c)Appends the specified character to this writer.PrintWriterappend(CharSequence csq)Appends the specified character sequence to this writer.PrintWriterappend(CharSequence csq, int start, int end)Appends a subsequence of the specified character sequence to this writer.booleancheckError()Flushes the stream if it's not closed and checks its error state.protected voidclearError()Clears the error state of this stream.voidclose()Closes the stream and releases any system resources associated with it.voidflush()Flushes the stream.voidprint(boolean b)Prints a boolean value.voidprint(char c)Prints a character.voidprint(char[] s)Prints an array of characters.voidprint(double d)Prints a double-precision floating-point number.voidprint(float f)Prints a floating-point number.voidprint(int i)Prints an integer.voidprint(long l)Prints a long integer.voidprint(Object obj)Prints an object.voidprint(String s)Prints a string.voidprintln()Terminates the current line by writing the line separator string.voidprintln(boolean x)Prints a boolean value and then terminates the line.voidprintln(char x)Prints a character and then terminates the line.voidprintln(char[] x)Prints an array of characters and then terminates the line.voidprintln(double x)Prints a double-precision floating-point number and then terminates the line.voidprintln(float x)Prints a floating-point number and then terminates the line.voidprintln(int x)Prints an integer and then terminates the line.voidprintln(long x)Prints a long integer and then terminates the line.voidprintln(Object x)Prints an Object and then terminates the line.voidprintln(String x)Prints a String and then terminates the line.protected voidsetError()Indicates that an error has occurred.voidwrite(char[] buf)Writes an array of characters.voidwrite(char[] buf, int off, int len)Writes A Portion of an array of characters.voidwrite(int c)Writes a single character.voidwrite(String s)Writes a string.voidwrite(String s, int off, int len)Writes a portion of a string.
-
-
-
Constructor Detail
-
PrintWriter
public PrintWriter(Writer out)
Creates a new PrintWriter, without automatic line flushing.- Parameters:
out- A character-output stream
-
PrintWriter
public PrintWriter(Writer out, boolean autoFlush)
Creates a new PrintWriter.- Parameters:
out- A character-output streamautoFlush- A boolean; if true, the println, printf, or format methods will flush the output buffer
-
PrintWriter
public PrintWriter(OutputStream out)
Creates a new PrintWriter, without automatic line flushing, 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- See Also:
OutputStreamWriter(java.io.OutputStream)
-
PrintWriter
public PrintWriter(OutputStream out, boolean autoFlush)
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 streamautoFlush- A boolean; if true, the println, printf, or format methods will flush the output buffer- See Also:
OutputStreamWriter(java.io.OutputStream)
-
-
Method Detail
-
flush
public void flush()
Flushes the stream.- Specified by:
flushin interfaceFlushable- Specified by:
flushin classWriter- See Also:
checkError()
-
close
public void close()
Closes the stream and releases any system resources associated with it. Closing a previously closed stream has no effect.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein classWriter- See Also:
checkError()
-
checkError
public boolean checkError()
Flushes the stream if it's not closed and checks its error state.- Returns:
trueif the print stream has encountered an error, either on the underlying output stream or during a format conversion.
-
setError
protected void setError()
Indicates that an error has occurred.This method will cause subsequent invocations of
checkError()to return true untilclearError()is invoked.
-
clearError
protected void clearError()
Clears the error state of this stream.This method will cause subsequent invocations of
checkError()to return false until another write operation fails and invokessetError().- Since:
- 1.6
-
write
public void write(int c)
Writes a single character.
-
write
public void write(char[] buf, int off, int len)Writes A Portion of an array of characters.
-
write
public void write(char[] buf)
Writes an array of characters. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.
-
write
public void write(String s, int off, int len)
Writes a portion of a string.
-
write
public void write(String s)
Writes a string. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.
-
print
public void print(boolean b)
Prints a boolean value. The string produced byis translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of theString.valueOf(boolean)method.write(int)- Parameters:
b- Thebooleanto be printed
-
print
public void print(char c)
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 themethod.write(int)- Parameters:
c- Thecharto be printed
-
print
public void print(int i)
Prints an integer. The string produced byis translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of theString.valueOf(int)method.write(int)- Parameters:
i- Theintto be printed- See Also:
Integer.toString(int)
-
print
public void print(long l)
Prints a long integer. The string produced byis translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of theString.valueOf(long)method.write(int)- Parameters:
l- Thelongto be printed- See Also:
Long.toString(long)
-
print
public void print(float f)
Prints a floating-point number. The string produced byis translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of theString.valueOf(float)method.write(int)- Parameters:
f- Thefloatto be printed- See Also:
Float.toString(float)
-
print
public void print(double d)
Prints a double-precision floating-point number. The string produced byis translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of theString.valueOf(double)method.write(int)- Parameters:
d- Thedoubleto be printed- See Also:
Double.toString(double)
-
print
public void print(char[] s)
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 themethod.write(int)- Parameters:
s- The array of chars to be printed- Throws:
NullPointerException- Ifsisnull
-
print
public void print(@Nullable String s)
Prints a string. If the argument isnullthen 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 themethod.write(int)- Parameters:
s- TheStringto be printed
-
print
public void print(Object obj)
Prints an object. The string produced by themethod is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of theString.valueOf(Object)method.write(int)- Parameters:
obj- TheObjectto be printed- See Also:
Object.toString()
-
println
public void println()
Terminates the current line by writing the line separator string. The line separator string is defined by the system propertyline.separator, and is not necessarily a single newline character ('\n').
-
println
public void println(boolean x)
Prints a boolean value and then terminates the line. This method behaves as though it invokesand thenprint(boolean).println()- Parameters:
x- thebooleanvalue to be printed
-
println
public void println(char x)
Prints a character and then terminates the line. This method behaves as though it invokesand thenprint(char).println()- Parameters:
x- thecharvalue to be printed
-
println
public void println(int x)
Prints an integer and then terminates the line. This method behaves as though it invokesand thenprint(int).println()- Parameters:
x- theintvalue to be printed
-
println
public void println(long x)
Prints a long integer and then terminates the line. This method behaves as though it invokesand thenprint(long).println()- Parameters:
x- thelongvalue to be printed
-
println
public void println(float x)
Prints a floating-point number and then terminates the line. This method behaves as though it invokesand thenprint(float).println()- Parameters:
x- thefloatvalue to be printed
-
println
public void println(double x)
Prints a double-precision floating-point number and then terminates the line. This method behaves as though it invokesand thenprint(double).println()- Parameters:
x- thedoublevalue to be printed
-
println
public void println(char[] x)
Prints an array of characters and then terminates the line. This method behaves as though it invokesand thenprint(char[]).println()- Parameters:
x- the array ofcharvalues to be printed
-
println
public void println(String x)
Prints a String and then terminates the line. This method behaves as though it invokesand thenprint(String).println()- Parameters:
x- theStringvalue to be printed
-
println
public void println(Object x)
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 invokesand thenprint(String).println()- Parameters:
x- TheObjectto be printed.
-
append
public PrintWriter append(@Nullable 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. For instance, invoking the toString method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit.
- Specified by:
appendin interfaceAppendable- Overrides:
appendin classWriter- Parameters:
csq- The character sequence to append. If csq is null, then the four characters "null" are appended to this writer.- Returns:
- This writer
- Since:
- 1.5
-
append
public PrintWriter append(@Nullable 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())
- Specified by:
appendin interfaceAppendable- Overrides:
appendin classWriter- Parameters:
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 subsequence- Returns:
- This writer
- Throws:
IndexOutOfBoundsException- If start or end are negative, start is greater than end, or end is greater than csq.length()- Since:
- 1.5
-
append
public PrintWriter append(char c)
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)
- Specified by:
appendin interfaceAppendable- Overrides:
appendin classWriter- Parameters:
c- The 16-bit character to append- Returns:
- This writer
- Since:
- 1.5
-
-