ZipOutputStream (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.util.zip
class ZipOutputStream

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

All Implemented Interfaces:: Closeable, Flushable, ZipConstants

Direct Known Subclasses:: JarOutputStream

Most common way to construct:

FileOutputStream fos = …;

ZipOutputStream zos = new ZipOutputStream(fos);

Based on 45 examples

public class ZipOutputStream
extends DeflaterOutputStream
implements ZipConstants

This class implements an output stream filter for writing files in the ZIP file format. Includes support for both compressed and uncompressed entries.

Field Summary
`static int`	`DEFLATED` Compression method for compressed (DEFLATED) entries.
`static int`	`STORED` 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
`ZipOutputStream(OutputStream out)` Creates a new ZIP output stream.

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.
`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
`close, deflate, finish, write, write`

Methods inherited from class java.io.FilterOutputStream
`close, flush, write, write, write`

Methods inherited from class java.io.OutputStream
`close, flush, write, write, 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

Compression method for compressed (DEFLATED) entries.

STORED

public static final int STORED

Compression method for uncompressed (STORED) entries.

Constructor Detail

ZipOutputStream

public ZipOutputStream(OutputStream out)

Creates a new ZIP output stream.

Parameters:: out - the actual output stream

Method Detail

close

public void close()
           throws IOException

Closes the ZIP output stream as well as the stream being filtered.

Overrides:: close in class DeflaterOutputStream
Throws:: 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:: IOException - if an I/O error has occurred

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 class DeflaterOutputStream
Throws:: IOException - if an I/O exception has occurred

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:: IOException - if an I/O error has occurred

setComment

public void setComment(String comment)

Sets the ZIP file comment.

Parameters:: comment - the comment string

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)

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

write

public synchronized 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 class DeflaterOutputStream
Parameters:: b - the data to be written; off - the start offset in the data; len - the number of bytes that are written
Throws:: IOException - if an I/O error has occurred