InflaterInputStream
public
class
InflaterInputStream
extends FilterInputStream
java.lang.Object | |||
↳ | java.io.InputStream | ||
↳ | java.io.FilterInputStream | ||
↳ | java.util.zip.InflaterInputStream |
This class implements a stream filter for uncompressing data in the "deflate" compression format. It is also used as the basis for other decompression filters, such as GZIPInputStream.
See also:
Summary
Fields | |
---|---|
protected
byte[] |
buf
Input buffer for decompression. |
protected
boolean |
closed
This field was deprecated in API level 29. This field will be removed from a future version of Android and should not be used. Subclasses that access this field need to be modified to keep track of their own closed state by overriding close(). |
protected
Inflater |
inf
Decompressor for this stream. |
protected
int |
len
Length of input buffer. |
Inherited fields |
---|
Public constructors | |
---|---|
InflaterInputStream(InputStream in, Inflater inf, int size)
Creates a new input stream with the specified decompressor and buffer size. |
|
InflaterInputStream(InputStream in, Inflater inf)
Creates a new input stream with the specified decompressor and a default buffer size. |
|
InflaterInputStream(InputStream in)
Creates a new input stream with a default decompressor and buffer size. |
Public methods | |
---|---|
int
|
available()
Returns 0 after EOF has been reached, otherwise always return 1. |
void
|
close()
Closes this input stream and releases any system resources associated with the stream. |
void
|
mark(int readlimit)
Marks the current position in this input stream. |
boolean
|
markSupported()
Tests if this input stream supports the |
int
|
read()
Reads a byte of uncompressed data. |
int
|
read(byte[] b, int off, int len)
Reads uncompressed data into an array of bytes. |
void
|
reset()
Repositions this stream to the position at the time the
|
long
|
skip(long n)
Skips specified number of bytes of uncompressed data. |
Protected methods | |
---|---|
void
|
fill()
Fills input buffer with more data to decompress. |
Inherited methods | |
---|---|
Fields
closed
protected boolean closed
This field was deprecated
in API level 29.
This field will be removed from a future version of Android and should not be
used. Subclasses that access this field need to be modified to keep track of their own
closed state by overriding close().
Indicates whether the close()
method has been called, internal use only.
Public constructors
InflaterInputStream
public InflaterInputStream (InputStream in, Inflater inf, int size)
Creates a new input stream with the specified decompressor and buffer size.
Parameters | |
---|---|
in |
InputStream : the input stream |
inf |
Inflater : the decompressor ("inflater") |
size |
int : the input buffer size |
Throws | |
---|---|
IllegalArgumentException |
if size <= 0 |
InflaterInputStream
public InflaterInputStream (InputStream in, Inflater inf)
Creates a new input stream with the specified decompressor and a default buffer size.
Parameters | |
---|---|
in |
InputStream : the input stream |
inf |
Inflater : the decompressor ("inflater") |
InflaterInputStream
public InflaterInputStream (InputStream in)
Creates a new input stream with a default decompressor and buffer size.
Parameters | |
---|---|
in |
InputStream : the input stream |
Public methods
available
public int available ()
Returns 0 after EOF has been reached, otherwise always return 1.
Programs should not count on this method to return the actual number of bytes that could be read without blocking.
Returns | |
---|---|
int |
1 before EOF and 0 after EOF. |
Throws | |
---|---|
IOException |
if an I/O error occurs. |
close
public void close ()
Closes this input stream and releases any system resources associated with the stream.
Throws | |
---|---|
IOException |
if an I/O error has occurred |
mark
public void mark (int readlimit)
Marks the current position in this input stream.
The mark
method of InflaterInputStream
does nothing.
Parameters | |
---|---|
readlimit |
int : the maximum limit of bytes that can be read before
the mark position becomes invalid. |
See also:
markSupported
public boolean markSupported ()
Tests if this input stream supports the mark
and
reset
methods. The markSupported
method of InflaterInputStream
returns
false
.
Returns | |
---|---|
boolean |
a boolean indicating if this stream type supports
the mark and reset methods. |
See also:
read
public int read ()
Reads a byte of uncompressed data. This method will block until enough input is available for decompression.
Returns | |
---|---|
int |
the byte read, or -1 if end of compressed input is reached |
Throws | |
---|---|
IOException |
if an I/O error has occurred |
read
public int read (byte[] b, int off, int len)
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.
Parameters | |
---|---|
b |
byte : the buffer into which the data is read |
off |
int : the start offset in the destination array b |
len |
int : the maximum number of bytes read |
Returns | |
---|---|
int |
the actual number of bytes read, or -1 if the end of the compressed input is reached or a preset dictionary is needed |
Throws | |
---|---|
NullPointerException |
If b is null . |
IndexOutOfBoundsException |
If off is negative,
len is negative, or len is greater than
b.length - off |
ZipException |
if a ZIP format error has occurred |
IOException |
if an I/O error has occurred |
reset
public void reset ()
Repositions this stream to the position at the time the
mark
method was last called on this input stream.
The method reset
for class
InflaterInputStream
does nothing except throw an
IOException
.
Throws | |
---|---|
IOException |
if this method is invoked. |
See also:
skip
public long skip (long n)
Skips specified number of bytes of uncompressed data.
Parameters | |
---|---|
n |
long : the number of bytes to skip |
Returns | |
---|---|
long |
the actual number of bytes skipped. |
Throws | |
---|---|
IOException |
if an I/O error has occurred |
IllegalArgumentException |
if n < 0 |
Protected methods
fill
protected void fill ()
Fills input buffer with more data to decompress.
Throws | |
---|---|
IOException |
if an I/O error has occurred |