net.sf.zipme
Class ZipOutputStream

java.lang.Object
  java.io.OutputStream
      net.sf.zipme.DeflaterOutputStream
          net.sf.zipme.ZipOutputStream

All Implemented Interfaces:

net.sf.zipme.ZipConstants

public class ZipOutputStream

extends DeflaterOutputStream

implements net.sf.zipme.ZipConstants

This is a FilterOutputStream that writes the files into a zip archive one after another. It has a special method to start a new zip entry. The zip entries contains information about the file name size, compressed size, CRC, etc. It includes support for STORED and DEFLATED entries. This class is not thread safe.

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 Compression method.
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 Compression method.

Fields inherited from class net.sf.zipme.DeflaterOutputStream

buf, def, out

Constructor Summary

ZipOutputStream(java.io.OutputStream out)
Creates a new Zip output stream, writing a zip archive.

Method Summary

void	closeEntry() Closes the current entry.
void	finish() Finishes the stream.
void	putNextEntry(ZipEntry entry) Starts a new Zip entry.
void	setComment(java.lang.String comment) Set the zip file comment.
void	setLevel(int level) Sets default compression level.
void	setMethod(int method) Sets default compression method.
void	write(byte[] b, int off, int len) Writes the given buffer to the current entry.

Methods inherited from class net.sf.zipme.DeflaterOutputStream

close, deflate, flush, write, write

Methods inherited from class java.lang.Object

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

Field Detail

STORED

public static final int STORED

Compression method. This method doesn't compress at all.

See Also:

Constant Field Values

DEFLATED

public static final int DEFLATED

Compression method. This method uses the Deflater.

See Also:

Constant Field Values

LOCHDR

public static final int LOCHDR

See Also:

Constant Field Values

LOCSIG

public static final long LOCSIG

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

EXTSIG

public static final long EXTSIG

See Also:

Constant Field Values

EXTHDR

public static final int EXTHDR

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

CENSIG

public static final long CENSIG

See Also:

Constant Field Values

CENHDR

public static final int CENHDR

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

ENDSIG

public static final long ENDSIG

See Also:

Constant Field Values

ENDHDR

public static final int ENDHDR

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(java.io.OutputStream out)

Creates a new Zip output stream, writing a zip archive.

Parameters:

out - the output stream to which the zip archive is written.

Method Detail

setComment

public void setComment(java.lang.String comment)

Set the zip file comment.

Parameters:

comment - the comment.

Throws:

java.lang.IllegalArgumentException - if encoding of comment is longer than 0xffff bytes.

setMethod

public void setMethod(int method)

Sets default compression method. If the Zip entry specifies another method its method takes precedence.

Parameters:

method - the method.

Throws:

java.lang.IllegalArgumentException - if method is not supported.

See Also:

STORED, DEFLATED

setLevel

public void setLevel(int level)

Sets default compression level. The new level will be activated immediately.

Throws:

java.lang.IllegalArgumentException - if level is not supported.

See Also:

Deflater

putNextEntry

public void putNextEntry(ZipEntry entry)
                  throws java.io.IOException

Starts a new Zip entry. It automatically closes the previous entry if present. If the compression method is stored, the entry must have a valid size and crc, otherwise all elements (except name) are optional, but must be correct if present. If the time is not set in the entry, the current time is used.

Parameters:

entry - the entry.

Throws:

java.io.IOException - if an I/O error occured.

ZipException - if stream was finished.

closeEntry

public void closeEntry()
                throws java.io.IOException

Closes the current entry.

Throws:

java.io.IOException - if an I/O error occured.

ZipException - if no entry is active.

write

public void write(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException

Writes the given buffer to the current entry.

Overrides:

write in class DeflaterOutputStream

Parameters:

b - the byte array.

off - the offset into the byte array where to start.

len - the number of bytes to write.

Throws:

java.io.IOException - if an I/O error occured.

ZipException - if no entry is active.

finish

public void finish()
            throws java.io.IOException

Finishes the stream. This will write the central directory at the end of the zip file and flush the stream.

Overrides:

finish in class DeflaterOutputStream

Throws:

java.io.IOException - if an I/O error occured.