java.lang.Object
java.io.InputStream
java.io.FilterInputStream
java.util.zip.InflaterInputStream
java.util.zip.ZipInputStream
- All Implemented Interfaces:
Closeable
,AutoCloseable
- Direct Known Subclasses:
JarInputStream
This class implements an input stream filter for reading files in the
ZIP file format. Includes support for both compressed and uncompressed
entries.
- Since:
- 1.1
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Central directory (CEN) header internal file attributes field offset.static final int
Central directory (CEN) header external file attributes field offset.static final int
Central directory (CEN) header comment length field offset.static final int
Central directory (CEN) header uncompressed file crc-32 value field offset.static final int
Central directory (CEN) header disk number start field offset.static final int
Central directory (CEN) header extra field length field offset.static final int
Central directory (CEN) header encrypt, decrypt flags field offset.static final int
Central directory (CEN) header size in bytes (including signature).static final int
Central directory (CEN) header compression method field offset.static final int
Central directory (CEN) header uncompressed size field offset.static final int
Central directory (CEN) header filename length field offset.static final int
Central directory (CEN) header LOC header offset field offset.static final long
Central directory (CEN) header signature.static final int
Central directory (CEN) header compressed size field offset.static final int
Central directory (CEN) header modification time field offset.static final int
Central directory (CEN) header version made by field offset.static final int
Central directory (CEN) header version needed to extract field offset.static final int
End of central directory (END) header zip file comment length field offset.static final int
End of central directory (END) header size in bytes (including signature).static final int
End of central directory (END) header offset for the first CEN header field offset.static final long
End of central directory (END) header signature.static final int
End of central directory (END) header central directory size in bytes field offset.static final int
End of central directory (END) header number of entries on this disk field offset.static final int
End of central directory (END) header total number of entries field offset.static final int
Extra local (EXT) header uncompressed file crc-32 value field offset.static final int
Extra local (EXT) header size in bytes (including signature).static final int
Extra local (EXT) header uncompressed size field offset.static final long
Extra local (EXT) header signature.static final int
Extra local (EXT) header compressed size field offset.static final int
Local file (LOC) header uncompressed file crc-32 value field offset.static final int
Local file (LOC) header extra field length field offset.static final int
Local file (LOC) header general purpose bit flag field offset.static final int
Local file (LOC) header size in bytes (including signature).static final int
Local file (LOC) header compression method field offset.static final int
Local file (LOC) header uncompressed size field offset.static final int
Local file (LOC) header filename length field offset.static final long
Local file (LOC) header signature.static final int
Local file (LOC) header compressed size field offset.static final int
Local file (LOC) header modification time field offset.static final int
Local file (LOC) header version needed to extract field offset.Fields declared in class java.util.zip.InflaterInputStream
buf, inf, len
Fields declared in class java.io.FilterInputStream
in
-
Constructor Summary
ConstructorDescriptionCreates a new ZIP input stream.ZipInputStream
(InputStream in, Charset charset) Creates a new ZIP input stream. -
Method Summary
Modifier and TypeMethodDescriptionint
Returns 0 after EOF has reached for the current entry data, otherwise always return 1.void
close()
Closes this input stream and releases any system resources associated with the stream.void
Closes the current ZIP entry and positions the stream for reading the next entry.protected ZipEntry
createZipEntry
(String name) Creates a newZipEntry
object for the specified entry name.Reads the next ZIP file entry and positions the stream at the beginning of the entry data.int
read
(byte[] b, int off, int len) Reads from the current ZIP entry into an array of bytes.long
skip
(long n) Skips specified number of bytes in the current ZIP entry.Methods declared in class java.util.zip.InflaterInputStream
fill, mark, markSupported, read, reset
Methods declared in class java.io.FilterInputStream
read
Methods declared in class java.io.InputStream
nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo
-
Field Details
-
LOCSIG
static final long LOCSIGLocal file (LOC) header signature.- See Also:
-
EXTSIG
static final long EXTSIGExtra local (EXT) header signature.- See Also:
-
CENSIG
static final long CENSIGCentral directory (CEN) header signature.- See Also:
-
ENDSIG
static final long ENDSIGEnd of central directory (END) header signature.- See Also:
-
LOCHDR
static final int LOCHDRLocal file (LOC) header size in bytes (including signature).- See Also:
-
EXTHDR
static final int EXTHDRExtra local (EXT) header size in bytes (including signature).- See Also:
-
CENHDR
static final int CENHDRCentral directory (CEN) header size in bytes (including signature).- See Also:
-
ENDHDR
static final int ENDHDREnd of central directory (END) header size in bytes (including signature).- See Also:
-
LOCVER
static final int LOCVERLocal file (LOC) header version needed to extract field offset.- See Also:
-
LOCFLG
static final int LOCFLGLocal file (LOC) header general purpose bit flag field offset.- See Also:
-
LOCHOW
static final int LOCHOWLocal file (LOC) header compression method field offset.- See Also:
-
LOCTIM
static final int LOCTIMLocal file (LOC) header modification time field offset.- See Also:
-
LOCCRC
static final int LOCCRCLocal file (LOC) header uncompressed file crc-32 value field offset.- See Also:
-
LOCSIZ
static final int LOCSIZLocal file (LOC) header compressed size field offset.- See Also:
-
LOCLEN
static final int LOCLENLocal file (LOC) header uncompressed size field offset.- See Also:
-
LOCNAM
static final int LOCNAMLocal file (LOC) header filename length field offset.- See Also:
-
LOCEXT
static final int LOCEXTLocal file (LOC) header extra field length field offset.- See Also:
-
EXTCRC
static final int EXTCRCExtra local (EXT) header uncompressed file crc-32 value field offset.- See Also:
-
EXTSIZ
static final int EXTSIZExtra local (EXT) header compressed size field offset.- See Also:
-
EXTLEN
static final int EXTLENExtra local (EXT) header uncompressed size field offset.- See Also:
-
CENVEM
static final int CENVEMCentral directory (CEN) header version made by field offset.- See Also:
-
CENVER
static final int CENVERCentral directory (CEN) header version needed to extract field offset.- See Also:
-
CENFLG
static final int CENFLGCentral directory (CEN) header encrypt, decrypt flags field offset.- See Also:
-
CENHOW
static final int CENHOWCentral directory (CEN) header compression method field offset.- See Also:
-
CENTIM
static final int CENTIMCentral directory (CEN) header modification time field offset.- See Also:
-
CENCRC
static final int CENCRCCentral directory (CEN) header uncompressed file crc-32 value field offset.- See Also:
-
CENSIZ
static final int CENSIZCentral directory (CEN) header compressed size field offset.- See Also:
-
CENLEN
static final int CENLENCentral directory (CEN) header uncompressed size field offset.- See Also:
-
CENNAM
static final int CENNAMCentral directory (CEN) header filename length field offset.- See Also:
-
CENEXT
static final int CENEXTCentral directory (CEN) header extra field length field offset.- See Also:
-
CENCOM
static final int CENCOMCentral directory (CEN) header comment length field offset.- See Also:
-
CENDSK
static final int CENDSKCentral directory (CEN) header disk number start field offset.- See Also:
-
CENATT
static final int CENATTCentral directory (CEN) header internal file attributes field offset.- See Also:
-
CENATX
static final int CENATXCentral directory (CEN) header external file attributes field offset.- See Also:
-
CENOFF
static final int CENOFFCentral directory (CEN) header LOC header offset field offset.- See Also:
-
ENDSUB
static final int ENDSUBEnd of central directory (END) header number of entries on this disk field offset.- See Also:
-
ENDTOT
static final int ENDTOTEnd of central directory (END) header total number of entries field offset.- See Also:
-
ENDSIZ
static final int ENDSIZEnd of central directory (END) header central directory size in bytes field offset.- See Also:
-
ENDOFF
static final int ENDOFFEnd of central directory (END) header offset for the first CEN header field offset.- See Also:
-
ENDCOM
static final int ENDCOMEnd of central directory (END) header zip file comment length field offset.- See Also:
-
-
Constructor Details
-
ZipInputStream
Creates a new ZIP input stream.The UTF-8
charset
is used to decode the entry names.- Parameters:
in
- the actual input stream
-
ZipInputStream
Creates a new ZIP input stream.- Parameters:
in
- the actual input streamcharset
- The charset to be used to decode the ZIP entry name (ignored if the language encoding bit of the ZIP entry's general purpose bit flag is set).- Since:
- 1.7
-
-
Method Details
-
getNextEntry
Reads the next ZIP file entry and positions the stream at the beginning of the entry data.- Returns:
- the next ZIP file entry, or null if there are no more entries
- Throws:
ZipException
- if a ZIP file error has occurredIOException
- if an I/O error has occurred
-
closeEntry
Closes the current ZIP entry and positions the stream for reading the next entry.- Throws:
ZipException
- if a ZIP file error has occurredIOException
- if an I/O error has occurred
-
available
Returns 0 after EOF has reached for the current entry data, 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:
available
in classInflaterInputStream
- Returns:
- 1 before EOF and 0 after EOF has reached for current entry.
- Throws:
IOException
- if an I/O error occurs.
-
read
Reads from the current ZIP entry into an array of bytes. Iflen
is not zero, the method blocks until some input is available; otherwise, no bytes are read and0
is returned.- Overrides:
read
in classInflaterInputStream
- Parameters:
b
- the buffer into which the data is readoff
- 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 entry is reached
- Throws:
NullPointerException
- ifb
isnull
.IndexOutOfBoundsException
- ifoff
is negative,len
is negative, orlen
is greater thanb.length - off
ZipException
- if a ZIP file error has occurredIOException
- if an I/O error has occurred- See Also:
-
skip
Skips specified number of bytes in the current ZIP entry.- Overrides:
skip
in classInflaterInputStream
- Parameters:
n
- the number of bytes to skip- Returns:
- the actual number of bytes skipped
- Throws:
ZipException
- if a ZIP file error has occurredIOException
- 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:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classInflaterInputStream
- Throws:
IOException
- if an I/O error has occurred- See Also:
-
createZipEntry
Creates a newZipEntry
object for the specified entry name.- Parameters:
name
- the ZIP file entry name- Returns:
- the ZipEntry just created
-