java.io

Class OutputStreamWriter

java.lang.Object

java.io.Writer

java.io.OutputStreamWriter

All Implemented Interfaces:

Closeable, Flushable, java.lang.Appendable, java.lang.AutoCloseable

Direct Known Subclasses:

FileWriter

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:

• 8859_1 (ISO-8859-1/Latin-1)
• 8859_2 (ISO-8859-2/Latin-2)
• 8859_3 (ISO-8859-3/Latin-3)
• 8859_4 (ISO-8859-4/Latin-4)
• 8859_5 (ISO-8859-5/Latin-5)
• 8859_6 (ISO-8859-6/Latin-6)
• 8859_7 (ISO-8859-7/Latin-7)
• 8859_8 (ISO-8859-8/Latin-8)
• 8859_9 (ISO-8859-9/Latin-9)
• ASCII (7-bit ASCII)
• UTF8 (UCS Transformation Format-8)
• More Later

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
OutputStreamWriter(OutputStream out) This method initializes a new instance of OutputStreamWriter to write to the specified stream using the default encoding.
OutputStreamWriter(OutputStream out, java.nio.charset.Charset cs) This method initializes a new instance of OutputStreamWriter to write to the specified stream using a given Charset.
OutputStreamWriter(OutputStream out, java.nio.charset.CharsetEncoder enc) This method initializes a new instance of OutputStreamWriter to write to the specified stream using a given CharsetEncoder.
OutputStreamWriter(OutputStream out, java.lang.String encoding_scheme) This method initializes a new instance of OutputStreamWriter to write to the specified stream using a caller supplied character encoding scheme.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() This method closes this stream, and the underlying OutputStream
void	flush() This method flushes any buffered bytes to the underlying output sink.
java.lang.String	getEncoding() This method returns the name of the character encoding scheme currently in use by this stream.
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.
void	write(int ch) This method writes a single character to the output stream.
void	write(java.lang.String str, int offset, int count) This method writes count bytes from the specified String starting at position offset into the String.

Methods inherited from class java.io.Writer

append, append, append, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OutputStreamWriter

public OutputStreamWriter(OutputStream out,
                  java.lang.String encoding_scheme)
                   throws UnsupportedEncodingException

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,
                  java.nio.charset.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,
                  java.nio.charset.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()
           throws IOException

This method closes this stream, and the underlying OutputStream

Specified by:

close in interface Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class Writer

Throws:

IOException - If an error occurs

getEncoding

public java.lang.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

flush

public void flush()
           throws IOException

This method flushes any buffered bytes to the underlying output sink.

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException - If an error occurs

write

public void write(char[] buf,
         int offset,
         int count)
           throws IOException

This method writes count characters from the specified array to the output stream starting at position offset into the array.

Specified by:

write in class Writer

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(java.lang.String str,
         int offset,
         int count)
           throws IOException

This method writes count bytes from the specified String starting at position offset into the String.

Overrides:

write in class Writer

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)
           throws IOException

This method writes a single character to the output stream.

Overrides:

write in class Writer

Parameters:

ch - The char to write, passed as an int.

Throws:

IOException - If an error occurs