PrintWriter (Java SE 10 & JDK 10 ) (original) (raw)
Field Summary
Fields
Modifier and Type Field Description protected Writer out The underlying character-output stream of thisPrintWriter. * ### Fields declared in class java.io.[Writer](../../java/io/Writer.html "class in java.io") `[lock](../../java/io/Writer.html#lock)`
Constructor Summary
Constructors
Constructor Description 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(File file,Charset charset) 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(OutputStream out, boolean autoFlush,Charset charset) 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. 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(String fileName,Charset charset) Creates a new PrintWriter, without automatic line flushing, with the specified file name and charset. Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type Method Description 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 checkError() Flushes the stream if it's not closed and checks its error state. protected void clearError() 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 format(String format,Object... args) Writes a formatted string to this writer using the specified format string and arguments. PrintWriter format(Locale l,String format,Object... args) 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 print(Object obj) Prints an object. void print(String s) Prints a string. PrintWriter printf(String format,Object... args) A convenience method to write a formatted string to this writer using the specified format string and arguments. PrintWriter printf(Locale l,String format,Object... args) 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 println(Object x) Prints an Object and then terminates the line. void println(String x) 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 write(String s) Writes a string. void write(String s, int off, int len) Writes a portion of a string. * ### Methods declared in class java.lang.[Object](../../java/lang/Object.html "class in java.lang") `[clone](../../java/lang/Object.html#clone%28%29), [equals](../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../java/lang/Object.html#finalize%28%29), [getClass](../../java/lang/Object.html#getClass%28%29), [hashCode](../../java/lang/Object.html#hashCode%28%29), [notify](../../java/lang/Object.html#notify%28%29), [notifyAll](../../java/lang/Object.html#notifyAll%28%29), [toString](../../java/lang/Object.html#toString%28%29), [wait](../../java/lang/Object.html#wait%28%29), [wait](../../java/lang/Object.html#wait%28long%29), [wait](../../java/lang/Object.html#wait%28long,int%29)`
Field Detail
* #### out protected [Writer](../../java/io/Writer.html "class in java.io") out The underlying character-output stream of this`PrintWriter`. Since: 1.2
Constructor Detail
* #### PrintWriter public PrintWriter([Writer](../../java/io/Writer.html "class in java.io") out) Creates a new PrintWriter, without automatic line flushing. Parameters: `out` \- A character-output stream * #### PrintWriter public PrintWriter([Writer](../../java/io/Writer.html "class in java.io") out, boolean autoFlush) Creates a new PrintWriter. Parameters: `out` \- A character-output stream `autoFlush` \- A boolean; if true, the `println`,`printf`, or `format` methods will flush the output buffer * #### PrintWriter public PrintWriter([OutputStream](../../java/io/OutputStream.html "class in java.io") 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)](../../java/io/OutputStreamWriter.html#%3Cinit%3E%28java.io.OutputStream%29) * #### PrintWriter public PrintWriter([OutputStream](../../java/io/OutputStream.html "class in java.io") 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 stream `autoFlush` \- A boolean; if true, the `println`,`printf`, or `format` methods will flush the output buffer See Also: [OutputStreamWriter(java.io.OutputStream)](../../java/io/OutputStreamWriter.html#%3Cinit%3E%28java.io.OutputStream%29) * #### PrintWriter public PrintWriter([OutputStream](../../java/io/OutputStream.html "class in java.io") out, boolean autoFlush, [Charset](../../java/nio/charset/Charset.html "class in java.nio.charset") charset) Creates a new PrintWriter from an existing OutputStream. This convenience constructor creates the necessary intermediate OutputStreamWriter, which will convert characters into bytes using the specified charset. Parameters: `out` \- An output stream `autoFlush` \- A boolean; if true, the `println`,`printf`, or `format` methods will flush the output buffer `charset` \- A [charset](../../java/nio/charset/Charset.html "class in java.nio.charset") Since: 10 * #### PrintWriter public PrintWriter([String](../../java/lang/String.html "class in java.lang") fileName) throws [FileNotFoundException](../../java/io/FileNotFoundException.html "class in java.io") Creates a new PrintWriter, without automatic line flushing, with the specified file name. This convenience constructor creates the necessary intermediate [OutputStreamWriter](../../java/io/OutputStreamWriter.html "class in java.io"), which will encode characters using the [default charset](../../java/nio/charset/Charset.html#defaultCharset%28%29) for this instance of the Java virtual machine. Parameters: `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. Throws: `[FileNotFoundException](../../java/io/FileNotFoundException.html "class in java.io")` \- 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](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager is present and [checkWrite(fileName)](../../java/lang/SecurityManager.html#checkWrite%28java.io.FileDescriptor%29) denies write access to the file Since: 1.5 * #### PrintWriter public PrintWriter([String](../../java/lang/String.html "class in java.lang") fileName, [String](../../java/lang/String.html "class in java.lang") csn) throws [FileNotFoundException](../../java/io/FileNotFoundException.html "class in java.io"), [UnsupportedEncodingException](../../java/io/UnsupportedEncodingException.html "class in java.io") Creates a new PrintWriter, without automatic line flushing, with the specified file name and charset. This convenience constructor creates the necessary intermediate [OutputStreamWriter](../../java/io/OutputStreamWriter.html "class in java.io"), which will encode characters using the provided charset. Parameters: `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](../../java/nio/charset/Charset.html "class in java.nio.charset") Throws: `[FileNotFoundException](../../java/io/FileNotFoundException.html "class in java.io")` \- 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](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager is present and [checkWrite(fileName)](../../java/lang/SecurityManager.html#checkWrite%28java.io.FileDescriptor%29) denies write access to the file `[UnsupportedEncodingException](../../java/io/UnsupportedEncodingException.html "class in java.io")` \- If the named charset is not supported Since: 1.5 * #### PrintWriter public PrintWriter([String](../../java/lang/String.html "class in java.lang") fileName, [Charset](../../java/nio/charset/Charset.html "class in java.nio.charset") charset) throws [IOException](../../java/io/IOException.html "class in java.io") Creates a new PrintWriter, without automatic line flushing, with the specified file name and charset. This convenience constructor creates the necessary intermediate [OutputStreamWriter](../../java/io/OutputStreamWriter.html "class in java.io"), which will encode characters using the provided charset. Parameters: `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. `charset` \- A [charset](../../java/nio/charset/Charset.html "class in java.nio.charset") Throws: `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs while opening or creating the file `[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager is present and [checkWrite(fileName)](../../java/lang/SecurityManager.html#checkWrite%28java.io.FileDescriptor%29) denies write access to the file Since: 10 * #### PrintWriter public PrintWriter([File](../../java/io/File.html "class in java.io") file) throws [FileNotFoundException](../../java/io/FileNotFoundException.html "class in java.io") Creates a new PrintWriter, without automatic line flushing, with the specified file. This convenience constructor creates the necessary intermediate [OutputStreamWriter](../../java/io/OutputStreamWriter.html "class in java.io"), which will encode characters using the [default charset](../../java/nio/charset/Charset.html#defaultCharset%28%29) for this instance of the Java virtual machine. Parameters: `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. Throws: `[FileNotFoundException](../../java/io/FileNotFoundException.html "class in java.io")` \- 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](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager is present and [checkWrite(file.getPath())](../../java/lang/SecurityManager.html#checkWrite%28java.io.FileDescriptor%29) denies write access to the file Since: 1.5 * #### PrintWriter public PrintWriter([File](../../java/io/File.html "class in java.io") file, [String](../../java/lang/String.html "class in java.lang") csn) throws [FileNotFoundException](../../java/io/FileNotFoundException.html "class in java.io"), [UnsupportedEncodingException](../../java/io/UnsupportedEncodingException.html "class in java.io") Creates a new PrintWriter, without automatic line flushing, with the specified file and charset. This convenience constructor creates the necessary intermediate [OutputStreamWriter](../../java/io/OutputStreamWriter.html "class in java.io"), which will encode characters using the provided charset. Parameters: `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](../../java/nio/charset/Charset.html "class in java.nio.charset") Throws: `[FileNotFoundException](../../java/io/FileNotFoundException.html "class in java.io")` \- 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](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager is present and [checkWrite(file.getPath())](../../java/lang/SecurityManager.html#checkWrite%28java.io.FileDescriptor%29) denies write access to the file `[UnsupportedEncodingException](../../java/io/UnsupportedEncodingException.html "class in java.io")` \- If the named charset is not supported Since: 1.5 * #### PrintWriter public PrintWriter([File](../../java/io/File.html "class in java.io") file, [Charset](../../java/nio/charset/Charset.html "class in java.nio.charset") charset) throws [IOException](../../java/io/IOException.html "class in java.io") Creates a new PrintWriter, without automatic line flushing, with the specified file and charset. This convenience constructor creates the necessary intermediate [OutputStreamWriter](../../java/io/OutputStreamWriter.html "class in java.io"), which will encode characters using the provided charset. Parameters: `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. `charset` \- A [charset](../../java/nio/charset/Charset.html "class in java.nio.charset") Throws: `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs while opening or creating the file `[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager is present and [checkWrite(file.getPath())](../../java/lang/SecurityManager.html#checkWrite%28java.io.FileDescriptor%29) denies write access to the file Since: 10
Method Detail
* #### flush public void flush() Flushes the stream. Specified by: `[flush](../../java/io/Flushable.html#flush%28%29)` in interface `[Flushable](../../java/io/Flushable.html "interface in java.io")` Specified by: `[flush](../../java/io/Writer.html#flush%28%29)` in class `[Writer](../../java/io/Writer.html "class in java.io")` See Also: [checkError()](../../java/io/PrintWriter.html#checkError%28%29) * #### 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: `[close](../../java/lang/AutoCloseable.html#close%28%29)` in interface `[AutoCloseable](../../java/lang/AutoCloseable.html "interface in java.lang")` Specified by: `[close](../../java/io/Closeable.html#close%28%29)` in interface `[Closeable](../../java/io/Closeable.html "interface in java.io")` Specified by: `[close](../../java/io/Writer.html#close%28%29)` in class `[Writer](../../java/io/Writer.html "class in java.io")` See Also: [checkError()](../../java/io/PrintWriter.html#checkError%28%29) * #### checkError public boolean checkError() Flushes the stream if it's not closed and checks its error state. Returns: `true` if 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()](../../java/io/PrintWriter.html#checkError%28%29) to return `true` until [clearError()](../../java/io/PrintWriter.html#clearError%28%29) is invoked. * #### clearError protected void clearError() Clears the error state of this stream. This method will cause subsequent invocations of [checkError()](../../java/io/PrintWriter.html#checkError%28%29) to return `false` until another write operation fails and invokes [setError()](../../java/io/PrintWriter.html#setError%28%29). Since: 1.6 * #### write public void write(int c) Writes a single character. Overrides: `[write](../../java/io/Writer.html#write%28int%29)` in class `[Writer](../../java/io/Writer.html "class in java.io")` Parameters: `c` \- int specifying a character to be written. * #### write public void write(char[] buf, int off, int len) Writes A Portion of an array of characters. Specified by: `[write](../../java/io/Writer.html#write%28char%5B%5D,int,int%29)` in class `[Writer](../../java/io/Writer.html "class in java.io")` Parameters: `buf` \- Array of characters `off` \- Offset from which to start writing characters `len` \- Number of characters to write Throws: `[IndexOutOfBoundsException](../../java/lang/IndexOutOfBoundsException.html "class in java.lang")` \- If the values of the `off` and `len` parameters cause the corresponding method of the underlying `Writer` to throw an `IndexOutOfBoundsException` * #### 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. Overrides: `[write](../../java/io/Writer.html#write%28char%5B%5D%29)` in class `[Writer](../../java/io/Writer.html "class in java.io")` Parameters: `buf` \- Array of characters to be written * #### write public void write([String](../../java/lang/String.html "class in java.lang") s, int off, int len) Writes a portion of a string. Overrides: `[write](../../java/io/Writer.html#write%28java.lang.String,int,int%29)` in class `[Writer](../../java/io/Writer.html "class in java.io")` Parameters: `s` \- A String `off` \- Offset from which to start writing characters `len` \- Number of characters to write Throws: `[IndexOutOfBoundsException](../../java/lang/IndexOutOfBoundsException.html "class in java.lang")` \- If the values of the `off` and `len` parameters cause the corresponding method of the underlying `Writer` to throw an `IndexOutOfBoundsException` * #### write public void write([String](../../java/lang/String.html "class in java.lang") s) Writes a string. This method cannot be inherited from the Writer class because it must suppress I/O exceptions. Overrides: `[write](../../java/io/Writer.html#write%28java.lang.String%29)` in class `[Writer](../../java/io/Writer.html "class in java.io")` Parameters: `s` \- String to be written * #### print public void print(boolean b) Prints a boolean value. The string produced by [String.valueOf(boolean)](../../java/lang/String.html#valueOf%28boolean%29) 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)](../../java/io/PrintWriter.html#write%28int%29) method. Parameters: `b` \- The `boolean` to 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 the [write(int)](../../java/io/PrintWriter.html#write%28int%29) method. Parameters: `c` \- The `char` to be printed * #### print public void print(int i) Prints an integer. The string produced by [String.valueOf(int)](../../java/lang/String.html#valueOf%28int%29) 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)](../../java/io/PrintWriter.html#write%28int%29) method. Parameters: `i` \- The `int` to be printed See Also: [Integer.toString(int)](../../java/lang/Integer.html#toString%28int%29) * #### print public void print(long l) Prints a long integer. The string produced by [String.valueOf(long)](../../java/lang/String.html#valueOf%28long%29) 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)](../../java/io/PrintWriter.html#write%28int%29) method. Parameters: `l` \- The `long` to be printed See Also: [Long.toString(long)](../../java/lang/Long.html#toString%28long%29) * #### print public void print(float f) Prints a floating-point number. The string produced by [String.valueOf(float)](../../java/lang/String.html#valueOf%28float%29) 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)](../../java/io/PrintWriter.html#write%28int%29) method. Parameters: `f` \- The `float` to be printed See Also: [Float.toString(float)](../../java/lang/Float.html#toString%28float%29) * #### print public void print(double d) Prints a double-precision floating-point number. The string produced by[String.valueOf(double)](../../java/lang/String.html#valueOf%28double%29) 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)](../../java/io/PrintWriter.html#write%28int%29) method. Parameters: `d` \- The `double` to be printed See Also: [Double.toString(double)](../../java/lang/Double.html#toString%28double%29) * #### 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 the [write(int)](../../java/io/PrintWriter.html#write%28int%29) method. Parameters: `s` \- The array of chars to be printed Throws: `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- If `s` is `null` * #### print public void print([String](../../java/lang/String.html "class in java.lang") s) 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[write(int)](../../java/io/PrintWriter.html#write%28int%29) method. Parameters: `s` \- The `String` to be printed * #### print public void print([Object](../../java/lang/Object.html "class in java.lang") obj) Prints an object. The string produced by the [String.valueOf(Object)](../../java/lang/String.html#valueOf%28java.lang.Object%29) 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)](../../java/io/PrintWriter.html#write%28int%29) method. Parameters: `obj` \- The `Object` to be printed See Also: [Object.toString()](../../java/lang/Object.html#toString%28%29) * #### println public void println() 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(boolean x) Prints a boolean value and then terminates the line. This method behaves as though it invokes [print(boolean)](../../java/io/PrintWriter.html#print%28boolean%29) and then[println()](../../java/io/PrintWriter.html#println%28%29). Parameters: `x` \- the `boolean` value to be printed * #### println public void println(char x) Prints a character and then terminates the line. This method behaves as though it invokes [print(char)](../../java/io/PrintWriter.html#print%28char%29) and then [println()](../../java/io/PrintWriter.html#println%28%29). Parameters: `x` \- the `char` value to be printed * #### println public void println(int x) Prints an integer and then terminates the line. This method behaves as though it invokes [print(int)](../../java/io/PrintWriter.html#print%28int%29) and then [println()](../../java/io/PrintWriter.html#println%28%29). Parameters: `x` \- the `int` value to be printed * #### println public void println(long x) Prints a long integer and then terminates the line. This method behaves as though it invokes [print(long)](../../java/io/PrintWriter.html#print%28long%29) and then[println()](../../java/io/PrintWriter.html#println%28%29). Parameters: `x` \- the `long` value 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 invokes [print(float)](../../java/io/PrintWriter.html#print%28float%29) and then[println()](../../java/io/PrintWriter.html#println%28%29). Parameters: `x` \- the `float` value 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 invokes [print(double)](../../java/io/PrintWriter.html#print%28double%29) and then [println()](../../java/io/PrintWriter.html#println%28%29). Parameters: `x` \- the `double` value 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 invokes [print(char\[\])](../../java/io/PrintWriter.html#print%28char%5B%5D%29) and then[println()](../../java/io/PrintWriter.html#println%28%29). Parameters: `x` \- the array of `char` values to be printed * #### println public void println([String](../../java/lang/String.html "class in java.lang") x) Prints a String and then terminates the line. This method behaves as though it invokes [print(String)](../../java/io/PrintWriter.html#print%28java.lang.String%29) and then[println()](../../java/io/PrintWriter.html#println%28%29). Parameters: `x` \- the `String` value to be printed * #### println public void println([Object](../../java/lang/Object.html "class in java.lang") 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 invokes [print(String)](../../java/io/PrintWriter.html#print%28java.lang.String%29) and then[println()](../../java/io/PrintWriter.html#println%28%29). Parameters: `x` \- The `Object` to be printed. * #### printf public [PrintWriter](../../java/io/PrintWriter.html "class in java.io") printf([String](../../java/lang/String.html "class in java.lang") format, [Object](../../java/lang/Object.html "class in java.lang")... args) A convenience method to write a formatted string to this writer using the specified format string and arguments. If automatic flushing is enabled, calls to this method will flush the output buffer. 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](../util/Formatter.html#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 byThe Java™ Virtual Machine Specification. The behaviour on a`null` argument depends on the [conversion](../util/Formatter.html#syntax). Returns: This writer Throws: `[IllegalFormatException](../../java/util/IllegalFormatException.html "class in java.util")` \- 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](../util/Formatter.html#detail) section of the formatter class specification. `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- If the `format` is `null` Since: 1.5 * #### printf public [PrintWriter](../../java/io/PrintWriter.html "class in java.io") printf([Locale](../../java/util/Locale.html "class in java.util") l, [String](../../java/lang/String.html "class in java.lang") format, [Object](../../java/lang/Object.html "class in java.lang")... args) A convenience method to write a formatted string to this writer using the specified format string and arguments. If automatic flushing is enabled, calls to this method will flush the output buffer. 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 [locale](../../java/util/Locale.html "class in java.util") to apply during formatting. If `l` is `null` then no localization is applied. `format` \- A format string as described in [Format string syntax](../util/Formatter.html#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 byThe Java™ Virtual Machine Specification. The behaviour on a`null` argument depends on the [conversion](../util/Formatter.html#syntax). Returns: This writer Throws: `[IllegalFormatException](../../java/util/IllegalFormatException.html "class in java.util")` \- 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](../util/Formatter.html#detail) section of the formatter class specification. `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- If the `format` is `null` Since: 1.5 * #### format public [PrintWriter](../../java/io/PrintWriter.html "class in java.io") format([String](../../java/lang/String.html "class in java.lang") format, [Object](../../java/lang/Object.html "class in java.lang")... args) Writes a formatted string to this writer using the specified format string and arguments. If automatic flushing is enabled, calls to this method will flush the output buffer. The locale always used is the one returned by [Locale.getDefault()](../../java/util/Locale.html#getDefault%28%29), regardless of any previous invocations of other formatting methods on this object. Parameters: `format` \- A format string as described in [Format string syntax](../util/Formatter.html#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 byThe Java™ Virtual Machine Specification. The behaviour on a`null` argument depends on the [conversion](../util/Formatter.html#syntax). Returns: This writer Throws: `[IllegalFormatException](../../java/util/IllegalFormatException.html "class in java.util")` \- 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](../util/Formatter.html#detail) section of the Formatter class specification. `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- If the `format` is `null` Since: 1.5 * #### format public [PrintWriter](../../java/io/PrintWriter.html "class in java.io") format([Locale](../../java/util/Locale.html "class in java.util") l, [String](../../java/lang/String.html "class in java.lang") format, [Object](../../java/lang/Object.html "class in java.lang")... args) Writes a formatted string to this writer using the specified format string and arguments. If automatic flushing is enabled, calls to this method will flush the output buffer. Parameters: `l` \- The [locale](../../java/util/Locale.html "class in java.util") to apply during formatting. If `l` is `null` then no localization is applied. `format` \- A format string as described in [Format string syntax](../util/Formatter.html#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 byThe Java™ Virtual Machine Specification. The behaviour on a`null` argument depends on the [conversion](../util/Formatter.html#syntax). Returns: This writer Throws: `[IllegalFormatException](../../java/util/IllegalFormatException.html "class in java.util")` \- 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](../util/Formatter.html#detail) section of the formatter class specification. `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- If the `format` is `null` Since: 1.5 * #### append public [PrintWriter](../../java/io/PrintWriter.html "class in java.io") append([CharSequence](../../java/lang/CharSequence.html "interface in java.lang") 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: `[append](../../java/lang/Appendable.html#append%28java.lang.CharSequence%29)` in interface `[Appendable](../../java/lang/Appendable.html "interface in java.lang")` Overrides: `[append](../../java/io/Writer.html#append%28java.lang.CharSequence%29)` in class `[Writer](../../java/io/Writer.html "class in java.io")` 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](../../java/io/PrintWriter.html "class in java.io") append([CharSequence](../../java/lang/CharSequence.html "interface in java.lang") 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: `[append](../../java/lang/Appendable.html#append%28java.lang.CharSequence,int,int%29)` in interface `[Appendable](../../java/lang/Appendable.html "interface in java.lang")` Overrides: `[append](../../java/io/Writer.html#append%28java.lang.CharSequence,int,int%29)` in class `[Writer](../../java/io/Writer.html "class in java.io")` 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 subsequence `end` \- The index of the character following the last character in the subsequence Returns: This writer Throws: `[IndexOutOfBoundsException](../../java/lang/IndexOutOfBoundsException.html "class in java.lang")` \- If `start` or `end` are negative, `start` is greater than `end`, or `end` is greater than`csq.length()` Since: 1.5 * #### append public [PrintWriter](../../java/io/PrintWriter.html "class in java.io") 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: `[append](../../java/lang/Appendable.html#append%28char%29)` in interface `[Appendable](../../java/lang/Appendable.html "interface in java.lang")` Overrides: `[append](../../java/io/Writer.html#append%28char%29)` in class `[Writer](../../java/io/Writer.html "class in java.io")` Parameters: `c` \- The 16-bit character to append Returns: This writer Since: 1.5