Build 1.0_r1(from source)

java.io
Class OutputStreamWriter

java.lang.Object
  extended by java.io.Writer
      extended by java.io.OutputStreamWriter
All Implemented Interfaces:
Closeable, Flushable, Appendable
Direct Known Subclasses:
FileWriter

public class OutputStreamWriter
extends Writer

OutputStreamWriter is a class for turning a character output stream into a byte output stream. The conversion of Unicode characters to their byte equivalents is determined by the converter used. By default, the encoding is ISO8859_1 (ISO-Latin-1) but can be changed by calling the constructor which takes an encoding.

See Also:
InputStreamReader

Field Summary
 
Fields inherited from class java.io.Writer
lock, TOKEN_NULL
 
Constructor Summary
OutputStreamWriter(OutputStream out)
          Constructs a new OutputStreamWriter using out as the OutputStream to write converted characters to.
OutputStreamWriter(OutputStream out, Charset cs)
          Constructs a new OutputStreamWriter using out as the OutputStream to write converted characters to and cs as the character encoding.
OutputStreamWriter(OutputStream out, CharsetEncoder enc)
          Constructs a new OutputStreamWriter using out as the OutputStream to write converted characters to and enc as the character encoding.
OutputStreamWriter(OutputStream out, String enc)
          Constructs a new OutputStreamWriter using out as the OutputStream to write converted characters to and enc as the character encoding.
 
Method Summary
 void close()
          Close this OutputStreamWriter.
 void flush()
          Flush this OutputStreamWriter.
 String getEncoding()
          Answer the String which identifies the encoding used to convert characters to bytes.
 void write(char[] buf, int offset, int count)
          Writes count characters starting at offset in buf to this Writer.
 void write(int oneChar)
          Writes out 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.
 
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)
Constructs a new OutputStreamWriter using out as the OutputStream to write converted characters to. The default character encoding is used (see class description).

Parameters:
out - the non-null OutputStream to write converted bytes to.

OutputStreamWriter

public OutputStreamWriter(OutputStream out,
                          String enc)
                   throws UnsupportedEncodingException
Constructs a new OutputStreamWriter using out as the OutputStream to write converted characters to and enc as the character encoding. If the encoding cannot be found, an UnsupportedEncodingException error is thrown.

Parameters:
out - the non-null OutputStream to write converted bytes to.
enc - the non-null String describing the desired character encoding.
Throws:
UnsupportedEncodingException - if the encoding cannot be found.

OutputStreamWriter

public OutputStreamWriter(OutputStream out,
                          Charset cs)
Constructs a new OutputStreamWriter using out as the OutputStream to write converted characters to and cs as the character encoding.

Parameters:
out - the non-null OutputStream to write converted bytes to.
cs - the non-null Charset which specify the character encoding.

OutputStreamWriter

public OutputStreamWriter(OutputStream out,
                          CharsetEncoder enc)
Constructs a new OutputStreamWriter using out as the OutputStream to write converted characters to and enc as the character encoding.

Parameters:
out - the non-null OutputStream to write converted bytes to.
enc - the non-null CharsetEncoder which used to character encoding.
Method Detail

close

public void close()
           throws IOException
Close this OutputStreamWriter. This implementation first flushes the buffer and the target OutputStream. The OutputStream is then closed and the resources for the buffer and converter are freed.

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

Specified by:
close in interface Closeable
Specified by:
close in class Writer
Throws:
IOException - If an error occurs attempting to close this OutputStreamWriter.

flush

public void flush()
           throws IOException
Flush this OutputStreamWriter. This implementation ensures all buffered bytes are written to the target OutputStream. After writing the bytes, the target OutputStream is then flushed.

Specified by:
flush in interface Flushable
Specified by:
flush in class Writer
Throws:
IOException - If an error occurs attempting to flush this OutputStreamWriter.

getEncoding

public String getEncoding()
Answer the String which identifies the encoding used to convert characters to bytes. The value null is returned if this Writer has been closed.

Returns:
the String describing the converter or null if this Writer is closed.

write

public void write(char[] buf,
                  int offset,
                  int count)
           throws IOException
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 becomes full as a result of this write, this Writer is flushed.

Specified by:
write in class Writer
Parameters:
buf - the non-null array containing characters to write.
offset - offset in buf to retrieve characters
count - maximum number of characters to write
Throws:
IOException - If this OutputStreamWriter has already been closed or some other IOException occurs.
IndexOutOfBoundsException - If offset or count is outside of bounds.

write

public void write(int oneChar)
           throws IOException
Writes out the character oneChar to this Writer. The low-order 2 bytes are immediately converted to bytes by the character converter and stored in a local buffer. If the buffer becomes full as a result of this write, this Writer is flushed.

Overrides:
write in class Writer
Parameters:
oneChar - the character to write
Throws:
IOException - If this OutputStreamWriter has already been closed or some other IOException occurs.

write

public void write(String str,
                  int offset,
                  int count)
           throws IOException
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 becomes full as a result of this write, this Writer is flushed.

Overrides:
write in class Writer
Parameters:
str - the non-null String containing characters to write.
offset - offset in str to retrieve characters
count - maximum number of characters to write
Throws:
IOException - If this OutputStreamWriter has already been closed or some other IOException occurs.
IndexOutOfBoundsException - If count is negative
StringIndexOutOfBoundsException - If offset is negative or offset + count is outside of bounds

Build 1.0_r1(from source)

Please submit a feedback, bug or feature