@sitevision/api 2023.2.1 → 2023.2.2-beta.2

package/types/java/io/PrintStream/index.d.ts

@@ -0,0 +1,408 @@
+import type { String } from "../../lang/String";
+import type { Object } from "../../lang/Object";
+import type { Locale } from "../../util/Locale";
+import type { CharSequence } from "../../lang/CharSequence";
+import type { FilterOutputStream } from "../FilterOutputStream";
+import type { Appendable } from "../../lang/Appendable";
+import type { Closeable } from "../Closeable";
+
+/**
+ * A <code>PrintStream</code> 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 <code>PrintStream</code> never throws an
+ *  <code>IOException</code>; instead, exceptional situations merely set an
+ *  internal flag that can be tested via the <code>checkError</code> method.
+ *  Optionally, a <code>PrintStream</code> can be created so as to flush
+ *  automatically; this means that the <code>flush</code> method is
+ *  automatically invoked after a byte array is written, one of the
+ *  <code>println</code> methods is invoked, or a newline character or byte
+ *  (<code>'\n'</code>) is written.
+ *
+ *  <p> All characters printed by a <code>PrintStream</code> are converted into
+ *  bytes using the platform's default character encoding.  The <code>{@link
+ *  PrintWriter}</code> class should be used in situations that require writing
+ *  characters rather than bytes.
+ * @author Frank Yellin
+ * @author Mark Reinhold
+ * @since JDK1.0
+ */
+export type PrintStream = FilterOutputStream &
+  Appendable &
+  Closeable & {
+    /**
+     * Flushes the stream.  This is done by writing any buffered output bytes to
+     *  the underlying output stream and then flushing that stream.
+     * @see java.io.OutputStream#flush()
+     */
+    flush(): void;
+
+    /**
+     * Closes the stream.  This is done by flushing the stream and then closing
+     *  the underlying output stream.
+     * @see java.io.OutputStream#close()
+     */
+    close(): void;
+
+    /**
+     * Flushes the stream and checks its error state. The internal error state
+     *  is set to <code>true</code> when the underlying output stream throws an
+     *  <code>IOException</code> other than <code>InterruptedIOException</code>,
+     *  and when the <code>setError</code> method is invoked.  If an operation
+     *  on the underlying output stream throws an
+     *  <code>InterruptedIOException</code>, then the <code>PrintStream</code>
+     *  converts the exception back into an interrupt by doing:
+     *  <pre>
+     *      Thread.currentThread().interrupt();
+     *  </pre>
+     *  or the equivalent.
+     * @return <code>true</code> if and only if this stream has encountered an&#xA; <code>IOException</code> other than&#xA; <code>InterruptedIOException</code>, or the&#xA; <code>setError</code> method has been invoked
+     */
+    checkError(): boolean;
+
+    /**
+     * Sets the error state of the stream to <code>true</code>.
+     *
+     *  <p> This method will cause subsequent invocations of {@link
+     *  #checkError()} to return <tt>true</tt> until {@link
+     *  #clearError()} is invoked.
+     * @since JDK1.1
+     */
+    setError(): void;
+
+    /**
+     * Clears the internal error state of this stream.
+     *
+     *  <p> This method will cause subsequent invocations of {@link
+     *  #checkError()} to return <tt>false</tt> until another write
+     *  operation fails and invokes {@link #setError()}.
+     * @since 1.6
+     */
+    clearError(): void;
+
+    /**
+     * Writes the specified byte to this stream.  If the byte is a newline and
+     *  automatic flushing is enabled then the <code>flush</code> method will be
+     *  invoked.
+     *
+     *  <p> 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 <code>print(char)</code> or <code>println(char)</code>
+     *  methods.
+     * @param b The byte to be written
+     * @see #print(char)
+     * @see #println(char)
+     */
+    write(b: number): void;
+
+    /**
+     * Writes <code>len</code> bytes from the specified byte array starting at
+     *  offset <code>off</code> to this stream.  If automatic flushing is
+     *  enabled then the <code>flush</code> method will be invoked.
+     *
+     *  <p> 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 <code>print(char)</code> or <code>println(char)</code>
+     *  methods.
+     * @param buf A byte array
+     * @param off Offset from which to start taking bytes
+     * @param len Number of bytes to write
+     */
+    write(buf: unknown[], off: number, len: number): void;
+
+    /**
+     * Prints a boolean value.  The string produced by <code>{@link
+     *  java.lang.String#valueOf(boolean)}</code> is translated into bytes
+     *  according to the platform's default character encoding, and these bytes
+     *  are written in exactly the manner of the
+     *  <code>{@link #write(int)}</code> method.
+     * @param b The <code>boolean</code> to be printed
+     */
+    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
+     *  <code>{@link #write(int)}</code> method.
+     * @param c The <code>char</code> to be printed
+     */
+    print(c: string): void;
+
+    /**
+     * Prints an integer.  The string produced by <code>{@link
+     *  java.lang.String#valueOf(int)}</code> is translated into bytes
+     *  according to the platform's default character encoding, and these bytes
+     *  are written in exactly the manner of the
+     *  <code>{@link #write(int)}</code> method.
+     * @param i The <code>int</code> to be printed
+     * @see java.lang.Integer#toString(int)
+     */
+    print(i: number): void;
+
+    /**
+     * Prints a long integer.  The string produced by <code>{@link
+     *  java.lang.String#valueOf(long)}</code> is translated into bytes
+     *  according to the platform's default character encoding, and these bytes
+     *  are written in exactly the manner of the
+     *  <code>{@link #write(int)}</code> method.
+     * @param l The <code>long</code> to be printed
+     * @see java.lang.Long#toString(long)
+     */
+    print(l: number): void;
+
+    /**
+     * Prints a floating-point number.  The string produced by <code>{@link
+     *  java.lang.String#valueOf(float)}</code> is translated into bytes
+     *  according to the platform's default character encoding, and these bytes
+     *  are written in exactly the manner of the
+     *  <code>{@link #write(int)}</code> method.
+     * @param f The <code>float</code> to be printed
+     * @see java.lang.Float#toString(float)
+     */
+    print(f: number): void;
+
+    /**
+     * Prints a double-precision floating-point number.  The string produced by
+     *  <code>{@link java.lang.String#valueOf(double)}</code> is translated into
+     *  bytes according to the platform's default character encoding, and these
+     *  bytes are written in exactly the manner of the <code>{@link
+     *  #write(int)}</code> method.
+     * @param d The <code>double</code> to be printed
+     * @see java.lang.Double#toString(double)
+     */
+    print(d: number): 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
+     *  <code>{@link #write(int)}</code> method.
+     * @param s The array of chars to be printed
+     * @throws NullPointerException If <code>s</code> is <code>null</code>
+     */
+    print(s: string[]): void;
+
+    /**
+     * Prints a string.  If the argument is <code>null</code> then the string
+     *  <code>"null"</code> 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
+     *  <code>{@link #write(int)}</code> method.
+     * @param s The <code>String</code> to be printed
+     */
+    print(s: String | string): void;
+
+    /**
+     * Prints an object.  The string produced by the <code>{@link
+     *  java.lang.String#valueOf(Object)}</code> method is translated into bytes
+     *  according to the platform's default character encoding, and these bytes
+     *  are written in exactly the manner of the
+     *  <code>{@link #write(int)}</code> method.
+     * @param obj The <code>Object</code> to be printed
+     * @see java.lang.Object#toString()
+     */
+    print(obj: unknown): void;
+
+    /**
+ * Terminates the current line by writing the line separator string.  The
+ *  line separator string is defined by the system property
+ *  <code>line.separator</code>, and is not necessarily a single newline
+ *  character (<code>'\n'</code>).
+  
+    */
+    println(): void;
+
+    /**
+     * Prints a boolean and then terminate the line.  This method behaves as
+     *  though it invokes <code>{@link #print(boolean)}</code> and then
+     *  <code>{@link #println()}</code>.
+     * @param x The <code>boolean</code> to be printed
+     */
+    println(x: boolean): void;
+
+    /**
+     * Prints a character and then terminate the line.  This method behaves as
+     *  though it invokes <code>{@link #print(char)}</code> and then
+     *  <code>{@link #println()}</code>.
+     * @param x The <code>char</code> to be printed.
+     */
+    println(x: string): void;
+
+    /**
+     * Prints an integer and then terminate the line.  This method behaves as
+     *  though it invokes <code>{@link #print(int)}</code> and then
+     *  <code>{@link #println()}</code>.
+     * @param x The <code>int</code> to be printed.
+     */
+    println(x: number): void;
+
+    /**
+     * Prints a long and then terminate the line.  This method behaves as
+     *  though it invokes <code>{@link #print(long)}</code> and then
+     *  <code>{@link #println()}</code>.
+     * @param x a The <code>long</code> to be printed.
+     */
+    println(x: number): void;
+
+    /**
+     * Prints a float and then terminate the line.  This method behaves as
+     *  though it invokes <code>{@link #print(float)}</code> and then
+     *  <code>{@link #println()}</code>.
+     * @param x The <code>float</code> to be printed.
+     */
+    println(x: number): void;
+
+    /**
+     * Prints a double and then terminate the line.  This method behaves as
+     *  though it invokes <code>{@link #print(double)}</code> and then
+     *  <code>{@link #println()}</code>.
+     * @param x The <code>double</code> to be printed.
+     */
+    println(x: number): void;
+
+    /**
+     * Prints an array of characters and then terminate the line.  This method
+     *  behaves as though it invokes <code>{@link #print(char[])}</code> and
+     *  then <code>{@link #println()}</code>.
+     * @param x an array of chars to print.
+     */
+    println(x: string[]): void;
+
+    /**
+     * Prints a String and then terminate the line.  This method behaves as
+     *  though it invokes <code>{@link #print(String)}</code> and then
+     *  <code>{@link #println()}</code>.
+     * @param x The <code>String</code> to be printed.
+     */
+    println(x: String | string): void;
+
+    /**
+     * 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 <code>{@link #print(String)}</code> and then
+     *  <code>{@link #println()}</code>.
+     * @param x The <code>Object</code> to be printed.
+     */
+    println(x: unknown): void;
+
+    /**
+     * A convenience method to write a formatted string to this output stream
+     *  using the specified format string and arguments.
+     *
+     *  <p> An invocation of this method of the form <tt>out.printf(format,
+     *  args)</tt> behaves in exactly the same way as the invocation
+     *
+     *  <pre>
+     *      out.format(format, args) </pre>
+     * @param format&#xA; A format string as described in <a&#xA; href="../util/Formatter.html#syntax">Format string syntax</a>
+     * @param args&#xA; Arguments referenced by the format specifiers in the format&#xA; string. If there are more arguments than format specifiers, the&#xA; extra arguments are ignored. The number of arguments is&#xA; variable and may be zero. The maximum number of arguments is&#xA; limited by the maximum dimension of a Java array as defined by&#xA; <cite>The Java&trade; Virtual Machine Specification</cite>.&#xA; The behaviour on a&#xA; <tt>null</tt> argument depends on the <a&#xA; href="../util/Formatter.html#syntax">conversion</a>.
+     * @throws java.util.IllegalFormatException&#xA; If a format string contains an illegal syntax, a format&#xA; specifier that is incompatible with the given arguments,&#xA; insufficient arguments given the format string, or other&#xA; illegal conditions. For specification of all possible&#xA; formatting errors, see the <a&#xA; href="../util/Formatter.html#detail">Details</a> section of the&#xA; formatter class specification.
+     * @throws NullPointerException&#xA; If the <tt>format</tt> is <tt>null</tt>
+     * @return This output stream
+     * @since 1.5
+     */
+    printf(format: String | string, args: unknown[]): PrintStream;
+
+    /**
+     * A convenience method to write a formatted string to this output stream
+     *  using the specified format string and arguments.
+     *
+     *  <p> An invocation of this method of the form <tt>out.printf(l, format,
+     *  args)</tt> behaves in exactly the same way as the invocation
+     *
+     *  <pre>
+     *      out.format(l, format, args) </pre>
+     * @param l&#xA; The {@linkplain java.util.Locale locale} to apply during&#xA; formatting. If <tt>l</tt> is <tt>null</tt> then no localization&#xA; is applied.
+     * @param format&#xA; A format string as described in <a&#xA; href="../util/Formatter.html#syntax">Format string syntax</a>
+     * @param args&#xA; Arguments referenced by the format specifiers in the format&#xA; string. If there are more arguments than format specifiers, the&#xA; extra arguments are ignored. The number of arguments is&#xA; variable and may be zero. The maximum number of arguments is&#xA; limited by the maximum dimension of a Java array as defined by&#xA; <cite>The Java&trade; Virtual Machine Specification</cite>.&#xA; The behaviour on a&#xA; <tt>null</tt> argument depends on the <a&#xA; href="../util/Formatter.html#syntax">conversion</a>.
+     * @throws java.util.IllegalFormatException&#xA; If a format string contains an illegal syntax, a format&#xA; specifier that is incompatible with the given arguments,&#xA; insufficient arguments given the format string, or other&#xA; illegal conditions. For specification of all possible&#xA; formatting errors, see the <a&#xA; href="../util/Formatter.html#detail">Details</a> section of the&#xA; formatter class specification.
+     * @throws NullPointerException&#xA; If the <tt>format</tt> is <tt>null</tt>
+     * @return This output stream
+     * @since 1.5
+     */
+    printf(l: Locale, format: String | string, args: unknown[]): PrintStream;
+
+    /**
+     * Writes a formatted string to this output stream using the specified
+     *  format string and arguments.
+     *
+     *  <p> 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&#xA; A format string as described in <a&#xA; href="../util/Formatter.html#syntax">Format string syntax</a>
+     * @param args&#xA; Arguments referenced by the format specifiers in the format&#xA; string. If there are more arguments than format specifiers, the&#xA; extra arguments are ignored. The number of arguments is&#xA; variable and may be zero. The maximum number of arguments is&#xA; limited by the maximum dimension of a Java array as defined by&#xA; <cite>The Java&trade; Virtual Machine Specification</cite>.&#xA; The behaviour on a&#xA; <tt>null</tt> argument depends on the <a&#xA; href="../util/Formatter.html#syntax">conversion</a>.
+     * @throws java.util.IllegalFormatException&#xA; If a format string contains an illegal syntax, a format&#xA; specifier that is incompatible with the given arguments,&#xA; insufficient arguments given the format string, or other&#xA; illegal conditions. For specification of all possible&#xA; formatting errors, see the <a&#xA; href="../util/Formatter.html#detail">Details</a> section of the&#xA; formatter class specification.
+     * @throws NullPointerException&#xA; If the <tt>format</tt> is <tt>null</tt>
+     * @return This output stream
+     * @since 1.5
+     */
+    format(format: String | string, args: unknown[]): PrintStream;
+
+    /**
+     * Writes a formatted string to this output stream using the specified
+     *  format string and arguments.
+     * @param l&#xA; The {@linkplain java.util.Locale locale} to apply during&#xA; formatting. If <tt>l</tt> is <tt>null</tt> then no localization&#xA; is applied.
+     * @param format&#xA; A format string as described in <a&#xA; href="../util/Formatter.html#syntax">Format string syntax</a>
+     * @param args&#xA; Arguments referenced by the format specifiers in the format&#xA; string. If there are more arguments than format specifiers, the&#xA; extra arguments are ignored. The number of arguments is&#xA; variable and may be zero. The maximum number of arguments is&#xA; limited by the maximum dimension of a Java array as defined by&#xA; <cite>The Java&trade; Virtual Machine Specification</cite>.&#xA; The behaviour on a&#xA; <tt>null</tt> argument depends on the <a&#xA; href="../util/Formatter.html#syntax">conversion</a>.
+     * @throws java.util.IllegalFormatException&#xA; If a format string contains an illegal syntax, a format&#xA; specifier that is incompatible with the given arguments,&#xA; insufficient arguments given the format string, or other&#xA; illegal conditions. For specification of all possible&#xA; formatting errors, see the <a&#xA; href="../util/Formatter.html#detail">Details</a> section of the&#xA; formatter class specification.
+     * @throws NullPointerException&#xA; If the <tt>format</tt> is <tt>null</tt>
+     * @return This output stream
+     * @since 1.5
+     */
+    format(l: Locale, format: String | string, args: unknown[]): PrintStream;
+
+    /**
+     * Appends the specified character sequence to this output stream.
+     *
+     *  <p> An invocation of this method of the form <tt>out.append(csq)</tt>
+     *  behaves in exactly the same way as the invocation
+     *
+     *  <pre>
+     *      out.print(csq.toString()) </pre>
+     *
+     *  <p> Depending on the specification of <tt>toString</tt> for the
+     *  character sequence <tt>csq</tt>, the entire sequence may not be
+     *  appended.  For instance, invoking then <tt>toString</tt> method of a
+     *  character buffer will return a subsequence whose content depends upon
+     *  the buffer's position and limit.
+     * @param csq&#xA; The character sequence to append. If <tt>csq</tt> is&#xA; <tt>null</tt>, then the four characters <tt>"null"</tt> are&#xA; appended to this output stream.
+     * @return This output stream
+     * @since 1.5
+     */
+    append(csq: CharSequence): PrintStream;
+
+    /**
+     * Appends a subsequence of the specified character sequence to this output
+     *  stream.
+     *
+     *  <p> An invocation of this method of the form <tt>out.append(csq, start,
+     *  end)</tt> when <tt>csq</tt> is not <tt>null</tt>, behaves in
+     *  exactly the same way as the invocation
+     *
+     *  <pre>
+     *      out.print(csq.subSequence(start, end).toString()) </pre>
+     * @param csq&#xA; The character sequence from which a subsequence will be&#xA; appended. If <tt>csq</tt> is <tt>null</tt>, then characters&#xA; will be appended as if <tt>csq</tt> contained the four&#xA; characters <tt>"null"</tt>.
+     * @param start&#xA; The index of the first character in the subsequence
+     * @param end&#xA; The index of the character following the last character in the&#xA; subsequence
+     * @return This output stream
+     * @throws IndexOutOfBoundsException&#xA; If <tt>start</tt> or <tt>end</tt> are negative, <tt>start</tt>&#xA; is greater than <tt>end</tt>, or <tt>end</tt> is greater than&#xA; <tt>csq.length()</tt>
+     * @since 1.5
+     */
+    append(csq: CharSequence, start: number, end: number): PrintStream;
+
+    /**
+     * Appends the specified character to this output stream.
+     *
+     *  <p> An invocation of this method of the form <tt>out.append(c)</tt>
+     *  behaves in exactly the same way as the invocation
+     *
+     *  <pre>
+     *      out.print(c) </pre>
+     * @param c&#xA; The 16-bit character to append
+     * @return This output stream
+     * @since 1.5
+     */
+    append(c: string): PrintStream;
+  };

package/types/java/io/PrintStream/index.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  flush: function flush() {},
+  close: function close() {},
+  checkError: function checkError() {},
+  setError: function setError() {},
+  clearError: function clearError() {},
+  write: function write() {},
+  print: function print() {},
+  println: function println() {},
+  printf: function printf() {},
+  format: function format() {},
+  append: function append() {}
+};
+exports["default"] = _default;