InflaterInputStream

public class InflaterInputStream extends FilterInputStream
Known Direct Subclasses
Known Indirect Subclasses

This class implements a stream filter for uncompressing data in the "deflate" compression format. It is also used as the basis for other decompression filters, such as GZIPInputStream.

See Also

Field Summary

protected byte[] buf Input buffer for decompression.
protected boolean closed
protected Inflater inf Decompressor for this stream.
protected int len Length of input buffer.

Inherited Field Summary

Public Constructor Summary

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

Public Method Summary

int
available()
Returns 0 after EOF has been reached, otherwise always return 1.
void
close()
Closes this input stream and releases any system resources associated with the stream.
synchronized void
mark(int readlimit)
Marks the current position in this input stream.
boolean
markSupported()
Tests if this input stream supports the mark and reset methods.
int
read()
Reads a byte of uncompressed data.
int
read(byte[] b, int off, int len)
Reads uncompressed data into an array of bytes.
synchronized void
reset()
Repositions this stream to the position at the time the mark method was last called on this input stream.
long
skip(long n)
Skips specified number of bytes of uncompressed data.

Protected Method Summary

void
fill()
Fills input buffer with more data to decompress.

Inherited Method Summary

Fields

protected byte[] buf

Input buffer for decompression.

protected boolean closed

protected Inflater inf

Decompressor for this stream.

protected int len

Length of input buffer.

Public Constructors

public InflaterInputStream (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

public InflaterInputStream (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")

public InflaterInputStream (InputStream in)

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

Parameters
in the input stream

Public Methods

public int available ()

Returns 0 after EOF has been 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.

Returns
  • 1 before EOF and 0 after EOF.
Throws
IOException if an I/O error occurs.

public void close ()

Closes this input stream and releases any system resources associated with the stream.

Throws
IOException if an I/O error has occurred

public synchronized void mark (int readlimit)

Marks the current position in this input stream.

The mark method of InflaterInputStream does nothing.

Parameters
readlimit the maximum limit of bytes that can be read before the mark position becomes invalid.
See Also

public boolean markSupported ()

Tests if this input stream supports the mark and reset methods. The markSupported method of InflaterInputStream returns false.

Returns
  • a boolean indicating if this stream type supports the mark and reset methods.
See Also

public int read ()

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

Returns
  • the byte read, or -1 if end of compressed input is reached
Throws
IOException if an I/O error has occurred

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

Reads uncompressed data into an array of bytes. If len is not zero, the method will block until some input can be decompressed; otherwise, no bytes are read and 0 is returned.

Parameters
b the buffer into which the data is read
off the start offset in the destination array b
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
NullPointerException If b is null.
IndexOutOfBoundsException If off is negative, len is negative, or len is greater than b.length - off
ZipException if a ZIP format error has occurred
IOException if an I/O error has occurred

public synchronized void reset ()

Repositions this stream to the position at the time the mark method was last called on this input stream.

The method reset for class InflaterInputStream does nothing except throw an IOException.

Throws
IOException if this method is invoked.

public long skip (long n)

Skips specified number of bytes of uncompressed data.

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

Protected Methods

protected void fill ()

Fills input buffer with more data to decompress.

Throws
IOException if an I/O error has occurred