public class

GZIPInputStream

extends InflaterInputStream
java.lang.Object
   ↳ java.io.InputStream
     ↳ java.io.FilterInputStream
       ↳ java.util.zip.InflaterInputStream
         ↳ java.util.zip.GZIPInputStream

Class Overview

The GZIPInputStream class is used to read data stored in the GZIP format, reading and decompressing GZIP data from the underlying stream into its buffer.

Summary

Constants
int GZIP_MAGIC The magic header for the GZIP format.
Fields
protected CRC32 crc The checksum algorithm used when handling uncompressed data.
protected boolean eos Indicates the end of the input stream.
[Expand]
Inherited Fields
From class java.util.zip.InflaterInputStream
From class java.io.FilterInputStream
Public Constructors
GZIPInputStream(InputStream is)
Construct a GZIPInputStream to read from GZIP data from the underlying stream.
GZIPInputStream(InputStream is, int size)
Construct a GZIPInputStream to read from GZIP data from the underlying stream.
Public Methods
void close()
Closes the input stream.
int read(byte[] buffer, int off, int nbytes)
Reads up to nbytes of decompressed data and stores it in buffer starting at off.
[Expand]
Inherited Methods
From class java.util.zip.InflaterInputStream
From class java.io.FilterInputStream
From class java.io.InputStream
From class java.lang.Object
From interface java.io.Closeable

Constants

public static final int GZIP_MAGIC

The magic header for the GZIP format.

Constant Value: 35615 (0x00008b1f)

Fields

protected CRC32 crc

The checksum algorithm used when handling uncompressed data.

protected boolean eos

Indicates the end of the input stream.

Public Constructors

public GZIPInputStream (InputStream is)

Construct a GZIPInputStream to read from GZIP data from the underlying stream.

Parameters
is the InputStream to read data from.
Throws
IOException if an IOException occurs.

public GZIPInputStream (InputStream is, int size)

Construct a GZIPInputStream to read from GZIP data from the underlying stream. Set the internal buffer size to size.

Parameters
is the InputStream to read data from.
size the internal read buffer size.
Throws
IOException if an IOException occurs.

Public Methods

public void close ()

Closes the input stream.

Throws
IOException

public int read (byte[] buffer, int off, int nbytes)

Reads up to nbytes of decompressed data and stores it in buffer starting at off.

Parameters
buffer the buffer to write data to.
off offset in buffer to start writing.
nbytes number of bytes to read.
Returns
  • Number of uncompressed bytes read
Throws
IOException