Class ZipOutputStream
- All Implemented Interfaces:
Closeable
,Flushable
,AutoCloseable
- Direct Known Subclasses:
JarOutputStream
Unless otherwise noted, passing a null
argument to a constructor
or method in this class will cause a NullPointerException
to be
thrown.
- 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
Compression method for compressed (DEFLATED) entries.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.static final int
Compression method for uncompressed (STORED) entries.Fields inherited from class java.util.zip.DeflaterOutputStream
buf, def
Fields inherited from class java.io.FilterOutputStream
out
-
Constructor Summary
ConstructorDescriptionCreates a new ZIP output stream.ZipOutputStream
(OutputStream out, Charset charset) Creates a new ZIP output stream. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Closes the underlying stream and the stream being filtered after the contents of the ZIP output stream are fully written.void
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
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.Methods inherited from class java.util.zip.DeflaterOutputStream
deflate, flush, write
Methods inherited from class java.io.FilterOutputStream
write
Methods inherited from class java.io.OutputStream
nullOutputStream
-
Field Details
-
STORED
public static final int STOREDCompression method for uncompressed (STORED) entries.- See Also:
-
DEFLATED
public static final int DEFLATEDCompression method for compressed (DEFLATED) entries.- See Also:
-
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
-
ZipOutputStream
Creates a new ZIP output stream.The UTF-8
charset
is used to encode the entry names and comments.- Parameters:
out
- the actual output stream
-
ZipOutputStream
Creates a new ZIP output stream.- Parameters:
out
- the actual output streamcharset
- the charset to be used to encode the entry names and comments- Since:
- 1.7
-
-
Method Details
-
setComment
Sets the ZIP file comment.- Parameters:
comment
- the comment string- Throws:
IllegalArgumentException
- if the length of the specified ZIP file comment is greater than 0xFFFF bytes
-
setMethod
public 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
- the default compression method- Throws:
IllegalArgumentException
- if the specified compression method is invalid
-
setLevel
public void setLevel(int level) Sets the compression level for subsequent entries which are DEFLATED. The default setting is DEFAULT_COMPRESSION.- Parameters:
level
- the compression level (0-9)- Throws:
IllegalArgumentException
- if the compression level is invalid
-
putNextEntry
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. When writing a compressed (DEFLATED) entry, and the compressed size has not been explicitly set with the
ZipEntry.setCompressedSize(long)
method, then the compressed size will be set to the actual compressed size after deflation.The current time will be used if the entry has no set modification time.
- API Note:
- When writing a directory entry, the STORED compression method
should be used and the size and CRC-32 values should be set to 0:
ZipEntry e = new ZipEntry(entryName); if (e.isDirectory()) { e.setMethod(ZipEntry.STORED); e.setSize(0); e.setCrc(0); } stream.putNextEntry(e);
- Parameters:
e
- the ZIP entry to be written- Throws:
ZipException
- if a ZIP format error has occurredIOException
- if an I/O error has occurred
-
closeEntry
Closes the current ZIP entry and positions the stream for writing the next entry.- Throws:
ZipException
- if a ZIP format error has occurredIOException
- if an I/O error has occurred
-
write
Writes an array of bytes to the current ZIP entry data. This method will block until all the bytes are written.- Overrides:
write
in classDeflaterOutputStream
- Parameters:
b
- the data to be writtenoff
- the start offset in the datalen
- the number of bytes that are written- Throws:
ZipException
- if a ZIP file error has occurredIOException
- if an I/O error has occurred- See Also:
-
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.A ZipException will be thrown if the combined length, after encoding, of the entry name, the extra field data, the entry comment and CEN Header size, exceeds 65,535 bytes.
- Overrides:
finish
in classDeflaterOutputStream
- Throws:
ZipException
- if a ZIP file error has occurredIOException
- if an I/O exception has occurred
-
close
Closes the underlying stream and the stream being filtered after the contents of the ZIP output stream are fully written.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classDeflaterOutputStream
- Throws:
ZipException
- if a ZIP file error has occurredIOException
- if an I/O error has occurred- See Also:
-