# Inflater

public class **Inflater** extends [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)  
This class provides support for general purpose decompression using the
popular ZLIB compression library. The ZLIB compression library was
initially developed as part of the PNG graphics standard and is not
protected by patents. It is fully described in the specifications at
the [java.util.zip
package description](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/package-summary#package_description).

The following code fragment demonstrates a trivial compression
and decompression of a string using Deflater and
Inflater.

> ```
>  try {
>      // Encode a String into bytes
>      String inputString = "blahblahblah€€";
>      byte[] input = inputString.getBytes("UTF-8");
>
>      // Compress the bytes
>      byte[] output = new byte[100];
>      Deflater compresser = new Deflater();
>      compresser.setInput(input);
>      compresser.finish();
>      int compressedDataLength = compresser.deflate(output);
>
>      // Decompress the bytes
>      Inflater decompresser = new Inflater();
>      decompresser.setInput(output, 0, compressedDataLength);
>      byte[] result = new byte[100];
>      int resultLength = decompresser.inflate(result);
>      decompresser.end();
>
>      // Decode the bytes into a String
>      String outputString = new String(result, 0, resultLength, "UTF-8");
>  } catch(java.io.UnsupportedEncodingException ex) {
>      // handle
>  } catch (java.util.zip.DataFormatException ex) {
>      // handle
>  }
>  
> ```

<br />

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Deflater.html`

### Public Constructor Summary

|---|---|
|   | [Inflater](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#Inflater(boolean))(boolean nowrap) Creates a new decompressor. |
|   | [Inflater](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#Inflater())() Creates a new decompressor. |

### Public Method Summary

|---|---|
| void | [end](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#end())() Closes the decompressor and discards any unprocessed input. |
| boolean | [finished](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#finished())() Returns true if the end of the compressed data stream has been reached. |
| int | [getAdler](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#getAdler())() Returns the ADLER-32 value of the uncompressed data. |
| long | [getBytesRead](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#getBytesRead())() Returns the total number of compressed bytes input so far. |
| long | [getBytesWritten](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#getBytesWritten())() Returns the total number of uncompressed bytes output so far. |
| int | [getRemaining](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#getRemaining())() Returns the total number of bytes remaining in the input buffer. |
| int | [getTotalIn](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#getTotalIn())() Returns the total number of compressed bytes input so far. |
| int | [getTotalOut](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#getTotalOut())() Returns the total number of uncompressed bytes output so far. |
| int | [inflate](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#inflate(byte[]))(byte\[\] b) Uncompresses bytes into specified buffer. |
| int | [inflate](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#inflate(byte[],%20int,%20int))(byte\[\] b, int off, int len) Uncompresses bytes into specified buffer. |
| boolean | [needsDictionary](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#needsDictionary())() Returns true if a preset dictionary is needed for decompression. |
| boolean | [needsInput](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#needsInput())() Returns true if no data remains in the input buffer. |
| void | [reset](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#reset())() Resets inflater so that a new set of input data can be processed. |
| void | [setDictionary](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#setDictionary(byte[],%20int,%20int))(byte\[\] b, int off, int len) Sets the preset dictionary to the given array of bytes. |
| void | [setDictionary](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#setDictionary(byte[]))(byte\[\] b) Sets the preset dictionary to the given array of bytes. |
| void | [setInput](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#setInput(byte[],%20int,%20int))(byte\[\] b, int off, int len) Sets input data for decompression. |
| void | [setInput](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#setInput(byte[]))(byte\[\] b) Sets input data for decompression. |

### Protected Method Summary

|---|---|
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#finalize())() Closes the decompressor when garbage is collected. |

### Inherited Method Summary

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

## Public Constructors

#### public
**Inflater**
(boolean nowrap)

Creates a new decompressor. If the parameter 'nowrap' is true then
the ZLIB header and checksum fields will not be used. This provides
compatibility with the compression format used by both GZIP and PKZIP.


Note: When using the 'nowrap' option it is also necessary to provide
an extra "dummy" byte as input. This is required by the ZLIB native
library in order to support certain optimizations.

##### Parameters

| nowrap | if true then support GZIP compatible compression |
|---|---|

#### public
**Inflater**
()

Creates a new decompressor.

## Public Methods

#### public void
**end**
()

Closes the decompressor and discards any unprocessed input.
This method should be called when the decompressor is no longer
being used, but will also be called automatically by the finalize()
method. Once this method is called, the behavior of the Inflater
object is undefined.

#### public boolean
**finished**
()

Returns true if the end of the compressed data stream has been
reached.

##### Returns

- true if the end of the compressed data stream has been reached

#### public int
**getAdler**
()

Returns the ADLER-32 value of the uncompressed data.

##### Returns

- the ADLER-32 value of the uncompressed data

#### public long
**getBytesRead**
()

Returns the total number of compressed bytes input so far.

##### Returns

- the total (non-negative) number of compressed bytes input so far

#### public long
**getBytesWritten**
()

Returns the total number of uncompressed bytes output so far.

##### Returns

- the total (non-negative) number of uncompressed bytes output so far

#### public int
**getRemaining**
()

Returns the total number of bytes remaining in the input buffer.
This can be used to find out what bytes still remain in the input
buffer after decompression has finished.

##### Returns

- the total number of bytes remaining in the input buffer

#### public int
**getTotalIn**
()

Returns the total number of compressed bytes input so far.

Since the number of bytes may be greater than
Integer.MAX_VALUE, the `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#getBytesRead()` method is now
the preferred means of obtaining this information.

<br />

##### Returns

- the total number of compressed bytes input so far

#### public int
**getTotalOut**
()

Returns the total number of uncompressed bytes output so far.

Since the number of bytes may be greater than
Integer.MAX_VALUE, the `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#getBytesWritten()` method is now
the preferred means of obtaining this information.

<br />

##### Returns

- the total number of uncompressed bytes output so far

#### public int
**inflate**
(byte\[\] b)

Uncompresses bytes into specified buffer. Returns actual number
of bytes uncompressed. A return value of 0 indicates that
needsInput() or needsDictionary() should be called in order to
determine if more input data or a preset dictionary is required.
In the latter case, getAdler() can be used to get the Adler-32
value of the dictionary required.

##### Parameters

| b | the buffer for the uncompressed data |
|---|---|

##### Returns

- the actual number of uncompressed bytes

##### Throws

| [DataFormatException](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/DataFormatException.html) | if the compressed data format is invalid |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#needsInput()`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#needsDictionary()`

#### public int
**inflate**
(byte\[\] b, int off, int len)

Uncompresses bytes into specified buffer. Returns actual number
of bytes uncompressed. A return value of 0 indicates that
needsInput() or needsDictionary() should be called in order to
determine if more input data or a preset dictionary is required.
In the latter case, getAdler() can be used to get the Adler-32
value of the dictionary required.

##### Parameters

| b | the buffer for the uncompressed data |
| off | the start offset of the data |
| len | the maximum number of uncompressed bytes |
|---|---|

##### Returns

- the actual number of uncompressed bytes

##### Throws

| [DataFormatException](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/DataFormatException.html) | if the compressed data format is invalid |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#needsInput()`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#needsDictionary()`

#### public boolean
**needsDictionary**
()

Returns true if a preset dictionary is needed for decompression.

##### Returns

- true if a preset dictionary is needed for decompression

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#setDictionary(byte[])`

#### public boolean
**needsInput**
()

Returns true if no data remains in the input buffer. This can
be used to determine if #setInput should be called in order
to provide more input.

##### Returns

- true if no data remains in the input buffer

#### public void
**reset**
()

Resets inflater so that a new set of input data can be processed.

#### public void
**setDictionary**
(byte\[\] b, int off, int len)

Sets the preset dictionary to the given array of bytes. Should be
called when inflate() returns 0 and needsDictionary() returns true
indicating that a preset dictionary is required. The method getAdler()
can be used to get the Adler-32 value of the dictionary needed.

##### Parameters

| b | the dictionary data bytes |
| off | the start offset of the data |
| len | the length of the data |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#needsDictionary()`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#getAdler()`

#### public void
**setDictionary**
(byte\[\] b)

Sets the preset dictionary to the given array of bytes. Should be
called when inflate() returns 0 and needsDictionary() returns true
indicating that a preset dictionary is required. The method getAdler()
can be used to get the Adler-32 value of the dictionary needed.

##### Parameters

| b | the dictionary data bytes |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#needsDictionary()`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#getAdler()`

#### public void
**setInput**
(byte\[\] b, int off, int len)

Sets input data for decompression. Should be called whenever
needsInput() returns true indicating that more input data is
required.

##### Parameters

| b | the input data bytes |
| off | the start offset of the input data |
| len | the length of the input data |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#needsInput()`

#### public void
**setInput**
(byte\[\] b)

Sets input data for decompression. Should be called whenever
needsInput() returns true indicating that more input data is
required.

##### Parameters

| b | the input data bytes |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/zip/Inflater.html#needsInput()`

## Protected Methods

#### protected void
**finalize**
()

Closes the decompressor when garbage is collected.