Known Direct Subclasses |
This class implements an input stream filter for reading files in the ZIP file format. Includes support for both compressed and uncompressed entries.
Constant Summary
int | CENATT | |
int | CENATX | |
int | CENCOM | |
int | CENCRC | |
int | CENDSK | |
int | CENEXT | |
int | CENFLG | |
int | CENHDR | |
int | CENHOW | |
int | CENLEN | |
int | CENNAM | |
int | CENOFF | |
long | CENSIG | |
int | CENSIZ | |
int | CENTIM | |
int | CENVEM | |
int | CENVER | |
int | ENDCOM | |
int | ENDHDR | |
int | ENDOFF | |
long | ENDSIG | |
int | ENDSIZ | |
int | ENDSUB | |
int | ENDTOT | |
int | EXTCRC | |
int | EXTHDR | |
int | EXTLEN | |
long | EXTSIG | |
int | EXTSIZ | |
int | LOCCRC | |
int | LOCEXT | |
int | LOCFLG | |
int | LOCHDR | |
int | LOCHOW | |
int | LOCLEN | |
int | LOCNAM | |
long | LOCSIG | |
int | LOCSIZ | |
int | LOCTIM | |
int | LOCVER |
Inherited Field Summary
Public Constructor Summary
Public Method Summary
int |
available()
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 |
closeEntry()
Closes the current ZIP entry and positions the stream for reading the
next entry.
|
ZipEntry |
getNextEntry()
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.
|
Protected Method Summary
ZipEntry |
Inherited Method Summary
Constants
public static final int CENATT
public static final int CENATX
public static final int CENCOM
public static final int CENCRC
public static final int CENDSK
public static final int CENEXT
public static final int CENFLG
public static final int CENHDR
public static final int CENHOW
public static final int CENLEN
public static final int CENNAM
public static final int CENOFF
public static final long CENSIG
public static final int CENSIZ
public static final int CENTIM
public static final int CENVEM
public static final int CENVER
public static final int ENDCOM
public static final int ENDHDR
public static final int ENDOFF
public static final long ENDSIG
public static final int ENDSIZ
public static final int ENDSUB
public static final int ENDTOT
public static final int EXTCRC
public static final int EXTHDR
public static final int EXTLEN
public static final long EXTSIG
public static final int EXTSIZ
public static final int LOCCRC
public static final int LOCEXT
public static final int LOCFLG
public static final int LOCHDR
public static final int LOCHOW
public static final int LOCLEN
public static final int LOCNAM
public static final long LOCSIG
public static final int LOCSIZ
public static final int LOCTIM
public static final int LOCVER
Public Constructors
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 |
---|
public ZipInputStream (InputStream in, Charset charset)
Creates a new ZIP input stream.
Parameters
in | the actual input stream |
---|---|
charset | The {@linkplain java.nio.charset.Charset 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). |
Public Methods
public int 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.
Returns
- 1 before EOF and 0 after EOF has reached for current entry.
Throws
IOException | if an I/O error occurs. |
---|
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 |
---|
public void closeEntry ()
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 |
public ZipEntry 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 occurred |
---|---|
IOException | if an I/O error has occurred |
public int read (byte[] b, int off, int len)
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.
Parameters
b | 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 entry is reached
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 file error has occurred |
IOException | if an I/O error has occurred |
public long skip (long n)
Skips specified number of bytes in the current ZIP entry.
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 | if n < 0
|