java.lang.Object
java.io.InputStream
java.io.FilterInputStream
java.util.zip.InflaterInputStream
- All Implemented Interfaces:
Closeable,AutoCloseable
- Direct Known Subclasses:
GZIPInputStream,ZipInputStream
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.
- Since:
- 1.1
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected byte[]Input buffer for decompression.protected InflaterDecompressor for this stream.protected intThe total number of bytes read into the input buffer.Fields declared in class java.io.FilterInputStream
in -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new input stream with a default 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, Inflater inf, int size) Creates a new input stream with the specified decompressor and buffer size. -
Method Summary
Modifier and TypeMethodDescriptionintReturns 0 after EOF has been reached, otherwise always return 1.voidclose()Closes this input stream and releases any system resources associated with the stream.protected voidfill()Fills input buffer with more data to decompress.voidmark(int readlimit) Marks the current position in this input stream.booleanTests if this input stream supports themarkandresetmethods.intread()Reads a byte of uncompressed data.intread(byte[] b, int off, int len) Reads uncompressed data into an array of bytes, returning the number of inflated bytes.voidreset()Repositions this stream to the position at the time themarkmethod was last called on this input stream.longskip(long n) Skips specified number of bytes of uncompressed data.Methods declared in class java.io.FilterInputStream
readMethods declared in class java.io.InputStream
nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo
-
Field Details
-
inf
Decompressor for this stream. -
buf
protected byte[] bufInput buffer for decompression. -
len
protected int lenThe total number of bytes read into the input buffer.
-
-
Constructor Details
-
InflaterInputStream
Creates a new input stream with the specified decompressor and buffer size.- Parameters:
in- the input streaminf- the decompressor ("inflater")size- the input buffer size- Throws:
IllegalArgumentException- ifsize <= 0
-
InflaterInputStream
Creates a new input stream with the specified decompressor and a default buffer size.- Parameters:
in- the input streaminf- the decompressor ("inflater")
-
InflaterInputStream
Creates a new input stream with a default decompressor and buffer size.- Parameters:
in- the input stream
-
-
Method Details
-
read
Reads a byte of uncompressed data. This method will block until enough input is available for decompression.- Overrides:
readin classFilterInputStream- Returns:
- the byte read, or -1 if end of compressed input is reached
- Throws:
IOException- if an I/O error has occurred- See Also:
-
read
Reads uncompressed data into an array of bytes, returning the number of inflated bytes. Iflenis not zero, the method will block until some input can be decompressed; otherwise, no bytes are read and0is returned.If this method returns a nonzero integer n then
buf[off]throughbuf[off+n-1]contain the uncompressed data. The content of elementsbuf[off+n]throughbuf[off+len-1]is undefined, contrary to the specification of theInputStreamsuperclass, so an implementation is free to modify these elements during the inflate operation. If this method returns-1or throws an exception then the content ofbuf[off]throughbuf[off+len-1]is undefined.- Overrides:
readin classFilterInputStream- Parameters:
b- the buffer into which the data is readoff- the start offset in the destination arrayblen- the maximum number of bytes read- Returns:
- the actual number of bytes inflated, or -1 if the end of the compressed input is reached or a preset dictionary is needed
- Throws:
NullPointerException- Ifbisnull.IndexOutOfBoundsException- Ifoffis negative,lenis negative, orlenis greater thanb.length - offZipException- if a ZIP format error has occurredIOException- if an I/O error has occurred- See Also:
-
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.
- Overrides:
availablein classFilterInputStream- Returns:
- 1 before EOF and 0 after EOF.
- Throws:
IOException- if an I/O error occurs.
-
skip
Skips specified number of bytes of uncompressed data.- Overrides:
skipin classFilterInputStream- Parameters:
n- the number of bytes to skip- Returns:
- the actual number of bytes skipped.
- Throws:
IOException- if an I/O error has occurredIllegalArgumentException- ifn < 0- See Also:
-
close
Closes this input stream and releases any system resources associated with the stream.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classFilterInputStream- Throws:
IOException- if an I/O error has occurred- See Also:
-
fill
Fills input buffer with more data to decompress.- Implementation Requirements:
- This method will read up to
buf.length bytes into the input buffer,buf, starting at element0. Thelenfield will be set to the number of bytes read. - Throws:
IOException- if an I/O error has occurredEOFException- if the end of input stream has been reached unexpectedly
-
markSupported
public boolean markSupported()Tests if this input stream supports themarkandresetmethods. ThemarkSupportedmethod ofInflaterInputStreamreturnsfalse.- Overrides:
markSupportedin classFilterInputStream- Returns:
- a
booleanindicating if this stream type supports themarkandresetmethods. - See Also:
-
mark
public void mark(int readlimit) Marks the current position in this input stream.- Overrides:
markin classFilterInputStream- Implementation Requirements:
- The
markmethod ofInflaterInputStreamdoes nothing. - Parameters:
readlimit- the maximum limit of bytes that can be read before the mark position becomes invalid.- See Also:
-
reset
Repositions this stream to the position at the time themarkmethod was last called on this input stream.- Overrides:
resetin classFilterInputStream- Implementation Requirements:
- The method
resetfor classInflaterInputStreamdoes nothing except throw anIOException. - Throws:
IOException- if this method is invoked.- See Also:
-