# DeflaterInputStream Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) # DeflaterInputStream ``` open class DeflaterInputStream : FilterInputStream ``` |---|---|---|------------------------------------------------------------------------------------------------------------------------| | [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) |||| | ↳ | [java.io.InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#) ||| | | ↳ | [java.io.FilterInputStream](https://developer.android.com/reference/kotlin/java/io/FilterInputStream.html#) || | | | ↳ | [java.util.zip.DeflaterInputStream](https://developer.android.com/reference/kotlin/java/util/zip/DeflaterInputStream#) | Implements an input stream filter for compressing data in the "deflate" compression format. ## Summary | Public constructors || |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| | [DeflaterInputStream](https://developer.android.com/reference/kotlin/java/util/zip/DeflaterInputStream#DeflaterInputStream(java.io.InputStream))`(`in:` `[InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#)!`)` Creates a new input stream with a default compressor and buffer size. | | [DeflaterInputStream](https://developer.android.com/reference/kotlin/java/util/zip/DeflaterInputStream#DeflaterInputStream(java.io.InputStream,%20java.util.zip.Deflater))`(`in:` `[InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#)!`, `defl:` `[Deflater](https://developer.android.com/reference/kotlin/java/util/zip/Deflater)!`)` Creates a new input stream with the specified compressor and a default buffer size. | | [DeflaterInputStream](https://developer.android.com/reference/kotlin/java/util/zip/DeflaterInputStream#DeflaterInputStream(java.io.InputStream,%20java.util.zip.Deflater,%20kotlin.Int))`(`in:` `[InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#)!`, `defl:` `[Deflater](https://developer.android.com/reference/kotlin/java/util/zip/Deflater)!`, `bufLen:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Creates a new input stream with the specified compressor and buffer size. | | Public methods || |----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | open[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [available](https://developer.android.com/reference/kotlin/java/util/zip/DeflaterInputStream#available())`()` Returns 0 after EOF has been reached, otherwise always return 1. | | open[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [close](https://developer.android.com/reference/kotlin/java/util/zip/DeflaterInputStream#close())`()` Closes this input stream and its underlying input stream, discarding any pending uncompressed data. | | open[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [mark](https://developer.android.com/reference/kotlin/java/util/zip/DeflaterInputStream#mark(kotlin.Int))`(`limit:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` *This operation is not supported*. | | open[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [markSupported](https://developer.android.com/reference/kotlin/java/util/zip/DeflaterInputStream#markSupported())`()` Always returns`false`because this input stream does not support the #mark and #reset methods. | | open[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [read](https://developer.android.com/reference/kotlin/java/util/zip/DeflaterInputStream#read())`()` Reads a single byte of compressed data from the input stream. | | open[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [read](https://developer.android.com/reference/kotlin/java/util/zip/DeflaterInputStream#read(kotlin.ByteArray,%20kotlin.Int,%20kotlin.Int))`(`b:` `[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)!`, `off:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `len:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Reads compressed data into a byte array. | | open[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [reset](https://developer.android.com/reference/kotlin/java/util/zip/DeflaterInputStream#reset())`()` *This operation is not supported*. | | open[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | [skip](https://developer.android.com/reference/kotlin/java/util/zip/DeflaterInputStream#skip(kotlin.Long))`(`n:` `[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`)` Skips over and discards data from the input stream. | | Inherited functions || |---|---| | From class[InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#) |------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#)! | [nullInputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#nullInputStream())`()`
Returns a new`InputStream`that reads no bytes. The returned stream is initially open. The stream is closed by calling the`close()`method. Subsequent calls to`close()`have no effect. While the stream is open, the`available()`,`read()`,`read(byte[])`,`read(byte[], int, int)`,`readAllBytes()`,`readNBytes(byte[], int, int)`,`readNBytes(int)`,`skip(long)`,`skipNBytes(long)`, and`transferTo()`methods all behave as if end of stream has been reached. After the stream has been closed, these methods all throw`IOException`. The`markSupported()`method returns`false`. The`mark()`method does nothing, and the`reset()`method throws`IOException`.
| | [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)! | [readAllBytes](https://developer.android.com/reference/kotlin/java/io/InputStream.html#readAllBytes())`()`
Reads all remaining bytes from the input stream. This method blocks until all remaining bytes have been read and end of stream is detected, or an exception is thrown. This method does not close the input stream. When this stream reaches end of stream, further invocations of this method will return an empty byte array. Note that this method is intended for simple cases where it is convenient to read all bytes into a byte array. It is not intended for reading input streams with large amounts of data. The behavior for the case where the input stream is*asynchronously closed*, or the thread interrupted during the read, is highly input stream specific, and therefore not specified. If an I/O error occurs reading from the input stream, then it may do so after some, but not all, bytes have been read. Consequently the input stream may not be at end of stream and may be in an inconsistent state. It is strongly recommended that the stream be promptly closed if an I/O error occurs.
| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [readNBytes](https://developer.android.com/reference/kotlin/java/io/InputStream.html#readNBytes(kotlin.ByteArray,%20kotlin.Int,%20kotlin.Int))`(`b:` `[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)!`, `off:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `len:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)`
Reads the requested number of bytes from the input stream into the given byte array. This method blocks until`len`bytes of input data have been read, end of stream is detected, or an exception is thrown. The number of bytes actually read, possibly zero, is returned. This method does not close the input stream. In the case where end of stream is reached before`len`bytes have been read, then the actual number of bytes read will be returned. When this stream reaches end of stream, further invocations of this method will return zero. If`len`is zero, then no bytes are read and`0`is returned; otherwise, there is an attempt to read up to`len`bytes. The first byte read is stored into element`b[off]`, the next one in to`b[off+1]`, and so on. The number of bytes read is, at most, equal to`len`. Let*k* be the number of bytes actually read; these bytes will be stored in elements`b[off]`through`b[off+`*k* `-1]`, leaving elements`b[off+`*k* `]`through`b[off+len-1]`unaffected. The behavior for the case where the input stream is*asynchronously closed*, or the thread interrupted during the read, is highly input stream specific, and therefore not specified. If an I/O error occurs reading from the input stream, then it may do so after some, but not all, bytes of`b`have been updated with data from the input stream. Consequently the input stream and`b`may be in an inconsistent state. It is strongly recommended that the stream be promptly closed if an I/O error occurs.
| | [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)! | [readNBytes](https://developer.android.com/reference/kotlin/java/io/InputStream.html#readNBytes(kotlin.Int))`(`len:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)`
Reads up to a specified number of bytes from the input stream. This method blocks until the requested number of bytes has been read, end of stream is detected, or an exception is thrown. This method does not close the input stream. The length of the returned array equals the number of bytes read from the stream. If`len`is zero, then no bytes are read and an empty byte array is returned. Otherwise, up to`len`bytes are read from the stream. Fewer than`len`bytes may be read if end of stream is encountered. When this stream reaches end of stream, further invocations of this method will return an empty byte array. Note that this method is intended for simple cases where it is convenient to read the specified number of bytes into a byte array. The total amount of memory allocated by this method is proportional to the number of bytes read from the stream which is bounded by`len`. Therefore, the method may be safely called with very large values of`len`provided sufficient memory is available. The behavior for the case where the input stream is*asynchronously closed*, or the thread interrupted during the read, is highly input stream specific, and therefore not specified. If an I/O error occurs reading from the input stream, then it may do so after some, but not all, bytes have been read. Consequently the input stream may not be at end of stream and may be in an inconsistent state. It is strongly recommended that the stream be promptly closed if an I/O error occurs.
| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [skipNBytes](https://developer.android.com/reference/kotlin/java/io/InputStream.html#skipNBytes(kotlin.Long))`(`n:` `[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`)`
Skips over and discards exactly`n`bytes of data from this input stream. If`n`is zero, then no bytes are skipped. If`n`is negative, then no bytes are skipped. Subclasses may handle the negative value differently. This method blocks until the requested number of bytes has been skipped, end of file is reached, or an exception is thrown. If end of stream is reached before the stream is at the desired position, then an`EOFException`is thrown. If an I/O error occurs, then the input stream may be in an inconsistent state. It is strongly recommended that the stream be promptly closed if an I/O error occurs.
| | [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | [transferTo](https://developer.android.com/reference/kotlin/java/io/InputStream.html#transferTo(java.io.OutputStream))`(`out:` `[OutputStream](https://developer.android.com/reference/kotlin/java/io/OutputStream.html#)!`)`
Reads all bytes from this input stream and writes the bytes to the given output stream in the order that they are read. On return, this input stream will be at end of stream. This method does not close either stream. This method may block indefinitely reading from the input stream, or writing to the output stream. The behavior for the case where the input and/or output stream is*asynchronously closed*, or the thread interrupted during the transfer, is highly input and output stream specific, and therefore not specified. If an I/O error occurs reading from the input stream or writing to the output stream, then it may do so after some bytes have been read or written. Consequently the input stream may not be at end of stream and one, or both, streams may be in an inconsistent state. It is strongly recommended that both streams be promptly closed if an I/O error occurs.
| || | From class[FilterInputStream](https://developer.android.com/reference/kotlin/java/io/FilterInputStream.html#) |----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [read](https://developer.android.com/reference/kotlin/java/io/FilterInputStream.html#read(kotlin.ByteArray))`(`b:` `[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)!`)`
Reads up to`b.length`bytes of data from this input stream into an array of bytes. This method blocks until some input is available. This method simply performs the call`read(b, 0, b.length)`and returns the result. It is important that it does*not* do`in.read(b)`instead; certain subclasses of`FilterInputStream`depend on the implementation strategy actually used.
| || | Properties || |------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| | [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)! | [buf](https://developer.android.com/reference/kotlin/java/util/zip/DeflaterInputStream#buf:kotlin.ByteArray) Input buffer for reading compressed data. | | [Deflater](https://developer.android.com/reference/kotlin/java/util/zip/Deflater)! | [def](https://developer.android.com/reference/kotlin/java/util/zip/DeflaterInputStream#def:java.util.zip.Deflater) Compressor for this stream. | | Inherited properties || |---|---| | From class[FilterInputStream](https://developer.android.com/reference/kotlin/java/io/FilterInputStream.html#) |------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| | [InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#)! | [in](https://developer.android.com/reference/kotlin/java/io/FilterInputStream.html#in:java.io.InputStream)
The input stream to be filtered.
| || ## Public constructors ### DeflaterInputStream Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` DeflaterInputStream(in: InputStream!) ``` Creates a new input stream with a default compressor and buffer size. | Parameters || |------|----------------------------------------------------------------------------------------------------------------------------------------| | `in` | [InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#)!:input stream to read the uncompressed data to | | Exceptions || |----------------------------------|---------------| | `java.lang.NullPointerException` | if`in`is null | ### DeflaterInputStream Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` DeflaterInputStream(     in: InputStream!,     defl: Deflater!) ``` Creates a new input stream with the specified compressor and a default buffer size. | Parameters || |--------|----------------------------------------------------------------------------------------------------------------------------------------| | `in` | [InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#)!:input stream to read the uncompressed data to | | `defl` | [Deflater](https://developer.android.com/reference/kotlin/java/util/zip/Deflater)!:compressor ("deflater") for this stream | | Exceptions || |----------------------------------|-----------------------| | `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.html#ApiLevels) ``` DeflaterInputStream(     in: InputStream!,     defl: Deflater!,     bufLen: Int) ``` Creates a new input stream with the specified compressor and buffer size. | Parameters || |----------|----------------------------------------------------------------------------------------------------------------------------------------| | `in` | [InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#)!:input stream to read the uncompressed data to | | `defl` | [Deflater](https://developer.android.com/reference/kotlin/java/util/zip/Deflater)!:compressor ("deflater") for this stream | | `bufLen` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):compression buffer size | | Exceptions || |--------------------------------------|-----------------------| | `java.lang.IllegalArgumentException` | if`bufLen <= 0` | | `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.html#ApiLevels) ``` open fun available(): Int ``` 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 | Return || |----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | zero after the end of the underlying input stream has been reached, otherwise always returns 1 | | Exceptions || |-----------------------|------------------------------------------------------------| | `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.html#ApiLevels) ``` open fun close(): Unit ``` Closes this input stream and its underlying input stream, discarding any pending uncompressed data. | Exceptions || |-----------------------|-----------------------------------| | `java.lang.Exception` | if this resource cannot be closed | | `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.html#ApiLevels) ``` open fun mark(limit: Int): Unit ``` *This operation is not supported*. | Parameters || |-------------|---------------------------------------------------------------------------------------------------------------------------------------------------| | `readlimit` | the maximum limit of bytes that can be read before the mark position becomes invalid. | | `limit` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):maximum bytes that can be read before invalidating the position marker | ### markSupported Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun markSupported(): Boolean ``` Always returns`false`because this input stream does not support the #mark and #reset methods. | Return || |------------------------------------------------------------------------------------|---------------| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | false, always | ### read Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun read(): Int ``` Reads a single byte of compressed data from the input stream. This method will block until some input can be read and compressed. | Return || |----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a single byte of compressed data, or -1 if the end of the uncompressed input stream is reached | | Exceptions || |-----------------------|------------------------------------------------------------| | `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.html#ApiLevels) ``` open fun read(     b: ByteArray!,     off: Int,     len: Int ): Int ``` Reads compressed data into a byte array. This method will block until some input can be read and compressed. | Parameters || |-------|-------------------------------------------------------------------------------------------------------------------------------| | `b` | [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)!:buffer into which the data is read | | `off` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):starting offset of the data within`b` | | `len` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):maximum number of compressed bytes to read into`b` | | Return || |----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | the actual number of bytes read, or -1 if the end of the uncompressed input stream is reached | | Exceptions || |---------------------------------------|------------------------------------------------------------------| | `java.io.IOException` | if an I/O error occurs or if this input stream is already closed | | `java.lang.NullPointerException` | If`b`is`null`. | | `java.lang.IndexOutOfBoundsException` | if`len > b.length - off` | ### reset Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun reset(): Unit ``` *This operation is not supported*. | Exceptions || |-----------------------|---------------| | `java.io.IOException` | always thrown | ### skip Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun skip(n: Long): Long ``` 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`. | Parameters || |-----|------------------------------------------------------------------------------------------------------------| | `n` | [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html):number of bytes to be skipped | | Return || |------------------------------------------------------------------------------|------------------------------------| | [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | the actual number of bytes skipped | | Exceptions || |-----------------------|------------------------------------------------------------| | `java.io.IOException` | if an I/O error occurs or if this stream is already closed | ## Properties ### buf Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` protected val buf: ByteArray! ``` Input buffer for reading compressed data. ### def Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` protected val def: Deflater! ``` Compressor for this stream.