java.util.zip
Class ZipOutputStream

java.lang.Object
  java.io.OutputStream
      java.io.FilterOutputStream
          java.util.zip.DeflaterOutputStream
              java.util.zip.ZipOutputStream

Direct Known Subclasses:

JarOutputStream

public class ZipOutputStream
extends DeflaterOutputStream

ZipOuputStream is used to write ZipEntries to the underlying stream. Output from ZipOutputStream conforms to the ZipFile file format.

See Also:

ZipInputStream, ZipEntry

Field Summary

static int	CENATT
static int	CENATX
static int	CENCOM
static int	CENCRC
static int	CENDSK
static int	CENEXT
static int	CENFLG
static int	CENHDR
static int	CENHOW
static int	CENLEN
static int	CENNAM
static int	CENOFF
static long	CENSIG
static int	CENSIZ
static int	CENTIM
static int	CENVEM
static int	CENVER
static int	DEFLATED
static int	ENDCOM
static int	ENDHDR
static int	ENDOFF
static long	ENDSIG
static int	ENDSIZ
static int	ENDSUB
static int	ENDTOT
static int	EXTCRC
static int	EXTHDR
static int	EXTLEN
static long	EXTSIG
static int	EXTSIZ
static int	LOCCRC
static int	LOCEXT
static int	LOCFLG
static int	LOCHDR
static int	LOCHOW
static int	LOCLEN
static int	LOCNAM
static long	LOCSIG
static int	LOCSIZ
static int	LOCTIM
static int	LOCVER
static int	STORED

Fields inherited from class java.util.zip.DeflaterOutputStream

buf, def

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

ZipOutputStream(OutputStream p1)
Contructs a new ZipOutputStream on p1

Method Summary

void	close() Closes the current ZipEntry if any.
void	closeEntry() Closes the current ZipEntry.
void	finish() Indicates that all entries have been written to the stream.
void	putNextEntry(ZipEntry ze) Writes entry information for ze to the underlying stream.
void	setComment(String comment) Sets the ZipFile comment associated with the file being written.
void	setLevel(int level) Sets the compression level to be used for writing entry data.
void	setMethod(int method) Sets the compression method to be used when compressing entry data. method must be one of STORED or DEFLATED.
void	write(byte[] buf, int off, int nbytes) Writes data for the current entry to the underlying stream.

Methods inherited from class java.util.zip.DeflaterOutputStream

deflate, write

Methods inherited from class java.io.FilterOutputStream

flush, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFLATED

public static final int DEFLATED

See Also:

Constant Field Values

STORED

public static final int STORED

See Also:

Constant Field Values

LOCSIG

public static final long LOCSIG

See Also:

Constant Field Values

EXTSIG

public static final long EXTSIG

See Also:

Constant Field Values

CENSIG

public static final long CENSIG

See Also:

Constant Field Values

ENDSIG

public static final long ENDSIG

See Also:

Constant Field Values

LOCHDR

public static final int LOCHDR

See Also:

Constant Field Values

EXTHDR

public static final int EXTHDR

See Also:

Constant Field Values

CENHDR

public static final int CENHDR

See Also:

Constant Field Values

ENDHDR

public static final int ENDHDR

See Also:

Constant Field Values

LOCVER

public static final int LOCVER

See Also:

Constant Field Values

LOCFLG

public static final int LOCFLG

See Also:

Constant Field Values

LOCHOW

public static final int LOCHOW

See Also:

Constant Field Values

LOCTIM

public static final int LOCTIM

See Also:

Constant Field Values

LOCCRC

public static final int LOCCRC

See Also:

Constant Field Values

LOCSIZ

public static final int LOCSIZ

See Also:

Constant Field Values

LOCLEN

public static final int LOCLEN

See Also:

Constant Field Values

LOCNAM

public static final int LOCNAM

See Also:

Constant Field Values

LOCEXT

public static final int LOCEXT

See Also:

Constant Field Values

EXTCRC

public static final int EXTCRC

See Also:

Constant Field Values

EXTSIZ

public static final int EXTSIZ

See Also:

Constant Field Values

EXTLEN

public static final int EXTLEN

See Also:

Constant Field Values

CENVEM

public static final int CENVEM

See Also:

Constant Field Values

CENVER

public static final int CENVER

See Also:

Constant Field Values

CENFLG

public static final int CENFLG

See Also:

Constant Field Values

CENHOW

public static final int CENHOW

See Also:

Constant Field Values

CENTIM

public static final int CENTIM

See Also:

Constant Field Values

CENCRC

public static final int CENCRC

See Also:

Constant Field Values

CENSIZ

public static final int CENSIZ

See Also:

Constant Field Values

CENLEN

public static final int CENLEN

See Also:

Constant Field Values

CENNAM

public static final int CENNAM

See Also:

Constant Field Values

CENEXT

public static final int CENEXT

See Also:

Constant Field Values

CENCOM

public static final int CENCOM

See Also:

Constant Field Values

CENDSK

public static final int CENDSK

See Also:

Constant Field Values

CENATT

public static final int CENATT

See Also:

Constant Field Values

CENATX

public static final int CENATX

See Also:

Constant Field Values

CENOFF

public static final int CENOFF

See Also:

Constant Field Values

ENDSUB

public static final int ENDSUB

See Also:

Constant Field Values

ENDTOT

public static final int ENDTOT

See Also:

Constant Field Values

ENDSIZ

public static final int ENDSIZ

See Also:

Constant Field Values

ENDOFF

public static final int ENDOFF

See Also:

Constant Field Values

ENDCOM

public static final int ENDCOM

See Also:

Constant Field Values

Constructor Detail

ZipOutputStream

public ZipOutputStream(OutputStream p1)

Contructs a new ZipOutputStream on p1

Parameters:

p1 - OutputStream The InputStream to output to

Method Detail

close

public void close()
           throws IOException

Closes the current ZipEntry if any. Closes the underlying output stream.

Overrides:

close in class DeflaterOutputStream

Throws:

IOException - If an error occurs closing the stream

closeEntry

public void closeEntry()
                throws IOException

Closes the current ZipEntry. Any entry terminal data is written to the underlying stream.

Throws:

IOException - If an error occurs closing the entry

finish

public void finish()
            throws IOException

Indicates that all entries have been written to the stream. Any terminal Zipfile information is written to the underlying stream.

Overrides:

finish in class DeflaterOutputStream

Throws:

IOException - If an error occurs while finishing

putNextEntry

public void putNextEntry(ZipEntry ze)
                  throws IOException

Writes entry information for ze to the underlying stream. Data associated with the entry can then be written using write(). After data is written closeEntry() must be called to complete the storing of ze on the underlying stream.

Parameters:

ze - ZipEntry to store

Throws:

IOException - If an error occurs storing the entry

See Also:

write(byte[], int, int)

setComment

public void setComment(String comment)

Sets the ZipFile comment associated with the file being written.

setLevel

public void setLevel(int level)

Sets the compression level to be used for writing entry data. This level may be set on a per entry basis. level must have a value between 0 and 10.

setMethod

public void setMethod(int method)

Sets the compression method to be used when compressing entry data. method must be one of STORED or DEFLATED.

Parameters:

method - Compression method to use

write

public void write(byte[] buf,
                  int off,
                  int nbytes)
           throws IOException

Writes data for the current entry to the underlying stream.

Overrides:

write in class DeflaterOutputStream

Parameters:

buf - Buffer of data to compress

off - offset in buffer to extract data from

nbytes - Number of bytes of data to compress and write

Throws:

IOException - If an error occurs writing to the stream