com.day.io

Class ChunkedInflaterInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.day.io.ChunkedInflaterInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ChunkedInflaterInputStream
extends FilterInputStream

This class implements a stream filter for uncompressing data in the "deflate" compression format. Most of its implementation is copied from the InflaterInputStream but in addition to its original, this one can handle several chunks of compressed data on the same underlying stream. such streams are for example generated by the ChunkedDeflaterOutputStream.

Constructor Summary

Constructors

Constructor and Description
ChunkedInflaterInputStream(InputStream in) Creates a new input stream with a default decompressor and buffer size.
ChunkedInflaterInputStream(InputStream in, Inflater inf) Creates a new input stream with the specified decompressor and a default buffer size.
ChunkedInflaterInputStream(InputStream in, Inflater inf, int size) Creates a new input stream with the specified decompressor and buffer size.

Method Summary

Modifier and Type	Method and Description
int	available() Returns 0 after EOF has reached, otherwise always return 1.
void	close() Closes the input stream.
int	read() Reads a byte of uncompressed data.
int	read(byte[] b, int off, int len) Reads uncompressed data into an array of bytes.
long	skip(long n) Skips specified number of bytes of uncompressed data.

Methods inherited from class java.io.FilterInputStream

mark, markSupported, read, reset

Methods inherited from class java.lang.Object

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

Constructor Detail

ChunkedInflaterInputStream

public ChunkedInflaterInputStream(InputStream in,
                                  Inflater inf,
                                  int size)

Creates a new input stream with the specified decompressor and buffer size.

Parameters:

in - the input stream

inf - the decompressor ("inflater")

size - the input buffer size

Throws:

IllegalArgumentException - if size is <= 0

ChunkedInflaterInputStream

public ChunkedInflaterInputStream(InputStream in,
                                  Inflater inf)

Creates a new input stream with the specified decompressor and a default buffer size.

Parameters:

in - the input stream

inf - the decompressor ("inflater")

ChunkedInflaterInputStream

public ChunkedInflaterInputStream(InputStream in)

Creates a new input stream with a default decompressor and buffer size.

Parameters:

in - the input stream

Method Detail

read

public int read()
         throws IOException

Reads a byte of uncompressed data. This method will block until enough input is available for decompression.

Overrides:

read in class FilterInputStream

Returns:

the byte read, or -1 if end of compressed input is reached

Throws:

IOException - if an I/O error has occurred

read

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

Reads uncompressed data into an array of bytes. This method will block until some input can be decompressed.

Overrides:

read in class FilterInputStream

Parameters:

b - the buffer into which the data is read

off - the start offset of the data

len - the maximum number of bytes read

Returns:

the actual number of bytes read, or -1 if the end of the compressed input is reached or a preset dictionary is needed

Throws:

ZipException - if a ZIP format error has occurred

IOException - if an I/O error has occurred

available

public int available()
              throws IOException

Returns 0 after EOF has reached, otherwise always return 1.

Programs should not count on this method to return the actual number of bytes that could be read without blocking.

Overrides:

available in class FilterInputStream

Returns:

1 before EOF and 0 after EOF.

Throws:

IOException - if an I/O error occurs.

skip

public long skip(long n)
          throws IOException

Skips specified number of bytes of uncompressed data.

Overrides:

skip in class FilterInputStream

Parameters:

n - the number of bytes to skip

Returns:

the actual number of bytes skipped.

Throws:

IOException - if an I/O error has occurred

IllegalArgumentException - if n < 0

close

public void close()
           throws IOException

Closes the input stream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FilterInputStream

Throws:

IOException - if an I/O error has occurred