public
class
ZipOutputStream
extends DeflaterOutputStream
| java.lang.Object | ||||
| ↳ | java.io.OutputStream | |||
| ↳ | java.io.FilterOutputStream | |||
| ↳ | java.util.zip.DeflaterOutputStream | |||
| ↳ | java.util.zip.ZipOutputStream | |||
 Known Direct Subclasses
|
This class implements an output stream filter for writing files in the ZIP file format. Includes support for both compressed and uncompressed entries.
Constants | |
|---|---|
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 |
DEFLATED
Compression method for compressed (DEFLATED) entries. |
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
|
int |
STORED
Compression method for uncompressed (STORED) entries. |
Inherited fields |
|---|
From
class
java.util.zip.DeflaterOutputStream
|
From
class
java.io.FilterOutputStream
|
Public constructors | |
|---|---|
ZipOutputStream(OutputStream out)
Creates a new ZIP output stream. |
|
ZipOutputStream(OutputStream out, Charset charset)
Creates a new ZIP output stream. |
|
Public methods | |
|---|---|
void
|
close()
Closes the ZIP output stream as well as the stream being filtered. |
void
|
closeEntry()
Closes the current ZIP entry and positions the stream for writing the next entry. |
void
|
finish()
Finishes writing the contents of the ZIP output stream without closing the underlying stream. |
void
|
putNextEntry(ZipEntry e)
Begins writing a new ZIP file entry and positions the stream to the start of the entry data. |
void
|
setComment(String comment)
Sets the ZIP file comment. |
void
|
setLevel(int level)
Sets the compression level for subsequent entries which are DEFLATED. |
void
|
setMethod(int method)
Sets the default compression method for subsequent entries. |
void
|
write(byte[] b, int off, int len)
Writes an array of bytes to the current ZIP entry data. |
Inherited methods | |
|---|---|
From
class
java.util.zip.DeflaterOutputStream
| |
From
class
java.io.FilterOutputStream
| |
From
class
java.io.OutputStream
| |
From
class
java.lang.Object
| |
From
interface
java.io.Closeable
| |
From
interface
java.io.Flushable
| |
From
interface
java.lang.AutoCloseable
| |
int DEFLATED
Compression method for compressed (DEFLATED) entries.
Constant Value: 8 (0x00000008)
int STORED
Compression method for uncompressed (STORED) entries.
Constant Value: 0 (0x00000000)
ZipOutputStream (OutputStream out)
Creates a new ZIP output stream.
The UTF-8 charset is used
to encode the entry names and comments.
| Parameters | |
|---|---|
out |
OutputStream:
the actual output stream
|
ZipOutputStream (OutputStream out, Charset charset)
Creates a new ZIP output stream.
| Parameters | |
|---|---|
out |
OutputStream:
the actual output stream |
charset |
Charset:
the charset
to be used to encode the entry names and comments |
void close ()
Closes the ZIP output stream as well as the stream being filtered.
| Throws | |
|---|---|
ZipException |
if a ZIP file error has occurred |
IOException |
if an I/O error has occurred |
void closeEntry ()
Closes the current ZIP entry and positions the stream for writing the next entry.
| Throws | |
|---|---|
ZipException |
if a ZIP format error has occurred |
IOException |
if an I/O error has occurred |
void finish ()
Finishes writing the contents of the ZIP output stream without closing the underlying stream. Use this method when applying multiple filters in succession to the same output stream.
| Throws | |
|---|---|
ZipException |
if a ZIP file error has occurred |
IOException |
if an I/O exception has occurred |
void putNextEntry (ZipEntry e)
Begins writing a new ZIP file entry and positions the stream to the start of the entry data. Closes the current entry if still active. The default compression method will be used if no compression method was specified for the entry, and the current time will be used if the entry has no set modification time.
| Parameters | |
|---|---|
e |
ZipEntry:
the ZIP entry to be written |
| Throws | |
|---|---|
ZipException |
if a ZIP format error has occurred |
IOException |
if an I/O error has occurred |
void setComment (String comment)
Sets the ZIP file comment.
| Parameters | |
|---|---|
comment |
String:
the comment string |
| Throws | |
|---|---|
IllegalArgumentException |
if the length of the specified ZIP file comment is greater than 0xFFFF bytes |
void setLevel (int level)
Sets the compression level for subsequent entries which are DEFLATED. The default setting is DEFAULT_COMPRESSION.
| Parameters | |
|---|---|
level |
int:
the compression level (0-9) |
| Throws | |
|---|---|
IllegalArgumentException |
if the compression level is invalid |
void setMethod (int method)
Sets the default compression method for subsequent entries. This default will be used whenever the compression method is not specified for an individual ZIP file entry, and is initially set to DEFLATED.
| Parameters | |
|---|---|
method |
int:
the default compression method |
| Throws | |
|---|---|
IllegalArgumentException |
if the specified compression method is invalid |
Developers
void write (byte[] b,
int off,
int len)
Writes an array of bytes to the current ZIP entry data. This method will block until all the bytes are written.
| Parameters | |
|---|---|
b |
byte:
the data to be written |
off |
int:
the start offset in the data |
len |
int:
the number of bytes that are written |
| Throws | |
|---|---|
ZipException |
if a ZIP file error has occurred |
IOException |
if an I/O error has occurred |