Java Platform 1.2

java.util.zip
Class GZIPInputStream

java.lang.Object
  |
  +--java.io.InputStream
        |
        +--java.io.FilterInputStream
              |
              +--java.util.zip.InflaterInputStream
                    |
                    +--java.util.zip.GZIPInputStream

public class GZIPInputStream
extends InflaterInputStream

This class implements a stream filter for reading compressed data in the GZIP format.

See Also:
InflaterInputStream

Field Summary
protected  CRC32 crc
          CRC-32 for uncompressed data.
protected  boolean eos
          Indicates end of input stream.
static int GZIP_MAGIC
          GZIP header magic number.
 
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 new input stream with a default buffer size.
GZIPInputStream(InputStream in, int size)
          Creates a new input stream with the specified buffer size.
 
Method Summary
 void close()
          Closes the input stream.
 int read(byte[] buf, int off, int len)
          Reads uncompressed data into an array of bytes.
 
Methods inherited from class java.util.zip.InflaterInputStream
available, fill, read, skip
 
Methods inherited from class java.io.FilterInputStream
mark, markSupported, read, reset
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

crc

protected CRC32 crc
CRC-32 for uncompressed data.

eos

protected boolean eos
Indicates end of input stream.

GZIP_MAGIC

public static final int GZIP_MAGIC
GZIP header magic number.
Constructor Detail

GZIPInputStream

public GZIPInputStream(InputStream in,
                       int size)
                throws IOException
Creates a new input stream with the specified buffer size.
Parameters:
in - the input stream
size - the input buffer size
Throws:
IOException - if an I/O error has occurred
IllegalArgumentException - if size is <= 0

GZIPInputStream

public GZIPInputStream(InputStream in)
                throws IOException
Creates a new input stream with a default buffer size.
Parameters:
in - the input stream
Throws:
IOException - if an I/O error has occurred
Method Detail

read

public int read(byte[] buf,
                int off,
                int len)
         throws IOException
Reads uncompressed data into an array of bytes. Blocks until enough input is available for decompression.
Parameters:
buf - the buffer into which the data is read
off - the start offset of the data
len - the maximum number of bytes read
Returns:
the actual number of bytes read, or -1 if the end of the compressed input stream is reached
Throws:
IOException - if an I/O error has occurred or the compressed input data is corrupt
Overrides:
read in class InflaterInputStream

close

public void close()
           throws IOException
Closes the input stream.
Throws:
IOException - if an I/O error has occurred
Overrides:
close in class InflaterInputStream

Java Platform 1.2

Submit a bug or feature Version 1.2 of Java Platform API Specification
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.