InflaterInputStream

public class InflaterInputStream extends FilterInputStream

Known Direct Subclasses GZIPInputStream, ZipInputStream GZIPInputStream This class implements a stream filter for reading compressed data in the GZIP file format.  ZipInputStream This class implements an input stream filter for reading files in the ZIP file format.

Known Indirect Subclasses JarInputStream JarInputStream The JarInputStream class is used to read the contents of a JAR file from any input stream.

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

• Inflater

Field Summary

protected byte[]	buf	Input buffer for decompression.
protected boolean	closed	This field is deprecated. This field will be removed from a future version of Android and should not be used. Subclasses that access this field need to be modified to keep track of their own closed state by overriding close().
protected Inflater	inf	Decompressor for this stream.
protected int	len	Length of input buffer.

Inherited Field Summary

From class java.io.FilterInputStream

protected InputStream

in

The input stream to be filtered.

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

From class java.io.FilterInputStream

int	available() Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream.
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 the next byte of data from this input stream.
int	read(byte[] b, int off, int len) Reads up to len bytes of data from this input stream into an array of bytes.
int	read(byte[] b) Reads up to byte.length bytes of data from this input stream 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 over and discards n bytes of data from the input stream.

From class java.io.InputStream

int	available() Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream.
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.
abstract int	read() Reads the next byte of data from the input stream.
int	read(byte[] b, int off, int len) Reads up to len bytes of data from the input stream into an array of bytes.
int	read(byte[] b) Reads some number of bytes from the input stream and stores them into the buffer array b.
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 over and discards n bytes of data from this input stream.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface java.io.Closeable

abstract void

close() Closes this stream and releases any system resources associated with it.

From interface java.lang.AutoCloseable

abstract void

close() Closes this resource, relinquishing any underlying resources.

Fields

protected byte[] buf

Input buffer for decompression.

protected boolean closed

This field is deprecated.
This field will be removed from a future version of Android and should not be used. Subclasses that access this field need to be modified to keep track of their own closed state by overriding close().

Indicates whether the close() method has been called, internal use only.

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 <= 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

• InputStream.reset()

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

• InputStream.mark(int)
• InputStream.reset()

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.

See Also

• InputStream.mark(int)
• IOException

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