java.io

Class OutputStreamWriter

public class OutputStreamWriter extends Writer

This class writes characters to an output stream that is byte oriented It converts the chars that are written to bytes using an encoding layer, which is specific to a particular encoding standard. The desired encoding can either be specified by name, or if no encoding is specified, the system default encoding will be used. The system default encoding name is determined from the system property file.encoding. The only encodings that are guaranteed to be available are "8859_1" (the Latin-1 character set) and "UTF8". Unfortunately, Java does not provide a mechanism for listing the encodings that are supported in a given implementation.

Here is a list of standard encoding names that may be available:

UNKNOWN: April 17, 1998.

Constructor Summary
OutputStreamWriter(OutputStream out, String encoding_scheme)
This method initializes a new instance of OutputStreamWriter to write to the specified stream using a caller supplied character encoding scheme.
OutputStreamWriter(OutputStream out)
This method initializes a new instance of OutputStreamWriter to write to the specified stream using the default encoding.
OutputStreamWriter(OutputStream out, Charset cs)
This method initializes a new instance of OutputStreamWriter to write to the specified stream using a given Charset.
OutputStreamWriter(OutputStream out, CharsetEncoder enc)
This method initializes a new instance of OutputStreamWriter to write to the specified stream using a given CharsetEncoder.
Method Summary
voidclose()
This method closes this stream, and the underlying OutputStream
voidflush()
This method flushes any buffered bytes to the underlying output sink.
StringgetEncoding()
This method returns the name of the character encoding scheme currently in use by this stream.
voidwrite(char[] buf, int offset, int count)
This method writes count characters from the specified array to the output stream starting at position offset into the array.
voidwrite(String str, int offset, int count)
This method writes count bytes from the specified String starting at position offset into the String.
voidwrite(int ch)
This method writes a single character to the output stream.

Constructor Detail

OutputStreamWriter

public OutputStreamWriter(OutputStream out, String encoding_scheme)
This method initializes a new instance of OutputStreamWriter to write to the specified stream using a caller supplied character encoding scheme. Note that due to a deficiency in the Java language design, there is no way to determine which encodings are supported.

Parameters: out The OutputStream to write to encoding_scheme The name of the encoding scheme to use for character to byte translation

Throws: UnsupportedEncodingException If the named encoding is not available.

OutputStreamWriter

public OutputStreamWriter(OutputStream out)
This method initializes a new instance of OutputStreamWriter to write to the specified stream using the default encoding.

Parameters: out The OutputStream to write to

OutputStreamWriter

public OutputStreamWriter(OutputStream out, Charset cs)
This method initializes a new instance of OutputStreamWriter to write to the specified stream using a given Charset.

Parameters: out The OutputStream to write to cs The Charset of the encoding to use

Since: 1.5

OutputStreamWriter

public OutputStreamWriter(OutputStream out, CharsetEncoder enc)
This method initializes a new instance of OutputStreamWriter to write to the specified stream using a given CharsetEncoder.

Parameters: out The OutputStream to write to enc The CharsetEncoder to encode the output with

Since: 1.5

Method Detail

close

public void close()
This method closes this stream, and the underlying OutputStream

Throws: IOException If an error occurs

flush

public void flush()
This method flushes any buffered bytes to the underlying output sink.

Throws: IOException If an error occurs

getEncoding

public String getEncoding()
This method returns the name of the character encoding scheme currently in use by this stream. If the stream has been closed, then this method may return null.

Returns: The encoding scheme name

write

public void write(char[] buf, int offset, int count)
This method writes count characters from the specified array to the output stream starting at position offset into the array.

Parameters: buf The array of character to write from offset The offset into the array to start writing chars from count The number of chars to write.

Throws: IOException If an error occurs

write

public void write(String str, int offset, int count)
This method writes count bytes from the specified String starting at position offset into the String.

Parameters: str The String to write chars from offset The position in the String to start writing chars from count The number of chars to write

Throws: IOException If an error occurs

write

public void write(int ch)
This method writes a single character to the output stream.

Parameters: ch The char to write, passed as an int.

Throws: IOException If an error occurs