This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

java.util.zip
class GZIPInputStream

java.lang.Object extended by java.io.InputStream extended by java.io.FilterInputStream extended by java.util.zip.InflaterInputStream extended by java.util.zip.GZIPInputStream
All Implemented Interfaces:
Closeable
Most common way to construct:

FileInputStream fis = …;

GZIPInputStream in = new GZIPInputStream(fis);

Based on 29 examples 

public class GZIPInputStream
extends InflaterInputStream

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

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 this input stream and releases any system resources associated with the 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, 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, 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)
                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

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
Method Detail

close

public void close()
           throws IOException
Closes this input stream and releases any system resources associated with the stream.

Overrides:
close in class InflaterInputStream
Throws:
IOException - if an I/O error has occurred

read

public int read(byte[] buf,
                int off,
                int len)
         throws IOException
Reads uncompressed data into an array of bytes. If len is not zero, the method will block until some input can be decompressed; otherwise, no bytes are read and 0 is returned.

Overrides:
read in class InflaterInputStream
Parameters:
buf - the buffer into which the data is read
off - the start offset in the destination array b
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
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.