OutputStreamWriter

Class Overview

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 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 java.nio.charset.CharsetEncoder class should be used when more control over the encoding process is required.

Summary

[Expand] Inherited Fields
From class java.io.Writer protected Object lock The object used to synchronize operations on this stream.

[Expand] Inherited Methods
From class java.io.Writer Writer append(CharSequence csq) Appends the specified character sequence to this writer. Writer append(CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this writer. Writer append(char c) Appends the specified character to this writer. abstract void close() Closes the stream, flushing it first. abstract void flush() Flushes the stream. void write(char[] cbuf) Writes an array of characters. void write(String str) Writes a string. abstract void write(char[] cbuf, int off, int len) Writes a portion of an array of characters. void write(String str, int off, int len) Writes a portion of a string. void write(int c) Writes a single character.
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait() Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object. final void wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed. final void wait(long timeout) Causes the current thread to wait until either another thread invokes the notify() method or the notifyAll() method for this object, or a specified amount of time has elapsed.
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.Appendable abstract Appendable append(CharSequence csq) Appends the specified character sequence 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(char c) Appends the specified character to this Appendable.