java.util.zip

Class GZIPInputStream

Implemented Interfaces:
AutoCloseable, Closeable

public class GZIPInputStream
extends InflaterInputStream

This filter stream is used to decompress a "GZIP" format stream. The "GZIP" format is described in RFC 1952.
Since:
JDK 1.1

Field Summary

static int
GZIP_MAGIC
The magic number found at the start of a GZIP stream.
protected CRC32
crc
The CRC-32 checksum value for uncompressed data.
protected boolean
eos
Indicates whether or not the end of the stream has been reached.

Fields inherited from class java.util.zip.InflaterInputStream

buf, inf, len

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

GZIPInputStream(InputStream in)
Creates a GZIPInputStream with the default buffer size.
GZIPInputStream(InputStream in, int size)
Creates a GZIPInputStream with the specified buffer size.

Method Summary

void
close()
Closes the input stream.
int
read(byte[] buf, int offset, int len)
Reads in GZIP-compressed data and stores it in uncompressed form into an array of bytes.

Methods inherited from class java.util.zip.InflaterInputStream

available, close, fill, mark, markSupported, read, read, reset, skip

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.io.InputStream

available, close, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

GZIP_MAGIC

public static final int GZIP_MAGIC
The magic number found at the start of a GZIP stream.
Field Value:
35615

crc

protected CRC32 crc
The CRC-32 checksum value for uncompressed data.

eos

protected boolean eos
Indicates whether or not the end of the stream has been reached.

Constructor Details

GZIPInputStream

public GZIPInputStream(InputStream in)
            throws IOException
Creates a GZIPInputStream with the default buffer size.
Parameters:
in - The stream to read compressed data from (in GZIP format).
Throws:
IOException - if an error occurs during an I/O operation.

GZIPInputStream

public GZIPInputStream(InputStream in,
                       int size)
            throws IOException
Creates a GZIPInputStream with the specified buffer size.
Parameters:
in - The stream to read compressed data from (in GZIP format).
size - The size of the buffer to use.
Throws:
IOException - if an error occurs during an I/O operation.
IllegalArgumentException - if size is less than or equal to 0.

Method Details

close

public void close()
            throws IOException
Closes the input stream.
Specified by:
close in interface Closeable
close in interface AutoCloseable
Overrides:
close in interface InflaterInputStream
Throws:
IOException - if an error occurs during an I/O operation.

read

public int read(byte[] buf,
                int offset,
                int len)
            throws IOException
Reads in GZIP-compressed data and stores it in uncompressed form into an array of bytes. The method will block until either enough input data becomes available or the compressed stream reaches its end.
Overrides:
read in interface InflaterInputStream
Parameters:
buf - the buffer into which the uncompressed data will be stored.
offset - the offset indicating where in buf the uncompressed data should be placed.
len - the number of uncompressed bytes to be read.

GZIPInputStream.java - Input filter for reading gzip file Copyright (C) 1999, 2000, 2001, 2002, 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.