OutputStreamWriter

public class OutputStreamWriter extends Writer

Known Direct Subclasses FileWriter FileWriter Convenience class for writing character files.

A class for turning a character stream into a byte stream. Data written to the target input stream is converted into bytes by either a default or a provided character converter. The default encoding is taken from the "file.encoding" system property. OutputStreamWriter contains a buffer of bytes to be written to target stream and converts these into characters as needed. The buffer size is 8K.

See Also

• InputStreamReader

Inherited Field Summary

From class java.io.Writer

protected Object

lock

The object used to synchronize operations on this stream.

Public Constructor Summary

	OutputStreamWriter(OutputStream out) Constructs a new OutputStreamWriter using out as the target stream to write converted characters to.
	OutputStreamWriter(OutputStream out, String charsetName) Constructs a new OutputStreamWriter using out as the target stream to write converted characters to and charsetName as the character encoding.
	OutputStreamWriter(OutputStream out, Charset cs) Constructs a new OutputStreamWriter using out as the target stream to write converted characters to and cs as the character encoding.
	OutputStreamWriter(OutputStream out, CharsetEncoder charsetEncoder) Constructs a new OutputStreamWriter using out as the target stream to write converted characters to and charsetEncoder as the character encoder.

Public Method Summary

void	close() Closes this writer.
void	flush() Flushes this writer.
String	getEncoding() Returns the canonical name of the encoding used by this writer to convert characters to bytes, or null if this writer has been closed.
void	write(int oneChar) Writes the character oneChar to this writer.
void	write(String str, int offset, int count) Writes count characters starting at offset in str to this writer.
void	write(char[] buffer, int offset, int count) Writes count characters starting at offset in buf to this writer.

Inherited Method Summary

From class java.io.Writer

Writer	append(char c) Appends the specified character to this writer.
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.
abstract void	close() Closes the stream, flushing it first.
abstract void	flush() Flushes the stream.
void	write(String str) Writes a string.
void	write(int c) Writes a single character.
void	write(String str, int off, int len) Writes a portion of a string.
abstract void	write(char[] cbuf, int off, int len) Writes a portion of an array of characters.
void	write(char[] cbuf) Writes an array of characters.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface java.lang.Appendable

abstract Appendable	append(char c) Appends the specified character to this Appendable.
abstract Appendable	append(CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this Appendable.
abstract Appendable	append(CharSequence csq) Appends the specified character sequence to this Appendable.

From interface java.io.Closeable

abstract void

close() Closes this stream and releases any system resources associated with it.

From interface java.io.Flushable

abstract void

flush() Flushes this stream by writing any buffered output to the underlying stream.

From interface java.lang.AutoCloseable

abstract void

close() Closes this resource, relinquishing any underlying resources.

Public Constructors

public OutputStreamWriter (OutputStream out)

Constructs a new OutputStreamWriter using out as the target stream to write converted characters to. The default character encoding is used.

Parameters

out	the non-null target stream to write converted bytes to.

public OutputStreamWriter (OutputStream out, String charsetName)

Constructs a new OutputStreamWriter using out as the target stream to write converted characters to and charsetName as the character encoding. If the encoding cannot be found, an UnsupportedEncodingException error is thrown.

Parameters

out	the target stream to write converted bytes to.
charsetName	the string describing the desired character encoding.

Throws

NullPointerException	if charsetName is null.
UnsupportedEncodingException	if the encoding specified by charsetName cannot be found.

public OutputStreamWriter (OutputStream out, Charset cs)

Constructs a new OutputStreamWriter using out as the target stream to write converted characters to and cs as the character encoding.

Parameters

out	the target stream to write converted bytes to.
cs	the Charset that specifies the character encoding.

public OutputStreamWriter (OutputStream out, CharsetEncoder charsetEncoder)

Constructs a new OutputStreamWriter using out as the target stream to write converted characters to and charsetEncoder as the character encoder.

Parameters

out	the target stream to write converted bytes to.
charsetEncoder	the character encoder used for character conversion.

Public Methods

public void close ()

Closes this writer. This implementation flushes the buffer as well as the target stream. The target stream is then closed and the resources for the buffer and converter are released.

Only the first invocation of this method has any effect. Subsequent calls do nothing.

Throws

IOException	if an error occurs while closing this writer.

public void flush ()

Flushes this writer. This implementation ensures that all buffered bytes are written to the target stream. After writing the bytes, the target stream is flushed as well.

Throws

IOException	if an error occurs while flushing this writer.

public String getEncoding ()

Returns the canonical name of the encoding used by this writer to convert characters to bytes, or null if this writer has been closed. Most callers should probably keep track of the String or Charset they passed in; this method may not return the same name.

public void write (int oneChar)

Writes the character oneChar to this writer. The lowest two bytes of the integer oneChar are immediately converted to bytes by the character converter and stored in a local buffer. If the buffer gets full by converting this character, this writer is flushed.

Parameters

oneChar	the character to write.

Throws

IOException	if this writer is closed or another I/O error occurs.

public void write (String str, int offset, int count)

Writes count characters starting at offset in str to this writer. The characters are immediately converted to bytes by the character converter and stored in a local buffer. If the buffer gets full as a result of the conversion, this writer is flushed.

Parameters

str	the string containing characters to write.
offset	the start position in str for retrieving characters.
count	the maximum number of characters to write.

Throws

IOException	if this writer has already been closed or another I/O error occurs.
IndexOutOfBoundsException	if offset < 0 or count < 0, or if offset + count is bigger than the length of str.

public void write (char[] buffer, int offset, int count)

Writes count characters starting at offset in buf to this writer. The characters are immediately converted to bytes by the character converter and stored in a local buffer. If the buffer gets full as a result of the conversion, this writer is flushed.

Parameters

buffer	the array containing characters to write.
offset	the index of the first character in buf to write.
count	the maximum number of characters to write.

Throws

IndexOutOfBoundsException	if offset < 0 or count < 0, or if offset + count is greater than the size of buf.
IOException	if this writer has already been closed or another I/O error occurs.