declare namespace java { namespace io { /** * Prints formatted representations of objects to a text-output stream. This * class implements all of the print methods found in {@link * PrintStream}. It does not contain methods for writing raw bytes, for which * a program should use unencoded byte streams. *
Unlike the {@link 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 {@link #checkError checkError()}.
* @author Frank Yellin
* @author Mark Reinhold
* @since JDK1.1
*/
// @ts-ignore
class PrintWriter extends java.io.Writer {
/**
* Creates a new PrintWriter, without automatic line flushing.
* @param out A character-output stream
*/
// @ts-ignore
constructor(out: java.io.Writer)
/**
* Creates a new PrintWriter.
* @param out A character-output stream
* @param autoFlush A boolean; if true, the println,
* printf, or format methods will
* flush the output buffer
*/
// @ts-ignore
constructor(out: java.io.Writer, autoFlush: boolean)
/**
* 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.
* @param out An output stream
* @see java.io.OutputStreamWriter#OutputStreamWriter(java.io.OutputStream)
*/
// @ts-ignore
constructor(out: java.io.OutputStream)
/**
* 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.
* @param out An output stream
* @param autoFlush A boolean; if true, the println,
* printf, or format methods will
* flush the output buffer
* @see java.io.OutputStreamWriter#OutputStreamWriter(java.io.OutputStream)
*/
// @ts-ignore
constructor(out: java.io.OutputStream, autoFlush: boolean)
/**
* Creates a new PrintWriter, without automatic line flushing, with the
* specified file name. This convenience constructor creates the necessary
* intermediate {@link java.io.OutputStreamWriter OutputStreamWriter},
* which will encode characters using the {@linkplain
* java.nio.charset.Charset#defaultCharset() default charset} for this
* instance of the Java virtual machine.
* @param 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
* 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
* @throws SecurityException
* If a security manager is present and {#link
* SecurityManager#checkWrite checkWrite(fileName)} denies write
* access to the file
* @since 1.5
*/
// @ts-ignore
constructor(fileName: java.lang.String | string)
/**
* Creates a new PrintWriter, without automatic line flushing, with the
* specified file name and charset. This convenience constructor creates
* the necessary intermediate {@link java.io.OutputStreamWriter
* OutputStreamWriter}, which will encode characters using the provided
* charset.
* @param 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.
* @param csn
* The name of a supported {#linkplain java.nio.charset.Charset
* charset}
* @throws 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
* @throws SecurityException
* If a security manager is present and {#link
* SecurityManager#checkWrite checkWrite(fileName)} denies write
* access to the file
* @throws UnsupportedEncodingException
* If the named charset is not supported
* @since 1.5
*/
// @ts-ignore
constructor(fileName: java.lang.String | string, csn: java.lang.String | string)
/**
* Creates a new PrintWriter, without automatic line flushing, with the
* specified file. This convenience constructor creates the necessary
* intermediate {@link java.io.OutputStreamWriter OutputStreamWriter},
* which will encode characters using the {@linkplain
* java.nio.charset.Charset#defaultCharset() default charset} for this
* instance of the Java virtual machine.
* @param 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
* 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
* @throws SecurityException
* If a security manager is present and {#link
* SecurityManager#checkWrite checkWrite(file.getPath())}
* denies write access to the file
* @since 1.5
*/
// @ts-ignore
constructor(file: java.io.File)
/**
* Creates a new PrintWriter, without automatic line flushing, with the
* specified file and charset. This convenience constructor creates the
* necessary intermediate {@link java.io.OutputStreamWriter
* OutputStreamWriter}, which will encode characters using the provided
* charset.
* @param 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.
* @param csn
* The name of a supported {#linkplain java.nio.charset.Charset
* charset}
* @throws 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
* @throws SecurityException
* If a security manager is present and {#link
* SecurityManager#checkWrite checkWrite(file.getPath())}
* denies write access to the file
* @throws UnsupportedEncodingException
* If the named charset is not supported
* @since 1.5
*/
// @ts-ignore
constructor(file: java.io.File, csn: java.lang.String | string)
/**
* The underlying character-output stream of this
* PrintWriter
.
* @since 1.2
*/
// @ts-ignore
out: java.io.Writer
/**
* Flushes the stream.
* @see #checkError()
*/
// @ts-ignore
public flush(): void
/**
* Closes the stream and releases any system resources associated
* with it. Closing a previously closed stream has no effect.
* @see #checkError()
*/
// @ts-ignore
public close(): void
/**
* Flushes the stream if it's not closed and checks its error state.
* @return true
if the print stream has encountered an error,
* either on the underlying output stream or during a format
* conversion.
*/
// @ts-ignore
public checkError(): boolean
/**
* Indicates that an error has occurred.
*
This method will cause subsequent invocations of {@link * #checkError()} to return true until {@link * #clearError()} is invoked. */ // @ts-ignore setError(): void /** * Clears the error state of this stream. *
This method will cause subsequent invocations of {@link
* #checkError()} to return false until another write
* operation fails and invokes {@link #setError()}.
* @since 1.6
*/
// @ts-ignore
clearError(): void
/**
* Writes a single character.
* @param c int specifying a character to be written.
*/
// @ts-ignore
public write(c: number /*int*/): void
/**
* Writes A Portion of an array of characters.
* @param buf Array of characters
* @param off Offset from which to start writing characters
* @param len Number of characters to write
*/
// @ts-ignore
public write(buf: string[], off: number /*int*/, len: number /*int*/): void
/**
* Writes an array of characters. This method cannot be inherited from the
* Writer class because it must suppress I/O exceptions.
* @param buf Array of characters to be written
*/
// @ts-ignore
public write(buf: string[]): void
/**
* Writes a portion of a string.
* @param s A String
* @param off Offset from which to start writing characters
* @param len Number of characters to write
*/
// @ts-ignore
public write(s: java.lang.String | string, off: number /*int*/, len: number /*int*/): void
/**
* Writes a string. This method cannot be inherited from the Writer class
* because it must suppress I/O exceptions.
* @param s String to be written
*/
// @ts-ignore
public write(s: java.lang.String | string): void
/**
* Prints a boolean value. The string produced by {@link
* 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 {@link
* #write(int)}
method.
* @param b The boolean
to be printed
*/
// @ts-ignore
public print(b: boolean): void
/**
* 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 {@link
* #write(int)}
method.
* @param c The char
to be printed
*/
// @ts-ignore
public print(c: string): void
/**
* Prints an integer. The string produced by {@link
* java.lang.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 {@link #write(int)}
* method.
* @param i The int
to be printed
* @see java.lang.Integer#toString(int)
*/
// @ts-ignore
public print(i: number /*int*/): void
/**
* Prints a long integer. The string produced by {@link
* java.lang.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 {@link #write(int)}
* method.
* @param l The long
to be printed
* @see java.lang.Long#toString(long)
*/
// @ts-ignore
public print(l: number /*long*/): void
/**
* Prints a floating-point number. The string produced by {@link
* java.lang.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 {@link #write(int)}
* method.
* @param f The float
to be printed
* @see java.lang.Float#toString(float)
*/
// @ts-ignore
public print(f: number /*float*/): void
/**
* Prints a double-precision floating-point number. The string produced by
* {@link java.lang.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 {@link
* #write(int)}
method.
* @param d The double
to be printed
* @see java.lang.Double#toString(double)
*/
// @ts-ignore
public print(d: number /*double*/): void
/**
* 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 {@link #write(int)}
* method.
* @param s The array of chars to be printed
* @throws NullPointerException If s
is null
*/
// @ts-ignore
public print(s: string[]): void
/**
* 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
* {@link #write(int)}
method.
* @param s The String
to be printed
*/
// @ts-ignore
public print(s: java.lang.String | string): void
/**
* Prints an object. The string produced by the {@link
* java.lang.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 {@link #write(int)}
* method.
* @param obj The Object
to be printed
* @see java.lang.Object#toString()
*/
// @ts-ignore
public print(obj: java.lang.Object | any): void
/**
* 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'
).
*/
// @ts-ignore
public println(): void
/**
* Prints a boolean value and then terminates the line. This method behaves
* as though it invokes {@link #print(boolean)}
and then
* {@link #println()}
.
* @param x the boolean
value to be printed
*/
// @ts-ignore
public println(x: boolean): void
/**
* Prints a character and then terminates the line. This method behaves as
* though it invokes {@link #print(char)}
and then {@link
* #println()}
.
* @param x the char
value to be printed
*/
// @ts-ignore
public println(x: string): void
/**
* Prints an integer and then terminates the line. This method behaves as
* though it invokes {@link #print(int)}
and then {@link
* #println()}
.
* @param x the int
value to be printed
*/
// @ts-ignore
public println(x: number /*int*/): void
/**
* Prints a long integer and then terminates the line. This method behaves
* as though it invokes {@link #print(long)}
and then
* {@link #println()}
.
* @param x the long
value to be printed
*/
// @ts-ignore
public println(x: number /*long*/): void
/**
* Prints a floating-point number and then terminates the line. This method
* behaves as though it invokes {@link #print(float)}
and then
* {@link #println()}
.
* @param x the float
value to be printed
*/
// @ts-ignore
public println(x: number /*float*/): void
/**
* Prints a double-precision floating-point number and then terminates the
* line. This method behaves as though it invokes {@link
* #print(double)}
and then {@link #println()}
.
* @param x the double
value to be printed
*/
// @ts-ignore
public println(x: number /*double*/): void
/**
* Prints an array of characters and then terminates the line. This method
* behaves as though it invokes {@link #print(char[])}
and then
* {@link #println()}
.
* @param x the array of char
values to be printed
*/
// @ts-ignore
public println(x: string[]): void
/**
* Prints a String and then terminates the line. This method behaves as
* though it invokes {@link #print(String)}
and then
* {@link #println()}
.
* @param x the String
value to be printed
*/
// @ts-ignore
public println(x: java.lang.String | string): void
/**
* 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 {@link #print(String)}
and then
* {@link #println()}
.
* @param x The Object
to be printed.
*/
// @ts-ignore
public println(x: java.lang.Object | any): void
/**
* 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)* @param format * A format string as described in Format string syntax. * @param 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. * @throws java.util.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. * @throws NullPointerException * If the format is null * @return This writer * @since 1.5 */ // @ts-ignore public printf(format: java.lang.String | string, ...args: java.lang.Object[] | any[]): java.io.PrintWriter /** * 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)* @param l * The {#linkplain java.util.Locale locale} to apply during * formatting. If l is null then no localization * is applied. * @param format * A format string as described in Format string syntax. * @param 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. * @throws java.util.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. * @throws NullPointerException * If the format is null * @return This writer * @since 1.5 */ // @ts-ignore public printf(l: java.util.Locale, format: java.lang.String | string, ...args: java.lang.Object[] | any[]): java.io.PrintWriter /** * 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 {@link * java.util.Locale#getDefault() Locale.getDefault()}, regardless of any * previous invocations of other formatting methods on this object. * @param format * A format string as described in Format string syntax. * @param 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. * @throws java.util.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. * @throws NullPointerException * If the format is null * @return This writer * @since 1.5 */ // @ts-ignore public format(format: java.lang.String | string, ...args: java.lang.Object[] | any[]): java.io.PrintWriter /** * 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. * @param l * The {#linkplain java.util.Locale locale} to apply during * formatting. If l is null then no localization * is applied. * @param format * A format string as described in Format string syntax. * @param 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. * @throws java.util.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. * @throws NullPointerException * If the format is null * @return This writer * @since 1.5 */ // @ts-ignore public format(l: java.util.Locale, format: java.lang.String | string, ...args: java.lang.Object[] | any[]): java.io.PrintWriter /** * 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. * @param csq * The character sequence to append. If csq is * null, then the four characters "null" are * appended to this writer. * @return This writer * @since 1.5 */ // @ts-ignore public append(csq: java.lang.CharSequence): java.io.PrintWriter /** * 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())* @param 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". * @param start * The index of the first character in the subsequence * @param end * The index of the character following the last character in the * subsequence * @return 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 */ // @ts-ignore public append(csq: java.lang.CharSequence, start: number /*int*/, end: number /*int*/): java.io.PrintWriter /** * 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)* @param c * The 16-bit character to append * @return This writer * @since 1.5 */ // @ts-ignore public append(c: string): java.io.PrintWriter } } }