ZipInputStream
Class ZipInputStream
- 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
public class ZipInputStream extends InflaterInputStream
This class implements an input stream filter for reading files in the ZIP file format. Includes support for both compressed and uncompressed entries.
Fields
LOCSIG
public static final long LOCSIG
EXTSIG
public static final long EXTSIG
CENSIG
public static final long CENSIG
ENDSIG
public static final long ENDSIG
LOCHDR
public static final int LOCHDR
EXTHDR
public static final int EXTHDR
CENHDR
public static final int CENHDR
ENDHDR
public static final int ENDHDR
LOCVER
public static final int LOCVER
LOCFLG
public static final int LOCFLG
LOCHOW
public static final int LOCHOW
LOCTIM
public static final int LOCTIM
LOCCRC
public static final int LOCCRC
LOCSIZ
public static final int LOCSIZ
LOCLEN
public static final int LOCLEN
LOCNAM
public static final int LOCNAM
LOCEXT
public static final int LOCEXT
EXTCRC
public static final int EXTCRC
EXTSIZ
public static final int EXTSIZ
EXTLEN
public static final int EXTLEN
CENVEM
public static final int CENVEM
CENVER
public static final int CENVER
CENFLG
public static final int CENFLG
CENHOW
public static final int CENHOW
CENTIM
public static final int CENTIM
CENCRC
public static final int CENCRC
CENSIZ
public static final int CENSIZ
CENLEN
public static final int CENLEN
CENNAM
public static final int CENNAM
CENEXT
public static final int CENEXT
CENCOM
public static final int CENCOM
CENDSK
public static final int CENDSK
CENATT
public static final int CENATT
CENATX
public static final int CENATX
CENOFF
public static final int CENOFF
ENDSUB
public static final int ENDSUB
ENDTOT
public static final int ENDTOT
ENDSIZ
public static final int ENDSIZ
ENDOFF
public static final int ENDOFF
ENDCOM
public static final int ENDCOM
Constructors
ZipInputStream
public ZipInputStream(InputStream in)
Creates a new ZIP input stream.
The UTF-8 charset
is used to decode the entry names.
- Parameters:
-
in
- the actual input stream
ZipInputStream
public ZipInputStream(InputStream in, Charset charset)
Creates a new ZIP input stream.
- Parameters:
-
in
- the actual input stream -
charset
- 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
Methods
getNextEntry
public ZipEntry getNextEntry() throws IOException
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 occurred -
IOException
- if an I/O error has occurred
closeEntry
public void closeEntry() throws IOException
Closes the current ZIP entry and positions the stream for reading the next entry.
- Throws:
-
ZipException
- if a ZIP file error has occurred -
IOException
- if an I/O error has occurred
available
public int available() throws IOException
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
public int read(byte[] b, int off, int len) throws IOException
Reads from the current ZIP entry into an array of bytes. If len
is not zero, the method blocks until some input is available; otherwise, no bytes are read and 0
is returned.
- Overrides:
-
read
in classInflaterInputStream
- Parameters:
-
b
- 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 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 occurred -
IOException
- if an I/O error has occurred - See Also:
FilterInputStream.in
skip
public long skip(long n) throws IOException
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 occurred -
IOException
- if an I/O error has occurred -
IllegalArgumentException
- ifn < 0
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
createZipEntry
protected ZipEntry createZipEntry(String name)
Creates a new ZipEntry
object for the specified entry name.
- Parameters:
-
name
- the ZIP file entry name - Returns:
- the ZipEntry just created
© 1993–2017, 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.