ZipOutputStream
Class ZipOutputStream
- java.lang.Object
-
- java.io.OutputStream
-
- java.io.FilterOutputStream
-
- java.util.zip.DeflaterOutputStream
-
- java.util.zip.ZipOutputStream
- All Implemented Interfaces:
- Closeable, Flushable, AutoCloseable
- Direct Known Subclasses:
- JarOutputStream
public class ZipOutputStream extends DeflaterOutputStream
This class implements an output stream filter for writing files in the ZIP file format. Includes support for both compressed and uncompressed entries.
Fields
STORED
public static final int STORED
Compression method for uncompressed (STORED) entries.
DEFLATED
public static final int DEFLATED
Compression method for compressed (DEFLATED) entries.
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
ZipOutputStream
public ZipOutputStream(OutputStream out)
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
public ZipOutputStream(OutputStream out, Charset charset)
Creates a new ZIP output stream.
- Parameters:
-
out
- the actual output stream -
charset
- the charset to be used to encode the entry names and comments - Since:
- 1.7
Methods
setComment
public void setComment(String comment)
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
public void putNextEntry(ZipEntry e) throws IOException
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
- the ZIP entry to be written - Throws:
-
ZipException
- if a ZIP format 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 writing the next entry.
- Throws:
-
ZipException
- if a ZIP format error has occurred -
IOException
- if an I/O error has occurred
write
public void write(byte[] b, int off, int len) throws IOException
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 written -
off
- the start offset in the data -
len
- the number of bytes that are written - Throws:
-
ZipException
- if a ZIP file error has occurred -
IOException
- if an I/O error has occurred - See Also:
FilterOutputStream.write(int)
finish
public void finish() throws IOException
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.
- Overrides:
-
finish
in classDeflaterOutputStream
- Throws:
-
ZipException
- if a ZIP file error has occurred -
IOException
- if an I/O exception has occurred
close
public void close() throws IOException
Closes the ZIP output stream as well as the stream being filtered.
- Specified by:
-
close
in interfaceCloseable
- Specified by:
-
close
in interfaceAutoCloseable
- Overrides:
-
close
in classDeflaterOutputStream
- Throws:
-
ZipException
- if a ZIP file error has occurred -
IOException
- if an I/O error has occurred - See Also:
-
FilterOutputStream.flush()
,FilterOutputStream.out
© 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.