io.starter.toolkit

Class WriterOutputStream

java.lang.Object

java.io.OutputStream

io.starter.toolkit.WriterOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class WriterOutputStream
extends OutputStream

A WriterOutputStream is a bridge from byte streams to character streams: bytes written to it are decoded into characters using a specified charset. The charset that it uses may be specified by name or given explicitly, or the system default charset may be used. The decoded characters are written to a provided Appendable, which will usually be a Writer.

The input is buffered so that writes don't need to be aligned to character boundaries. Because conversion is only performed when the input buffer is full (or when the stream is flushed) output also behaves as if it were buffered. It is therefore usually unnecessary to externally buffer the input or output.

In some charsets some or all characters are represented by multi-byte sequences. If a byte sequence is encountered that is not valid in the input charset or that cannot be mapped to a valid Unicode character it will be replaced in the output with the value "�". If more control over the decoding process is required use CharsetDecoder.

See Also:

InputStreamReader, OutputStreamWriter

Constructor Summary

Constructors

Constructor and Description
WriterOutputStream(Appendable target) Creates a WriterOutputStream with the default charset.
WriterOutputStream(Appendable target, Charset charset) Creates a WriterOutputStream with the given charset.
WriterOutputStream(Appendable target, String charset) Creates a WriterOutputStream with the named charset.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the stream, flushing it first.
void	flush() Flushes the input buffer through the decoder.
void	write(byte[] buffer, int offset, int length)
void	write(int b)

Methods inherited from class java.io.OutputStream

write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WriterOutputStream

public WriterOutputStream(Appendable target)

Creates a WriterOutputStream with the default charset.

Parameters:

target - the sink for the decoded characters

WriterOutputStream

public WriterOutputStream(Appendable target,
                          String charset)

Creates a WriterOutputStream with the named charset.

Parameters:

target - the sink for the decoded characters

charset - the character set with which to interpret the input bytes

WriterOutputStream

public WriterOutputStream(Appendable target,
                          Charset charset)

Creates a WriterOutputStream with the given charset.

Parameters:

target - the sink for the decoded characters

charset - the character set with which to interpret the input bytes

Method Detail

write

public void write(byte[] buffer,
                  int offset,
                  int length)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Flushes the input buffer through the decoder. If the input buffer ends with an incomplete character it will remain in the buffer. If the underlying character sink is a Writer its flush method will be called after all buffered input has been flushed.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Closes the stream, flushing it first. If any partial characters remain in the input buffer the replacement value will be output in their place. If the underlying character sink is a Writer its close method will be called after all buffered input has been flushed. Once the stream has been closed further calls to write or flush will cause an IOException to be thrown. Closing a previously closed stream has no effect.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException