java.io
Class OutputStreamWriter
java.lang.Object
|
+--java.io.Writer
|
+--java.io.OutputStreamWriter
- public class OutputStreamWriter
- extends Writer
An OutputStreamWriter is a bridge from character streams to byte streams:
Characters written to it are translated into bytes according to a specified
character encoding. The
encoding that it uses may be specified by name, or the platform's default
encoding 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));
Field Summary |
protected Writer |
out
The underlying character-output stream. |
Method Summary |
void |
close()
Close the stream. |
void |
flush()
Flush the stream. |
void |
write(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.lang.String str,
int off,
int len)
Write a portion of a string. |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
out
protected Writer out
- The underlying character-output stream.
OutputStreamWriter
public OutputStreamWriter(OutputStream os)
- Create an OutputStreamWriter that uses the default character encoding.
- Parameters:
out
- An OutputStream
OutputStreamWriter
public OutputStreamWriter(OutputStream os,
java.lang.String enc)
throws UnsupportedEncodingException
- Create an OutputStreamWriter that uses the named character encoding.
- Parameters:
out
- An OutputStreamenc
- The name of a supported- Throws:
- UnsupportedEncodingException - If the named encoding is not supported
write
public void write(int c)
throws IOException
- Write a single character.
- Overrides:
- write in class Writer
- Throws:
- IOException - 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.
- Overrides:
- write in class Writer
- Parameters:
cbuf
- Buffer of characters to be writtenoff
- Offset from which to start reading characterslen
- Number of characters to be written- Throws:
- IOException - If an I/O error occurs
write
public void write(java.lang.String str,
int off,
int len)
throws IOException
- Write a portion of a string.
- Overrides:
- write in class Writer
- Parameters:
str
- String to be writtenoff
- Offset from which to start reading characterslen
- Number of characters to be written- Throws:
- IOException - If an I/O error occurs
flush
public void flush()
throws IOException
- Flush the stream.
- Overrides:
- flush in class Writer
- Throws:
- IOException - If an I/O error occurs
close
public void close()
throws IOException
- Close the stream.
- Overrides:
- close in class Writer
- Throws:
- IOException - If an I/O error occurs