Added in API level 1

InflaterInputStream

public class InflaterInputStream
extends FilterInputStream

java.lang.Object
↳	java.io.InputStream
	↳	java.io.FilterInputStream
		↳	java.util.zip.InflaterInputStream

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

Summary

Fields
`protected byte[]`	`buf` Input buffer for decompression.
`protected boolean`	`closed` This field was deprecated in API level 29. 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 fields

From class java.io.FilterInputStream


    protected
    
    
    InputStream

in

The input stream to be filtered.

Public constructors
`InflaterInputStream(InputStream in)` Creates a new input stream with a default 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, Inflater inf, int size)` Creates a new input stream with the specified decompressor and buffer size.

Public methods
`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.
`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.
`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 methods
`void`	`fill()` Fills input buffer with more data to decompress.

Inherited methods

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.
`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 `b.length` bytes of data from this input stream into an array of bytes.
`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, which may be 0, or 0 when end of stream is detected.
`void`	`close()` Closes this input stream and releases any system resources associated with the stream.
`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.
`static InputStream`	`nullInputStream()` Returns a new `InputStream` that reads no bytes.
`int`	`read(byte[] b)` Reads some number of bytes from the input stream and stores them into the buffer array `b`.
`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.
`byte[]`	`readAllBytes()` Reads all remaining bytes from the input stream.
`int`	`readNBytes(byte[] b, int off, int len)` Reads the requested number of bytes from the input stream into the given byte array.
`byte[]`	`readNBytes(int len)` Reads up to a specified number of bytes from the input stream.
`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.
`void`	`skipNBytes(long n)` Skips over and discards exactly `n` bytes of data from this input stream.
`long`	`transferTo(OutputStream out)` Reads all bytes from this input stream and writes the bytes to the given output stream in the order that they are read.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.io.Closeable


      close()

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

From interface


        
          java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

Fields

buf

Added in API level 1

protected byte[] buf

Input buffer for decompression.

closed

Added in API level 24
Deprecated in API level 29

protected boolean closed

This field was deprecated in API level 29.
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.

inf

Added in API level 1

protected Inflater inf

Decompressor for this stream.

len

Added in API level 1

protected int len

Length of input buffer.

Public constructors

InflaterInputStream

Added in API level 1

public InflaterInputStream (InputStream in)

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

Parameters
`in`	`InputStream`: the input stream

InflaterInputStream

Added in API level 1

public InflaterInputStream (InputStream in, 
                Inflater inf)

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

Parameters
`in`	`InputStream`: the input stream
`inf`	`Inflater`: the decompressor ("inflater")

InflaterInputStream

Added in API level 1

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

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

Parameters
`in`	`InputStream`: the input stream
`inf`	`Inflater`: the decompressor ("inflater")
`size`	`int`: the input buffer size

Throws
`IllegalArgumentException`	if `size <= 0`

Public methods

available

Added in API level 1

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
`int`	1 before EOF and 0 after EOF.

Throws
`IOException`	if an I/O error occurs.

close

Added in API level 1

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

mark

Added in API level 1

public void mark (int readlimit)

Marks the current position in this input stream.

The mark method of InflaterInputStream does nothing.

Parameters
`readlimit`	`int`: the maximum limit of bytes that can be read before the mark position becomes invalid.

See also:

InputStream.reset()

markSupported

Added in API level 1

public boolean markSupported ()

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

Returns
`boolean`	a `boolean` indicating if this stream type supports the `mark` and `reset` methods.

See also:

read

Added in API level 1

public int read ()

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

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

Throws
`IOException`	if an I/O error has occurred

read

Added in API level 1

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`	`byte`: the buffer into which the data is read
`off`	`int`: the start offset in the destination array `b`
`len`	`int`: the maximum number of bytes read

Returns
`int`	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

reset

Added in API level 1

public 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:

skip

Added in API level 1

public long skip (long n)

Skips specified number of bytes of uncompressed data.

Parameters
`n`	`long`: the number of bytes to skip

Returns
`long`	the actual number of bytes skipped.

Throws
`IOException`	if an I/O error has occurred
`IllegalArgumentException`	if `n < 0`

Protected methods

fill

Added in API level 1

protected void fill ()

Fills input buffer with more data to decompress.

Throws
`IOException`	if an I/O error has occurred