Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/java/util/zip/GZIPInputStream#constants) \| [Fields](https://developer.android.com/reference/java/util/zip/GZIPInputStream#lfields) \| [Inherited Fields](https://developer.android.com/reference/java/util/zip/GZIPInputStream#inhfields) \| [Ctors](https://developer.android.com/reference/java/util/zip/GZIPInputStream#pubctors) \| [Methods](https://developer.android.com/reference/java/util/zip/GZIPInputStream#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/java/util/zip/GZIPInputStream#inhmethods)

# GZIPInputStream

` public class GZIPInputStream `   
` ` ` ` ` ` ` extends https://developer.android.com/reference/java/util/zip/InflaterInputStream ` ` `

|---|---|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) |||||
| ↳ | [java.io.InputStream](https://developer.android.com/reference/java/io/InputStream) ||||
|   | ↳ | [java.io.FilterInputStream](https://developer.android.com/reference/java/io/FilterInputStream) |||
|   |   | ↳ | [java.util.zip.InflaterInputStream](https://developer.android.com/reference/java/util/zip/InflaterInputStream) ||
|   |   |   | ↳ | java.util.zip.GZIPInputStream |

<br />

*** ** * ** ***

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

- `https://developer.android.com/reference/java/util/zip/InflaterInputStream`

## Summary

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/java/util/zip/GZIPInputStream#GZIP_MAGIC` GZIP header magic number. |

| ### Fields ||
|---|---|
| ` protected https://developer.android.com/reference/java/util/zip/CRC32` | `https://developer.android.com/reference/java/util/zip/GZIPInputStream#crc` CRC-32 for uncompressed data. |
| ` protected boolean` | `https://developer.android.com/reference/java/util/zip/GZIPInputStream#eos` Indicates end of input stream. |

### Inherited fields

From class `https://developer.android.com/reference/java/util/zip/InflaterInputStream` ` protected byte[]` `https://developer.android.com/reference/java/util/zip/InflaterInputStream#buf`

Input buffer for decompression.
` protected boolean` `https://developer.android.com/reference/java/util/zip/InflaterInputStream#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 https://developer.android.com/reference/java/util/zip/Inflater` `https://developer.android.com/reference/java/util/zip/InflaterInputStream#inf`

Decompressor for this stream.
` protected int` `https://developer.android.com/reference/java/util/zip/InflaterInputStream#len`

Length of input buffer.
From class `https://developer.android.com/reference/java/io/FilterInputStream` ` protected https://developer.android.com/reference/java/io/InputStream` `https://developer.android.com/reference/java/io/FilterInputStream#in`

The input stream to be filtered.

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/java/util/zip/GZIPInputStream#GZIPInputStream(java.io.InputStream)(https://developer.android.com/reference/java/io/InputStream in) ` Creates a new input stream with a default buffer size. |
| ` https://developer.android.com/reference/java/util/zip/GZIPInputStream#GZIPInputStream(java.io.InputStream,%20int)(https://developer.android.com/reference/java/io/InputStream in, int size) ` Creates a new input stream with the specified buffer size. |

| ### Public methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/java/util/zip/GZIPInputStream#close()() ` Closes this input stream and releases any system resources associated with the stream. |
| ` int` | ` https://developer.android.com/reference/java/util/zip/GZIPInputStream#read(byte[],%20int,%20int)(byte[] buf, int off, int len) ` Reads uncompressed data into an array of bytes. |

### Inherited methods

From class ` https://developer.android.com/reference/java/util/zip/InflaterInputStream ` ` int` ` https://developer.android.com/reference/java/util/zip/InflaterInputStream#available()() `

Returns 0 after EOF has been reached, otherwise always return 1.
` void` ` https://developer.android.com/reference/java/util/zip/InflaterInputStream#close()() `

Closes this input stream and releases any system resources associated with the stream.
` void` ` https://developer.android.com/reference/java/util/zip/InflaterInputStream#fill()() `

Fills input buffer with more data to decompress.
` void` ` https://developer.android.com/reference/java/util/zip/InflaterInputStream#mark(int)(int readlimit) `

Marks the current position in this input stream.
` boolean` ` https://developer.android.com/reference/java/util/zip/InflaterInputStream#markSupported()() `

Tests if this input stream supports the `mark` and `reset` methods.
` int` ` https://developer.android.com/reference/java/util/zip/InflaterInputStream#read()() `

Reads a byte of uncompressed data.
` int` ` https://developer.android.com/reference/java/util/zip/InflaterInputStream#read(byte[],%20int,%20int)(byte[] b, int off, int len) `

Reads uncompressed data into an array of bytes.
` void` ` https://developer.android.com/reference/java/util/zip/InflaterInputStream#reset()() `

Repositions this stream to the position at the time the `mark` method was last called on this input stream.
` long` ` https://developer.android.com/reference/java/util/zip/InflaterInputStream#skip(long)(long n) `

Skips specified number of bytes of uncompressed data.
From class ` https://developer.android.com/reference/java/io/FilterInputStream ` ` int` ` https://developer.android.com/reference/java/io/FilterInputStream#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` ` https://developer.android.com/reference/java/io/FilterInputStream#close()() `

Closes this input stream and releases any system resources associated with the stream.
` void` ` https://developer.android.com/reference/java/io/FilterInputStream#mark(int)(int readlimit) `

Marks the current position in this input stream.
` boolean` ` https://developer.android.com/reference/java/io/FilterInputStream#markSupported()() `

Tests if this input stream supports the `mark` and `reset` methods.
` int` ` https://developer.android.com/reference/java/io/FilterInputStream#read()() `

Reads the next byte of data from this input stream.
` int` ` https://developer.android.com/reference/java/io/FilterInputStream#read(byte[],%20int,%20int)(byte[] b, int off, int len) `

Reads up to `len` bytes of data from this input stream into an array of bytes.
` int` ` https://developer.android.com/reference/java/io/FilterInputStream#read(byte[])(byte[] b) `

Reads up to `b.length` bytes of data from this input stream into an array of bytes.
` void` ` https://developer.android.com/reference/java/io/FilterInputStream#reset()() `

Repositions this stream to the position at the time the `mark` method was last called on this input stream.
` long` ` https://developer.android.com/reference/java/io/FilterInputStream#skip(long)(long n) `

Skips over and discards `n` bytes of data from the input stream.
From class ` https://developer.android.com/reference/java/io/InputStream ` ` int` ` https://developer.android.com/reference/java/io/InputStream#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` ` https://developer.android.com/reference/java/io/InputStream#close()() `

Closes this input stream and releases any system resources associated with the stream.
` void` ` https://developer.android.com/reference/java/io/InputStream#mark(int)(int readlimit) `

Marks the current position in this input stream.
` boolean` ` https://developer.android.com/reference/java/io/InputStream#markSupported()() `

Tests if this input stream supports the `mark` and `reset` methods.
` static https://developer.android.com/reference/java/io/InputStream` ` https://developer.android.com/reference/java/io/InputStream#nullInputStream()() `

Returns a new `InputStream` that reads no bytes.
` int` ` https://developer.android.com/reference/java/io/InputStream#read(byte[])(byte[] b) `

Reads some number of bytes from the input stream and stores them into the buffer array `b`.
` abstract int` ` https://developer.android.com/reference/java/io/InputStream#read()() `

Reads the next byte of data from the input stream.
` int` ` https://developer.android.com/reference/java/io/InputStream#read(byte[],%20int,%20int)(byte[] b, int off, int len) `

Reads up to `len` bytes of data from the input stream into an array of bytes.
` byte[]` ` https://developer.android.com/reference/java/io/InputStream#readAllBytes()() `

Reads all remaining bytes from the input stream.
` int` ` https://developer.android.com/reference/java/io/InputStream#readNBytes(byte[],%20int,%20int)(byte[] b, int off, int len) `

Reads the requested number of bytes from the input stream into the given byte array.
` byte[]` ` https://developer.android.com/reference/java/io/InputStream#readNBytes(int)(int len) `

Reads up to a specified number of bytes from the input stream.
` void` ` https://developer.android.com/reference/java/io/InputStream#reset()() `

Repositions this stream to the position at the time the `mark` method was last called on this input stream.
` long` ` https://developer.android.com/reference/java/io/InputStream#skip(long)(long n) `

Skips over and discards `n` bytes of data from this input stream.
` void` ` https://developer.android.com/reference/java/io/InputStream#skipNBytes(long)(long n) `

Skips over and discards exactly `n` bytes of data from this input stream.
` long` ` https://developer.android.com/reference/java/io/InputStream#transferTo(java.io.OutputStream)(https://developer.android.com/reference/java/io/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 ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/java/io/Closeable ` ` abstract void` ` https://developer.android.com/reference/java/io/Closeable#close()() `

Closes this stream and releases any system resources associated with it.
From interface ` https://developer.android.com/reference/java/lang/AutoCloseable ` ` abstract void` ` https://developer.android.com/reference/java/lang/AutoCloseable#close()() `

Closes this resource, relinquishing any underlying resources.

## Constants

### GZIP_MAGIC

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int GZIP_MAGIC
```

GZIP header magic number.

<br />

Constant Value: 35615 (0x00008b1f)

## Fields

### crc

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
protected CRC32 crc
```

CRC-32 for uncompressed data.

<br />

### eos

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
protected boolean eos
```

Indicates end of input stream.

<br />

## Public constructors

### GZIPInputStream

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public GZIPInputStream (InputStream in)
```

Creates a new input stream with a default buffer size.

<br />

| Parameters ||
|---|---|
| `in` | `InputStream`: the input stream <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` | if an I/O error has occurred |
| `https://developer.android.com/reference/java/util/zip/ZipException` | if a GZIP format error has occurred or the compression method used is unsupported |

### GZIPInputStream

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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](https://developer.android.com/reference/android/os/StrictMode.ThreadPolicy.Builder#detectUnbufferedIo()) and [StrictMode](https://developer.android.com/reference/android/os/StrictMode) documentation.

<br />

| Parameters ||
|---|---|
| `in` | `InputStream`: the input stream <br /> |
| `size` | `int`: the input buffer size <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` | if an I/O error has occurred |
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if `size <= 0` |
| `https://developer.android.com/reference/java/util/zip/ZipException` | if a GZIP format error has occurred or the compression method used is unsupported |

## Public methods

### close

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void close ()
```

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

<br />

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` | if an I/O error has occurred |

### read

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.

<br />

| Parameters ||
|---|---|
| `buf` | `byte`: the buffer into which the data is read <br /> |
| `off` | `int`: the start offset in the destination array `b` <br /> |
| `len` | `int`: the maximum number of bytes read <br /> |

| Returns ||
|---|---|
| `int` | the actual number of bytes read, or -1 if the end of the compressed input stream is reached <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` | if an I/O error has occurred. |
| `https://developer.android.com/reference/java/lang/IndexOutOfBoundsException` | If `off` is negative, `len` is negative, or `len` is greater than `buf.length - off` |
| `https://developer.android.com/reference/java/lang/NullPointerException` | If `buf` is `null`. |
| `https://developer.android.com/reference/java/util/zip/ZipException` | if the compressed input data is corrupt. |