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

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.

protected InputStream in

The input stream to be filtered.

Public constructors

GZIPInputStream(InputStream in)

Creates a new input stream with a default buffer size.

GZIPInputStream(InputStream in, int size)

Creates a new input stream with the specified 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

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 fill()

Fills input buffer with more data to decompress.

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.

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.

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.

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.

abstract void close()

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

abstract void close()

Closes this resource, relinquishing any underlying resources.

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)

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

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

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.