OutputStreamWriter

public class OutputStreamWriter
extends Writer

java.lang.Object
   ↳ java.io.Writer
     ↳ 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 charset. The charset that it uses may be specified by name or may be given explicitly, or the platform's 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. The size of this buffer may be specified, but by default it is large enough for most purposes. 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:

 Writer out
   = new BufferedWriter(new OutputStreamWriter(System.out));
 

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.

Summary

Inherited fields

Public constructors

OutputStreamWriter(OutputStream out, String charsetName)

Creates an OutputStreamWriter that uses the named charset.

OutputStreamWriter(OutputStream out)

Creates an OutputStreamWriter that uses the default character encoding.

OutputStreamWriter(OutputStream out, Charset cs)

Creates an OutputStreamWriter that uses the given charset.

OutputStreamWriter(OutputStream out, CharsetEncoder enc)

Creates an OutputStreamWriter that uses the given charset encoder.

Public methods

void close()

Closes the stream, flushing it first.

void flush()

Flushes the stream.

String getEncoding()

Returns the name of the character encoding being used by this stream.

void write(int c)

Writes a single character.

void write(String str, int off, int len)

Writes a portion of a string.

void write(char[] cbuf, int off, int len)

Writes a portion of an array of characters.

Inherited methods

Public constructors

OutputStreamWriter

added in API level 1
OutputStreamWriter (OutputStream out, 
                String charsetName)

Creates an OutputStreamWriter that uses the named charset.

Parameters
out OutputStream: An OutputStream

charsetName String: The name of a supported charset

Throws
UnsupportedEncodingException If the named encoding is not supported

OutputStreamWriter

added in API level 1
OutputStreamWriter (OutputStream out)

Creates an OutputStreamWriter that uses the default character encoding.

Parameters
out OutputStream: An OutputStream

OutputStreamWriter

added in API level 1
OutputStreamWriter (OutputStream out, 
                Charset cs)

Creates an OutputStreamWriter that uses the given charset.

Parameters
out OutputStream: An OutputStream

cs Charset: A charset

OutputStreamWriter

added in API level 1
OutputStreamWriter (OutputStream out, 
                CharsetEncoder enc)

Creates an OutputStreamWriter that uses the given charset encoder.

Parameters
out OutputStream: An OutputStream

enc CharsetEncoder: A charset encoder

Public methods

close

added in API level 1
void 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.

Throws
IOException

flush

added in API level 1
void flush ()

Flushes the stream.

Throws
IOException If an I/O error occurs

getEncoding

added in API level 1
String getEncoding ()

Returns the name of the character encoding being used by this stream.

If the encoding has an historical name then that name is returned; otherwise the encoding's canonical name is returned.

If this instance was created with the OutputStreamWriter(OutputStream, String) constructor then the returned name, being unique for the encoding, may differ from the name passed to the constructor. This method may return null if the stream has been closed.

Returns
String The historical name of this encoding, or possibly null if the stream has been closed

See also:

write

added in API level 1
void write (int c)

Writes a single character.

Parameters
c int: int specifying a character to be written

Throws
IOException If an I/O error occurs

write

added in API level 1
void write (String str, 
                int off, 
                int len)

Writes a portion of a string.

Parameters
str String: A String

off int: Offset from which to start writing characters

len int: Number of characters to write

Throws
IOException If an I/O error occurs

write

added in API level 1
void write (char[] cbuf, 
                int off, 
                int len)

Writes a portion of an array of characters.

Parameters
cbuf char: Buffer of characters

off int: Offset from which to start writing characters

len int: Number of characters to write

Throws
IOException If an I/O error occurs