Skip to content

Most visited

Recently visited

navigation

GZIPInputStream

public class GZIPInputStream
extends InflaterInputStream

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


This class implements a stream filter for reading compressed data in the GZIP file format.

See also:

Summary

Constants

int GZIP_MAGIC

GZIP header magic number.

Fields

protected CRC32 crc

CRC-32 for uncompressed data.

protected boolean eos

Indicates end of input stream.

Inherited fields

From class java.util.zip.InflaterInputStream
From class java.io.FilterInputStream

Public constructors

GZIPInputStream(InputStream in, int size)

Creates a new input stream with the specified buffer size.

GZIPInputStream(InputStream in)

Creates a new input stream with a default buffer size.

Public methods

void close()

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

int read(byte[] buf, int off, int len)

Reads uncompressed data into an array of bytes.

Inherited methods

From class java.util.zip.InflaterInputStream
From class java.io.FilterInputStream
From class java.io.InputStream
From class java.lang.Object
From interface java.io.Closeable
From interface java.lang.AutoCloseable

Constants

GZIP_MAGIC

added in API level 1
int GZIP_MAGIC

GZIP header magic number.

Constant Value: 35615 (0x00008b1f)

Fields

crc

added in API level 1
CRC32 crc

CRC-32 for uncompressed data.

eos

added in API level 1
boolean eos

Indicates end of input stream.

Public constructors

GZIPInputStream

added in API level 1
GZIPInputStream (InputStream in, 
                int size)

Creates a new input stream with the specified buffer size.

Parameters
in InputStream: the input stream

size int: the input buffer size

Throws
ZipException if a GZIP format error has occurred or the compression method used is unsupported
IOException if an I/O error has occurred
IllegalArgumentException if size <= 0

GZIPInputStream

added in API level 1
GZIPInputStream (InputStream in)

Creates a new input stream with a default buffer size.

Parameters
in InputStream: the input stream

Throws
ZipException if a GZIP format error has occurred or the compression method used is unsupported
IOException if an I/O error has occurred

Public methods

close

added in API level 1
void close ()

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

Throws
IOException if an I/O error has occurred

read

added in API level 1
int read (byte[] buf, 
                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
buf 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 stream is reached

Throws
NullPointerException If buf is null.
IndexOutOfBoundsException If off is negative, len is negative, or len is greater than buf.length - off
ZipException if the compressed input data is corrupt.
IOException if an I/O error has occurred.
This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)