com.ziesemer.utils.codec.io

Class CharDecoderWriter

java.lang.Object

java.io.Writer

com.ziesemer.utils.codec.io.CharDecoderWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class CharDecoderWriter
extends Writer

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

Can be adapted to accept bytes from a provider (instead of characters) by wrapping in a OutputStreamWriter.

Author:

Mark A. Ziesemer <www.ziesemer.com>

Field Summary

Fields

Modifier and Type	Field and Description
protected ICharToByteDecoder	decoder
protected OutputStream	outputStream
protected CharBuffer	readBuffer
protected ByteBuffer	writeBuffer

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
CharDecoderWriter(ICharToByteDecoder decoder, OutputStream outputStream)
CharDecoderWriter(ICharToByteDecoder decoder, OutputStream outputStream, 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 decode.
void	flush()
void	write(char[] cbuf, int off, int len)
protected void	writeBuffer(CoderResult cr)

Methods inherited from class java.io.Writer

append, append, append, write, write, write, write

Methods inherited from class java.lang.Object

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

Field Detail

decoder

protected ICharToByteDecoder decoder

outputStream

protected OutputStream outputStream

readBuffer

protected CharBuffer readBuffer

writeBuffer

protected ByteBuffer writeBuffer

Constructor Detail

CharDecoderWriter

public CharDecoderWriter(ICharToByteDecoder decoder,
                         OutputStream outputStream)

CharDecoderWriter

public CharDecoderWriter(ICharToByteDecoder decoder,
                         OutputStream outputStream,
                         int readBufferSize)

Method Detail

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws IOException

Specified by:

write in class Writer

Throws:

IOException

writeBuffer

protected void writeBuffer(CoderResult cr)
                    throws IOException

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

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

Specified by:

close in class Writer

Throws:

IOException

close

public void close(boolean closeParent)
           throws IOException

Must be called when there is no more data to decode. This finishes the decoding, writes any finishing bytes required by the decoder, flushes the parent stream, and resets the decoder for possible reuse.

Parameters:

closeParent - If true, OutputStream.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