OutputStreamWriter

port of java.io.OutputStreamWriter

An OutputStreamWriter is a bridge from character streams to byte streams: Characters written to it are encoded into bytes using a specified [ ]. The charset that it uses may be specified by name or may be given explicitly, or the default charset may be accepted.

Each invocation of a write() method causes the encoding converter to be invoked on the given character(s). The resulting bytes are accumulated in a buffer before being written to the underlying output stream. Note that the characters passed to the write() methods are not buffered.

For top efficiency, consider wrapping an OutputStreamWriter within a BufferedWriter so as to avoid frequent converter invocations. For example:

{@snippet lang=java :

  • Writer out = new BufferedWriter(new OutputStreamWriter(anOutputStream));
  • }

A surrogate pair is a character represented by a sequence of two char values: A high surrogate in the range '\uD800' to '\uDBFF' followed by a low surrogate in the range '\uDC00' to '\uDFFF'.

A malformed surrogate element is a high surrogate that is not followed by a low surrogate or a low surrogate that is not preceded by a high surrogate.

This class always replaces malformed surrogate elements and unmappable character sequences with the charset's default substitution sequence. The CharsetEncoder class should be used when more control over the encoding process is required.

Author

Mark Reinhold

Since

1.1

See also

Constructors

Link copied to clipboard
constructor(out: OutputStream, cs: Charset)

Creates an OutputStreamWriter that uses the given charset.

constructor(out: OutputStream, enc: CharsetEncoder)

Creates an OutputStreamWriter that uses the given charset encoder.

Properties

Link copied to clipboard

Functions

Link copied to clipboard
open override fun append(csq: CharSequence?): Writer

Appends the specified character sequence to this writer.

open override fun append(csq: CharSequence?, start: Int, end: Int): Writer

Appends a subsequence of the specified character sequence to this writer.

open override fun append(c: Char): Writer

Appends the specified character to this writer.

Link copied to clipboard
open override fun close()

Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream has no effect.

Link copied to clipboard
open override fun flush()

Flushes the stream.

Link copied to clipboard

Flushes the output buffer to the underlying byte stream, without flushing the byte stream itself. This method is non-private only so that it may be invoked by PrintStream.

Link copied to clipboard
open override fun write(c: Int)

Writes a single character.

open override fun write(cbuf: CharArray, off: Int, len: Int)

Writes a portion of an array of characters.

open override fun write(str: String, off: Int, len: Int)

Writes a portion of a string.

open fun write(cbuf: CharArray)

Writes an array of characters.

open fun write(str: String)

Writes a string.