Liking cljdoc? Tell your friends :D

jdk.io.PrintWriter

Prints formatted representations of objects to a text-output stream. This class implements all of the print methods found in PrintStream. It does not contain methods for writing raw bytes, for which a program should use unencoded byte streams.

Unlike the 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 checkError().

Prints formatted representations of objects to a text-output stream.  This
class implements all of the print methods found in PrintStream.  It does not contain methods for writing raw bytes, for which
a program should use unencoded byte streams.

 Unlike the 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 checkError().
raw docstring

->print-writerclj

(->print-writer out)
(->print-writer out auto-flush)

Constructor.

Creates a new PrintWriter.

out - A character-output stream - java.io.Writer auto-flush - A boolean; if true, the println, printf, or format methods will flush the output buffer - boolean

Constructor.

Creates a new PrintWriter.

out - A character-output stream - `java.io.Writer`
auto-flush - A boolean; if true, the println, printf, or format methods will flush the output buffer - `boolean`
raw docstring

appendclj

(append this csq)
(append this csq start 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())

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". - java.lang.CharSequence start - The index of the first character in the subsequence - int end - The index of the character following the last character in the subsequence - int

returns: This writer - java.io.PrintWriter

throws: java.lang.IndexOutOfBoundsException - If start or end are negative, start is greater than end, or end is greater than csq.length()

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())

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". - `java.lang.CharSequence`
start - The index of the first character in the subsequence - `int`
end - The index of the character following the last character in the subsequence - `int`

returns: This writer - `java.io.PrintWriter`

throws: java.lang.IndexOutOfBoundsException - If start or end are negative, start is greater than end, or end is greater than csq.length()
raw docstring

check-errorclj

(check-error this)

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. - boolean

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. - `boolean`
raw docstring

closeclj

(close this)

Closes the stream and releases any system resources associated with it. Closing a previously closed stream has no effect.

Closes the stream and releases any system resources associated
with it. Closing a previously closed stream has no effect.
raw docstring

flushclj

(flush this)

Flushes the stream.

Flushes the stream.
raw docstring

formatclj

(format this format args)
(format this l format 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.

l - The java.util.locale to apply during formatting. If l is null then no localization is applied. - java.util.Locale format - A format string as described in Format string syntax. - java.lang.String 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. - java.lang.Object

returns: This writer - java.io.PrintWriter

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.

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.

l - The java.util.locale to apply during formatting. If l is null then no localization is applied. - `java.util.Locale`
format - A format string as described in Format string syntax. - `java.lang.String`
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. - `java.lang.Object`

returns: This writer - `java.io.PrintWriter`

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.
raw docstring

printclj

(print this b)

Prints a boolean value. The string produced by 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 write(int) method.

b - The boolean to be printed - boolean

Prints a boolean value.  The string produced by 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 write(int) method.

b - The boolean to be printed - `boolean`
raw docstring

printfclj

(printf this format args)
(printf this l format 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)

l - The java.util.locale to apply during formatting. If l is null then no localization is applied. - java.util.Locale format - A format string as described in Format string syntax. - java.lang.String 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. - java.lang.Object

returns: This writer - java.io.PrintWriter

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.

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)

l - The java.util.locale to apply during formatting. If l is null then no localization is applied. - `java.util.Locale`
format - A format string as described in Format string syntax. - `java.lang.String`
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. - `java.lang.Object`

returns: This writer - `java.io.PrintWriter`

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.
raw docstring

printlnclj

(println this)
(println this x)

Prints a boolean value and then terminates the line. This method behaves as though it invokes print(boolean) and then println().

x - the boolean value to be printed - boolean

Prints a boolean value and then terminates the line.  This method behaves
 as though it invokes print(boolean) and then
 println().

x - the boolean value to be printed - `boolean`
raw docstring

writeclj

(write this c)
(write this buf off len)

Writes A Portion of an array of characters.

buf - Array of characters - char[] off - Offset from which to start writing characters - int len - Number of characters to write - int

Writes A Portion of an array of characters.

buf - Array of characters - `char[]`
off - Offset from which to start writing characters - `int`
len - Number of characters to write - `int`
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close