ZipOutputStream

public class ZipOutputStream extends DeflaterOutputStream

Known Direct Subclasses JarOutputStream JarOutputStream The JarOutputStream class is used to write the contents of a JAR file to any output stream.

This class implements an output stream filter for writing 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	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 Field Summary

From class java.util.zip.DeflaterOutputStream

protected byte[]	buf	Output buffer for writing compressed data.
protected Deflater	def	Compressor for this stream.

From class java.io.FilterOutputStream

protected OutputStream

out

The underlying output stream to be filtered.

Public Constructor Summary

	ZipOutputStream(OutputStream out) Creates a new ZIP output stream.
	ZipOutputStream(OutputStream out, Charset charset) Creates a new ZIP output stream.

Public Method Summary

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.
synchronized void	write(byte[] b, int off, int len) Writes an array of bytes to the current ZIP entry data.

Inherited Method Summary

From class java.util.zip.DeflaterOutputStream

void	close() Writes remaining compressed data to the output stream and closes the underlying stream.
void	deflate() Writes next block of compressed data to the output stream.
void	finish() Finishes writing compressed data to the output stream without closing the underlying stream.
void	flush() Flushes the compressed output stream.
void	write(byte[] b, int off, int len) Writes an array of bytes to the compressed output stream.
void	write(int b) Writes a byte to the compressed output stream.

From class java.io.FilterOutputStream

void	close() Closes this output stream and releases any system resources associated with the stream.
void	flush() Flushes this output stream and forces any buffered output bytes to be written out to the stream.
void	write(byte[] b) Writes b.length bytes to this output stream.
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off to this output stream.
void	write(int b) Writes the specified byte to this output stream.

From class java.io.OutputStream

void	close() Closes this output stream and releases any system resources associated with this stream.
void	flush() Flushes this output stream and forces any buffered output bytes to be written out.
void	write(byte[] b) Writes b.length bytes from the specified byte array to this output stream.
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off to this output stream.
abstract void	write(int b) Writes the specified byte to this output stream.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface java.io.Closeable

abstract void

close() Closes this stream and releases any system resources associated with it.

From interface java.io.Flushable

abstract void

flush() Flushes this stream by writing any buffered output to the underlying stream.

From interface java.lang.AutoCloseable

abstract void

close() Closes this resource, relinquishing any underlying resources.

Constants

public static final int CENATT

Constant Value: 36

public static final int CENATX

Constant Value: 38

public static final int CENCOM

Constant Value: 32

public static final int CENCRC

Constant Value: 16

public static final int CENDSK

Constant Value: 34

public static final int CENEXT

Constant Value: 30

public static final int CENFLG

Constant Value: 8

public static final int CENHDR

Constant Value: 46

public static final int CENHOW

Constant Value: 10

public static final int CENLEN

Constant Value: 24

public static final int CENNAM

Constant Value: 28

public static final int CENOFF

Constant Value: 42

public static final long CENSIG

Constant Value: 33639248

public static final int CENSIZ

Constant Value: 20

public static final int CENTIM

Constant Value: 12

public static final int CENVEM

Constant Value: 4

public static final int CENVER

Constant Value: 6

public static final int DEFLATED

Compression method for compressed (DEFLATED) entries.

Constant Value: 8

public static final int ENDCOM

Constant Value: 20

public static final int ENDHDR

Constant Value: 22

public static final int ENDOFF

Constant Value: 16

public static final long ENDSIG

Constant Value: 101010256

public static final int ENDSIZ

Constant Value: 12

public static final int ENDSUB

Constant Value: 8

public static final int ENDTOT

Constant Value: 10

public static final int EXTCRC

Constant Value: 4

public static final int EXTHDR

Constant Value: 16

public static final int EXTLEN

Constant Value: 12

public static final long EXTSIG

Constant Value: 134695760

public static final int EXTSIZ

Constant Value: 8

public static final int LOCCRC

Constant Value: 14

public static final int LOCEXT

Constant Value: 28

public static final int LOCFLG

Constant Value: 6

public static final int LOCHDR

Constant Value: 30

public static final int LOCHOW

Constant Value: 8

public static final int LOCLEN

Constant Value: 22

public static final int LOCNAM

Constant Value: 26

public static final long LOCSIG

Constant Value: 67324752

public static final int LOCSIZ

Constant Value: 18

public static final int LOCTIM

Constant Value: 10

public static final int LOCVER

Constant Value: 4

public static final int STORED

Compression method for uncompressed (STORED) entries.

Constant Value: 0

Public Constructors

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

public ZipOutputStream (OutputStream out, Charset charset)

Creates a new ZIP output stream.

Parameters

out	the actual output stream
charset	the {@linkplain java.nio.charset.Charset charset} to be used to encode the entry names and comments

Public Methods

public 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

public 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

public 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

public 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	the ZIP entry to be written

Throws

ZipException	if a ZIP format error has occurred
IOException	if an I/O error has occurred

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

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

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

public synchronized 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	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