GZIPInputStream (Java 2 Platform SE 5.0) (original) (raw)

java.util.zip

Class GZIPInputStream

java.lang.Object extended by java.io.InputStream java.io.FilterInputStream java.util.zip.InflaterInputStream java.util.zip.GZIPInputStream

All Implemented Interfaces:

Closeable

public class GZIPInputStream

extends InflaterInputStream

This class implements a stream filter for reading compressed data in the GZIP file 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](../../../java/util/zip/GZIPInputStream.html#GZIPInputStream%28java.io.InputStream, int%29)(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](../../../java/util/zip/GZIPInputStream.html#read%28byte[], int, int%29)(byte[] buf, int off, int len) Reads uncompressed data into an array of bytes.

Methods inherited from class java.util.zip.InflaterInputStream
available, fill, mark, markSupported, read, reset, skip

Methods inherited from class java.io.FilterInputStream
read

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../../java/lang/Object.html#wait%28long, int%29)

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.

See Also:

Constant Field Values

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](../../../java/io/IOException.html "class in java.io") - if an I/O error has occurred

[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - 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](../../../java/io/IOException.html "class in java.io") - 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.

Overrides:

[read](../../../java/util/zip/InflaterInputStream.html#read%28byte[], int, int%29) in class [InflaterInputStream](../../../java/util/zip/InflaterInputStream.html "class in java.util.zip")

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](../../../java/io/IOException.html "class in java.io") - if an I/O error has occurred or the compressed input data is corrupt

See Also:

FilterInputStream.in

close

public void close() throws IOException

Closes this input stream and releases any system resources associated with the stream.

Specified by:

[close](../../../java/io/Closeable.html#close%28%29) in interface [Closeable](../../../java/io/Closeable.html "interface in java.io")

Overrides:

[close](../../../java/util/zip/InflaterInputStream.html#close%28%29) in class [InflaterInputStream](../../../java/util/zip/InflaterInputStream.html "class in java.util.zip")

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error has occurred

See Also:

FilterInputStream.in

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.