OutputStreamWriter (Java 2 Platform SE 5.0) (original) (raw)

java.io

Class OutputStreamWriter

java.lang.Object extended by java.io.Writer java.io.OutputStreamWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable

Direct Known Subclasses:

FileWriter

public class OutputStreamWriter

extends Writer

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 twochar values: A high surrogate in the range '\uD800' to '\uDBFF' followed by a low surrogate in the range '\uDC00' to '\uDFFF'. If the character represented by a surrogate pair cannot be encoded by a given charset then a charset-dependent substitution sequence is written to the output stream.

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. It is illegal to attempt to write a character stream containing malformed surrogate elements. The behavior of an instance of this class when a malformed surrogate element is written is not specified.

Since:

JDK1.1

See Also:

BufferedWriter, OutputStream, Charset

Field Summary

Fields inherited from class java.io.Writer
lock

Constructor Summary
OutputStreamWriter(OutputStream out) Create an OutputStreamWriter that uses the default character encoding.
[OutputStreamWriter](../../java/io/OutputStreamWriter.html#OutputStreamWriter%28java.io.OutputStream, java.nio.charset.Charset%29)(OutputStream out,Charset cs) Create an OutputStreamWriter that uses the given charset.
[OutputStreamWriter](../../java/io/OutputStreamWriter.html#OutputStreamWriter%28java.io.OutputStream, java.nio.charset.CharsetEncoder%29)(OutputStream out,CharsetEncoder enc) Create an OutputStreamWriter that uses the given charset encoder.
[OutputStreamWriter](../../java/io/OutputStreamWriter.html#OutputStreamWriter%28java.io.OutputStream, java.lang.String%29)(OutputStream out,String charsetName) Create an OutputStreamWriter that uses the named charset.

Method Summary
void	close() Close the stream.
void	flush() Flush the stream.
String	getEncoding() Return the name of the character encoding being used by this stream.
void	[write](../../java/io/OutputStreamWriter.html#write%28char[], int, int%29)(char[] cbuf, int off, int len) Write a portion of an array of characters.
void	write(int c) Write a single character.
void	[write](../../java/io/OutputStreamWriter.html#write%28java.lang.String, int, int%29)(String str, int off, int len) Write a portion of a string.

Methods inherited from class java.io.Writer
append, append, [append](../../java/io/Writer.html#append%28java.lang.CharSequence, int, int%29), write, write

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)

Constructor Detail

OutputStreamWriter

public OutputStreamWriter(OutputStream out, String charsetName) throws UnsupportedEncodingException

Create an OutputStreamWriter that uses the named charset.

Parameters:

out - An OutputStream

charsetName - The name of a supportedcharset

Throws:

[UnsupportedEncodingException](../../java/io/UnsupportedEncodingException.html "class in java.io") - If the named encoding is not supported

OutputStreamWriter

public OutputStreamWriter(OutputStream out)

Create an OutputStreamWriter that uses the default character encoding.

Parameters:

out - An OutputStream

OutputStreamWriter

public OutputStreamWriter(OutputStream out, Charset cs)

Create an OutputStreamWriter that uses the given charset.

Parameters:

out - An OutputStream

cs - A charset

Since:

1.4

OutputStreamWriter

public OutputStreamWriter(OutputStream out, CharsetEncoder enc)

Create an OutputStreamWriter that uses the given charset encoder.

Parameters:

out - An OutputStream

enc - A charset encoder

Since:

1.4

Method Detail

getEncoding

public String getEncoding()

Return 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)](../../java/io/OutputStreamWriter.html#OutputStreamWriter%28java.io.OutputStream, java.lang.String%29) 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:

The historical name of this encoding, or possiblynull if the stream has been closed

See Also:

Charset

write

public void write(int c) throws IOException

Write a single character.

Overrides:

[write](../../java/io/Writer.html#write%28int%29) in class [Writer](../../java/io/Writer.html "class in java.io")

Parameters:

c - int specifying a character to be written.

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

write

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

Write a portion of an array of characters.

Specified by:

[write](../../java/io/Writer.html#write%28char[], int, int%29) in class [Writer](../../java/io/Writer.html "class in java.io")

Parameters:

cbuf - Buffer of characters

off - Offset from which to start writing characters

len - Number of characters to write

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

write

public void write(String str, int off, int len) throws IOException

Write a portion of a string.

Overrides:

[write](../../java/io/Writer.html#write%28java.lang.String, int, int%29) in class [Writer](../../java/io/Writer.html "class in java.io")

Parameters:

str - A String

off - Offset from which to start writing characters

len - Number of characters to write

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

flush

public void flush() throws IOException

Flush the stream.

Specified by:

[flush](../../java/io/Flushable.html#flush%28%29) in interface [Flushable](../../java/io/Flushable.html "interface in java.io")

Specified by:

[flush](../../java/io/Writer.html#flush%28%29) in class [Writer](../../java/io/Writer.html "class in java.io")

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

close

public void close() throws IOException

Close the stream.

Specified by:

[close](../../java/io/Closeable.html#close%28%29) in interface [Closeable](../../java/io/Closeable.html "interface in java.io")

Specified by:

[close](../../java/io/Writer.html#close%28%29) in class [Writer](../../java/io/Writer.html "class in java.io")

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.