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.

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

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

Constants

GZIP_MAGIC

Added in API level 1
public static final int GZIP_MAGIC

GZIP header magic number.

Constant Value: 35615 (0x00008b1f)

Fields

crc

Added in API level 1
protected CRC32 crc

CRC-32 for uncompressed data.

eos

Added in API level 1
protected boolean eos

Indicates end of input stream.

Public constructors

GZIPInputStream

Added in API level 1
public GZIPInputStream (InputStream in, 
                int size)

Creates a new input stream with the specified buffer size. Android-note: Android limits the number of UnbufferedIO operations that can be performed, so consider using buffered inputs with this class. More information can be found in the UnbufferedIO and StrictMode documentation.

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

read

Added in API level 1
public 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.