Class DecoderStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.twelvemonkeys.io.enc.DecoderStream

All Implemented Interfaces:

Closeable, AutoCloseable

public final class DecoderStream
extends FilterInputStream

An InputStream that provides on-the-fly decoding from an underlying stream.

Version:

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

See Also:

• EncoderStream
• Decoder

Field Summary

Fields

Modifier and Type	Field	Description
private final ByteBuffer	buffer
private final Decoder	decoder

Fields inherited from class FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
DecoderStream(InputStream stream, Decoder decoder)	Creates a new decoder stream and chains it to the input stream specified by the stream argument.
DecoderStream(InputStream stream, Decoder decoder, int bufferSize)	Creates a new decoder stream and chains it to the input stream specified by the stream argument.

Method Summary

Modifier and Type	Method	Description
int	available()
private int	fill()	Fills the buffer, by decoding data from the underlying input stream.
int	read()
int	read(byte[] bytes, int offset, int length)
long	skip(long length)

Methods inherited from class FilterInputStream

close, mark, markSupported, read, reset

Methods inherited from class InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class Object

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

Field Details

buffer

private final ByteBuffer buffer

decoder

private final Decoder decoder

Constructor Details

DecoderStream

public DecoderStream(InputStream stream,
 Decoder decoder)

Creates a new decoder stream and chains it to the input stream specified by the stream argument. The stream will use a default decode buffer size.

Parameters:

stream - the underlying input stream.

decoder - the decoder that will be used to decode the underlying stream

See Also:

• FilterInputStream.in

DecoderStream

public DecoderStream(InputStream stream,
 Decoder decoder,
 int bufferSize)

Creates a new decoder stream and chains it to the input stream specified by the stream argument.

Parameters:

stream - the underlying input stream.

decoder - the decoder that will be used to decode the underlying stream

bufferSize - the size of the decode buffer

See Also:

• FilterInputStream.in

Method Details

available

public int available()
              throws IOException

Overrides:

available in class FilterInputStream

Throws:

IOException

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read(byte[] bytes,
 int offset,
 int length)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

skip

public long skip(long length)
          throws IOException

Overrides:

skip in class FilterInputStream

Throws:

IOException

fill

private int fill()
          throws IOException

Fills the buffer, by decoding data from the underlying input stream.

Returns:

the number of bytes decoded, or -1 if the end of the file is reached

Throws:

IOException - if an I/O error occurs