Added in API level 1

GZIPInputStream

open class GZIPInputStream : InflaterInputStream

kotlin.Any
↳	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
static Int	`GZIP_MAGIC` GZIP header magic number.

Public constructors
`GZIPInputStream(in: InputStream!)` Creates a new input stream with a default buffer size.
`GZIPInputStream(in: InputStream!, size: Int)` Creates a new input stream with the specified buffer size.

Public methods
open Unit	`close()` Closes this input stream and releases any system resources associated with the stream.
open Int	`read(buf: ByteArray!, off: Int, len: Int)` Reads uncompressed data into an array of bytes.

Inherited functions

From class InflaterInputStream

`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.
`Unit`	`fill()` Fills input buffer with more data to decompress.
`Unit`	`mark(readlimit: Int)` Marks the current position in this input stream. The `mark` method of `InflaterInputStream` does nothing.
`Boolean`	`markSupported()` Tests if this input stream supports the `mark` and `reset` methods. The `markSupported` method of `InflaterInputStream` returns `false`.
`Int`	`read()` Reads a byte of uncompressed data. This method will block until enough input is available for decompression.
`Unit`	`reset()` Repositions this stream to the position at the time the `mark` method was last called on this input stream. The method `reset` for class `InflaterInputStream` does nothing except throw an `IOException`.
`Long`	`skip(n: Long)` Skips specified number of bytes of uncompressed data.

From class InputStream

`InputStream!`	`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!`	`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`	`readNBytes(b: ByteArray!, off: Int, len: Int)` 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!`	`readNBytes(len: Int)` 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`	`skipNBytes(n: Long)` 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`	`transferTo(out: OutputStream!)` 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

Int

read(b: ByteArray!)

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
CRC32!	`crc` CRC-32 for uncompressed data.
Boolean	`eos` Indicates end of input stream.

Inherited properties

From class InflaterInputStream

`ByteArray!`	`buf` Input buffer for decompression.
`Boolean`	`closed` Indicates whether the #close() method has been called, internal use only.
`Inflater!`	`inf` Decompressor for this stream.
`Int`	`len` Length of input buffer.

From class FilterInputStream

InputStream!

in

The input stream to be filtered.

Constants

GZIP_MAGIC

Added in API level 1

static val GZIP_MAGIC: Int

GZIP header magic number.

Value: 35615

Public constructors