Class EncoderStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

com.twelvemonkeys.io.enc.EncoderStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public final class EncoderStream
extends FilterOutputStream

An OutputStream that provides on-the-fly encoding to an underlying stream.

Version:

$Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/EncoderStream.java#2 $

See Also:

• DecoderStream
• Encoder

Field Summary

Fields

Modifier and Type	Field	Description
private final ByteBuffer	buffer
private final Encoder	encoder
private final boolean	flushOnWrite

Fields inherited from class FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
EncoderStream(OutputStream stream, Encoder encoder)	Creates an output stream filter built on top of the specified underlying output stream.
EncoderStream(OutputStream stream, Encoder encoder, boolean flushOnWrite)	Creates an output stream filter built on top of the specified underlying output stream.

Method Summary

Modifier and Type	Method	Description
void	close()
private void	encodeBuffer()
void	flush()
void	write(byte[] bytes)
void	write(byte[] values, int offset, int length)
void	write(int value)

Methods inherited from class OutputStream

nullOutputStream

Methods inherited from class Object

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

Field Details

encoder

private final Encoder encoder

flushOnWrite

private final boolean flushOnWrite

buffer

private final ByteBuffer buffer

Constructor Details

EncoderStream

public EncoderStream(OutputStream stream,
 Encoder encoder)

Creates an output stream filter built on top of the specified underlying output stream.

Parameters:

stream - the underlying output stream

encoder - the encoder to use

EncoderStream

public EncoderStream(OutputStream stream,
 Encoder encoder,
 boolean flushOnWrite)

Creates an output stream filter built on top of the specified underlying output stream.

Parameters:

stream - the underlying output stream

encoder - the encoder to use

flushOnWrite - if true, calls to the byte-array write methods will automatically flush the buffer.

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterOutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class FilterOutputStream

Throws:

IOException

encodeBuffer

private void encodeBuffer()
                   throws IOException

Throws:

IOException

write

public void write(byte[] bytes)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

write

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

Overrides:

write in class FilterOutputStream

Throws:

IOException

write

public void write(int value)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException