Package Summary  Overview Summary

class:GZIPInputStream [NONE]

All Implemented Interfaces:
Closeable, AutoCloseable

public class GZIPInputStreamextends InflaterInputStream
This class implements a stream filter for reading compressed data in the GZIP file format.
Since:
1.1
See Also:

field:crc [NONE]

  • crc

    protected CRC32 crc
    CRC-32 for uncompressed data.
  • field:eos [NONE]

    eos

    protected boolean eos
    Indicates end of input stream.

    field:GZIP_MAGIC [NONE]

    GZIP_MAGIC

    public static final  int GZIP_MAGIC
    GZIP header magic number.
    See Also:

    constructor:GZIPInputStream(java.io.InputStream,int) [NONE]

  • 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 - if size <= 0
  • constructor:GZIPInputStream(java.io.InputStream) [NONE]

    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

    method:read(byte[],int,int) [CHANGED]

  • read

    public int read (byte[] buf, int off, int len) throws IOException
    Reads uncompressed data into an array of bytes, returning the number of inflated 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.

    If this method returns a nonzero integer n then buf[off] through buf[off+n-1] contain the uncompressed data. The content of elements buf[off+n] through buf[off+len-1] is undefined, contrary to the specification of the InputStream superclass, so an implementation is free to modify these elements during the inflate operation. If this method returns -1 or throws an exception then the content of buf[off] through buf[off+len -1] is undefined.

    Overrides:
    read in class InflaterInputStream
    Parameters:
    buf - the buffer into which the data is read
    off - the start offset in the destination array bbuf
    len - the maximum number of bytes read
    Returns:
    the actual number of bytes readinflated, or -1 if the end of the compressed input stream is reached
    Throws:
    NullPointerException - If buf is null.
    IndexOutOfBoundsException - If off is negative, len is negative, or len is greater than buf.length - off
    ZipException - if the compressed input data is corrupt.
    IOException - if an I/O error has occurred.
    See Also:
  • 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:
    NullPointerException - If buf is null.
    IndexOutOfBoundsException - If off is negative, len is negative, or len is greater than buf.length - off
    ZipException - if the compressed input data is corrupt.
    IOException - if an I/O error has occurred.
    See Also:
  • read

    public int read (byte[] buf, int off, int len) throws IOException
    Reads uncompressed data into an array of bytes, returning the number of inflated 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.

    If this method returns a nonzero integer n then buf[off] through buf[off+n-1] contain the uncompressed data. The content of elements buf[off+n] through buf[off+len-1] is undefined, contrary to the specification of the InputStream superclass, so an implementation is free to modify these elements during the inflate operation. If this method returns -1 or throws an exception then the content of buf[off] through buf[off+len -1] is undefined.

    Overrides:
    read in class InflaterInputStream
    Parameters:
    buf - the buffer into which the data is read
    off - the start offset in the destination array buf
    len - the maximum number of bytes read
    Returns:
    the actual number of bytes inflated, or -1 if the end of the compressed input stream is reached
    Throws:
    NullPointerException - If buf is null.
    IndexOutOfBoundsException - If off is negative, len is negative, or len is greater than buf.length - off
    ZipException - if the compressed input data is corrupt.
    IOException - if an I/O error has occurred.
    See Also:
  • method:close() [NONE]

    close

    public void close() throws IOException
    Closes this input stream and releases any system resources associated with the stream.
    Specified by:
    close in interface AutoCloseable
    Specified by:
    close in interface Closeable
    Overrides:
    close in class InflaterInputStream
    Throws:
    IOException - if an I/O error has occurred
    See Also:

    © 2023 Oracle Corporation and/or its affiliates