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

Writer append(CharSequence csq, int start, int end)

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

Writer append(CharSequence csq)

Appends the specified character sequence to this writer.

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
public 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
public OutputStreamWriter (OutputStream out)

Creates an OutputStreamWriter that uses the default character encoding.

Parameters
out OutputStream: An OutputStream

OutputStreamWriter

Added in API level 1
public 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
public 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

append

Added in API level 1
public Writer append (CharSequence csq, 
                int start, 
                int end)

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

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

Parameters
csq CharSequence: 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".

start int: The index of the first character in the subsequence

end int: The index of the character following the last character in the subsequence

Returns
Writer This writer

Throws
IOException

append

Added in API level 1
public Writer append (CharSequence csq)

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.

Parameters
csq CharSequence: The character sequence to append. If csq is null, then the four characters "null" are appended to this writer.

Returns
Writer This writer

Throws
IOException

close

Added in API level 1
public 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
public void flush ()

Flushes the stream.

Throws
IOException If an I/O error occurs

getEncoding

Added in API level 1
public 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(java.io.OutputStream, java.lang.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
public 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
public 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
IndexOutOfBoundsException If off is negative, or len is negative, or off + len is negative or greater than the length of the given string
IOException If an I/O error occurs

write

Added in API level 1
public 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
IndexOutOfBoundsException If off is negative, or len is negative, or off + len is negative or greater than the length of the given array
IOException If an I/O error occurs