com.ziesemer.utils.codec.io

Class CharEncoderOutputStream

java.lang.Object

java.io.OutputStream

com.ziesemer.utils.codec.io.CharEncoderOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class CharEncoderOutputStream
extends OutputStream

Accepts raw bytes, and writes the encoded characters. Counter-part to CharDecoderWriter. This is a push-interface; CharEncoderReader is the equivalent pull-interface.

Can be adapted to write bytes to the consumer (instead of characters) by using a OutputStreamWriter as the Writer. Can also be adapted to accept characters from the provider (instead of raw bytes) by wrapping in a OutputStreamWriter.

Author:

Mark A. Ziesemer <www.ziesemer.com>

Field Summary

Fields

Modifier and Type	Field and Description
protected IByteToCharEncoder	encoder
protected ByteBuffer	readBuffer
protected byte[]	singleByte
protected CharBuffer	writeBuffer
protected Writer	writer

Constructor Summary

Constructors

Constructor and Description
CharEncoderOutputStream(IByteToCharEncoder encoder, Writer writer)
CharEncoderOutputStream(IByteToCharEncoder encoder, Writer writer, int readBufferSize)

Method Summary

Modifier and Type	Method and Description
void	close() Convenience method that calls close(boolean) with true.
void	close(boolean closeParent) Must be called when there is no more data to encode.
void	flush()
void	write(byte[] b, int off, int len)
void	write(int b)
protected void	writeBuffer(CoderResult cr)

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

Field Detail

encoder

protected IByteToCharEncoder encoder

writer

protected Writer writer

readBuffer

protected ByteBuffer readBuffer

writeBuffer

protected CharBuffer writeBuffer

singleByte

protected byte[] singleByte

Constructor Detail

CharEncoderOutputStream

public CharEncoderOutputStream(IByteToCharEncoder encoder,
                               Writer writer)

CharEncoderOutputStream

public CharEncoderOutputStream(IByteToCharEncoder encoder,
                               Writer writer,
                               int readBufferSize)

Method Detail

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

writeBuffer

protected void writeBuffer(CoderResult cr)
                    throws IOException

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Convenience method that calls close(boolean) with true.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

close

public void close(boolean closeParent)
           throws IOException

Must be called when there is no more data to encode. This finishes the encoding, writes any finishing characters required by the encoder, flushes the parent writer, and resets the encoder for possible reuse.

Parameters:

closeParent - If true, Writer.close() will be called on the parent. If false, only will be called, allowing for additional data to be written to the parent before closing it.

Throws:

IOException