Class GZIPInputStream
- java.lang.Object
-
- java.io.InputStream
-
- java.io.FilterInputStream
-
- java.util.zip.InflaterInputStream
-
- java.util.zip.GZIPInputStream
- All Implemented Interfaces:
- Closeable, AutoCloseable
public class GZIPInputStream extends InflaterInputStream
This class implements a stream filter for reading compressed data in the GZIP file format.
- See Also:
InflaterInputStream
Fields
Modifier and Type | Field and Description |
---|---|
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
Constructors
Constructor and Description |
---|
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. |
Methods
Modifier and Type | Method and Description |
---|---|
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, 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
Fields
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
Constructors
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:
-
ZipException
- if a GZIP format error has occurred or the compression method used is unsupported -
IOException
- if an I/O error has occurred -
IllegalArgumentException
- ifsize <= 0
GZIPInputStream
public GZIPInputStream(InputStream in) throws IOException
Creates a new input stream with a default buffer size.
- Parameters:
-
in
- the input stream - Throws:
-
ZipException
- if a GZIP format error has occurred or the compression method used is unsupported -
IOException
- if an I/O error has occurred
Methods
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 classInflaterInputStream
- Parameters:
-
buf
- the buffer into which the data is read -
off
- the start offset in the destination arrayb
-
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:
-
NullPointerException
- Ifbuf
isnull
. -
IndexOutOfBoundsException
- Ifoff
is negative,len
is negative, orlen
is greater thanbuf.length - off
-
ZipException
- if the compressed input data is corrupt. -
IOException
- if an I/O error has occurred. - 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
in interfaceCloseable
- Specified by:
-
close
in interfaceAutoCloseable
- Overrides:
-
close
in classInflaterInputStream
- Throws:
-
IOException
- if an I/O error has occurred - See Also:
FilterInputStream.in
© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/javase/8/docs/api/java/util/zip/GZIPInputStream.html