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

# DeflaterInputStream

` public class DeflaterInputStream `   
` ` ` ` ` extends https://developer.android.com/reference/java/io/FilterInputStream ` ` `

|---|---|---|---|
| [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.DeflaterInputStream |

<br />

*** ** * ** ***

Implements an input stream filter for compressing data in the "deflate" compression format.
**See also:**

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

## Summary

| ### Fields ||
|---|---|
| ` protected final byte[]` | `https://developer.android.com/reference/java/util/zip/DeflaterInputStream#buf` Input buffer for reading compressed data. |
| ` protected final https://developer.android.com/reference/java/util/zip/Deflater` | `https://developer.android.com/reference/java/util/zip/DeflaterInputStream#def` Compressor for this stream. |

### Inherited fields

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/DeflaterInputStream#DeflaterInputStream(java.io.InputStream)(https://developer.android.com/reference/java/io/InputStream in) ` Creates a new input stream with a default compressor and buffer size. |
| ` https://developer.android.com/reference/java/util/zip/DeflaterInputStream#DeflaterInputStream(java.io.InputStream,%20java.util.zip.Deflater)(https://developer.android.com/reference/java/io/InputStream in, https://developer.android.com/reference/java/util/zip/Deflater defl) ` Creates a new input stream with the specified compressor and a default buffer size. |
| ` https://developer.android.com/reference/java/util/zip/DeflaterInputStream#DeflaterInputStream(java.io.InputStream,%20java.util.zip.Deflater,%20int)(https://developer.android.com/reference/java/io/InputStream in, https://developer.android.com/reference/java/util/zip/Deflater defl, int bufLen) ` Creates a new input stream with the specified compressor and buffer size. |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/java/util/zip/DeflaterInputStream#available()() ` Returns 0 after EOF has been reached, otherwise always return 1. |
| ` void` | ` https://developer.android.com/reference/java/util/zip/DeflaterInputStream#close()() ` Closes this input stream and its underlying input stream, discarding any pending uncompressed data. |
| ` void` | ` https://developer.android.com/reference/java/util/zip/DeflaterInputStream#mark(int)(int limit) ` *This operation is not supported*. |
| ` boolean` | ` https://developer.android.com/reference/java/util/zip/DeflaterInputStream#markSupported()() ` Always returns `false` because this input stream does not support the `https://developer.android.com/reference/java/util/zip/DeflaterInputStream#mark(int)` and `https://developer.android.com/reference/java/util/zip/DeflaterInputStream#reset()` methods. |
| ` int` | ` https://developer.android.com/reference/java/util/zip/DeflaterInputStream#read()() ` Reads a single byte of compressed data from the input stream. |
| ` int` | ` https://developer.android.com/reference/java/util/zip/DeflaterInputStream#read(byte[],%20int,%20int)(byte[] b, int off, int len) ` Reads compressed data into a byte array. |
| ` void` | ` https://developer.android.com/reference/java/util/zip/DeflaterInputStream#reset()() ` *This operation is not supported*. |
| ` long` | ` https://developer.android.com/reference/java/util/zip/DeflaterInputStream#skip(long)(long n) ` Skips over and discards data from the input stream. |

### Inherited methods

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.

## Fields

### buf

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

```
protected final byte[] buf
```

Input buffer for reading compressed data.

<br />

### def

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

```
protected final Deflater def
```

Compressor for this stream.

<br />

## Public constructors

### DeflaterInputStream

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

```
public DeflaterInputStream (InputStream in)
```

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

<br />

| Parameters ||
|---|---|
| `in` | `InputStream`: input stream to read the uncompressed data to <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/NullPointerException` | if `in` is null |

### DeflaterInputStream

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

```
public DeflaterInputStream (InputStream in, 
                Deflater defl)
```

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

<br />

| Parameters ||
|---|---|
| `in` | `InputStream`: input stream to read the uncompressed data to <br /> |
| `defl` | `Deflater`: compressor ("deflater") for this stream <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/NullPointerException` | if `in` or `defl` is null |

### DeflaterInputStream

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

```
public DeflaterInputStream (InputStream in, 
                Deflater defl, 
                int bufLen)
```

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

<br />

| Parameters ||
|---|---|
| `in` | `InputStream`: input stream to read the uncompressed data to <br /> |
| `defl` | `Deflater`: compressor ("deflater") for this stream <br /> |
| `bufLen` | `int`: compression buffer size <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if `bufLen <= 0` |
| `https://developer.android.com/reference/java/lang/NullPointerException` | if `in` or `defl` is null |

## Public methods

### available

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

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

<br />

| Returns ||
|---|---|
| `int` | zero after the end of the underlying input stream has been reached, otherwise always returns 1 <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` | if an I/O error occurs or if this stream is already closed |

### close

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

```
public void close ()
```

Closes this input stream and its underlying input stream, discarding any pending uncompressed data.

<br />

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

### mark

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

```
public void mark (int limit)
```

*This operation is not supported*.

<br />

| Parameters ||
|---|---|
| `limit` | `int`: maximum bytes that can be read before invalidating the position marker <br /> |

### markSupported

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

```
public boolean markSupported ()
```

Always returns `false` because this input stream does not support the `https://developer.android.com/reference/java/util/zip/DeflaterInputStream#mark(int)` and `https://developer.android.com/reference/java/util/zip/DeflaterInputStream#reset()` methods.

<br />

| Returns ||
|---|---|
| `boolean` | false, always <br /> |

### read

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

```
public int read ()
```

Reads a single byte of compressed data from the input stream. This method will block until some input can be read and compressed.

<br />

| Returns ||
|---|---|
| `int` | a single byte of compressed data, or -1 if the end of the uncompressed input stream is reached <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` | if an I/O error occurs or if this stream is already closed |

### read

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

```
public int read (byte[] b, 
                int off, 
                int len)
```

Reads compressed data into a byte array. This method will block until some input can be read and compressed.

<br />

| Parameters ||
|---|---|
| `b` | `byte`: buffer into which the data is read <br /> |
| `off` | `int`: starting offset of the data within `b` <br /> |
| `len` | `int`: maximum number of compressed bytes to read into `b` <br /> |

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

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` | if an I/O error occurs or if this input stream is already closed |
| `https://developer.android.com/reference/java/lang/IndexOutOfBoundsException` | if `len > b.length - off` |

### reset

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

```
public void reset ()
```

*This operation is not supported*.

<br />

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` | always thrown |

### skip

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

```
public long skip (long n)
```

Skips over and discards data from the input stream. This method may block until the specified number of bytes are read and skipped. *Note:* While `n` is given as a `long`, the maximum number of bytes which can be skipped is `Integer.MAX_VALUE`.

<br />

| Parameters ||
|---|---|
| `n` | `long`: number of bytes to be skipped <br /> |

| Returns ||
|---|---|
| `long` | the actual number of bytes skipped <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` | if an I/O error occurs or if this stream is already closed |