proguard.io

Class ZipOutput

java.lang.Object

proguard.io.ZipOutput

public class ZipOutput
extends Object

This class writes zip data to a given output stream. It returns a new output stream for each zip entry that is opened. An entry can be compressed or uncompressed. Uncompressed entries can be aligned to a multiple of a given number of bytes. Multiple entries and output streams can be open at the same time. The entries are added to the central directory in the order in which they are opened, but the corresponding data are only written when their output streams are closed. The code automatically computes the CRC and lengths of the data, for compressed and uncompressed data.

Author:

Eric Lafortune

Constructor Summary

Constructors

Constructor and Description
ZipOutput(OutputStream outputStream) Creates a new ZipOutput.
ZipOutput(OutputStream outputStream, byte[] header, String comment, int uncompressedAlignment) Creates a new ZipOutput that aligns uncompressed entries.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the zip archive, also closing the underlying output stream.
OutputStream	createOutputStream(String name, boolean compress, int modificationTime) Creates a new zip entry, returning an output stream to write its data.
OutputStream	createOutputStream(String name, boolean compress, int modificationTime, byte[] extraField, String comment) Creates a new zip entry, returning an output stream to write its data.
static void	main(String[] args) Provides a simple test for this class, creating a zip file with the given name and a few aligned/compressed/uncompressed zip entries.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipOutput

public ZipOutput(OutputStream outputStream)
          throws IOException

Creates a new ZipOutput.

Parameters:

outputStream - the output stream to which the zip data will be written.

Throws:

IOException

ZipOutput

public ZipOutput(OutputStream outputStream,
                 byte[] header,
                 String comment,
                 int uncompressedAlignment)
          throws IOException

Creates a new ZipOutput that aligns uncompressed entries.

Parameters:

outputStream - the output stream to which the zip data will be written.

header - an optional header for the jar file.

comment - optional comment for the entire zip file.

uncompressedAlignment - the requested alignment of uncompressed data.

Throws:

IOException

Method Detail

createOutputStream

public OutputStream createOutputStream(String name,
                                       boolean compress,
                                       int modificationTime)
                                throws IOException

Creates a new zip entry, returning an output stream to write its data. It is the caller's responsibility to close the output stream.

Parameters:

name - the name of the zip entry.

compress - specifies whether the entry should be compressed.

modificationTime - the modification date and time of the zip entry, in DOS format.

Returns:

an output stream for writing the data of the zip entry.

Throws:

IOException

createOutputStream

public OutputStream createOutputStream(String name,
                                       boolean compress,
                                       int modificationTime,
                                       byte[] extraField,
                                       String comment)
                                throws IOException

Creates a new zip entry, returning an output stream to write its data. It is the caller's responsibility to close the output stream.

Parameters:

name - the name of the zip entry.

compress - specifies whether the entry should be compressed.

modificationTime - the modification date and time of the zip entry, in DOS format.

extraField - optional extra field data. These should contain chunks, each with a short ID, a short length (little endian), and their corresponding data. The IDs 0-31 are reserved for Pkware. Java's jar tool just specifies an ID 0xcafe on its first entry.

comment - optional comment.

Returns:

an output stream for writing the data of the zip entry.

Throws:

IOException

close

public void close()
           throws IOException

Closes the zip archive, also closing the underlying output stream.

Throws:

IOException

main

public static void main(String[] args)

Provides a simple test for this class, creating a zip file with the given name and a few aligned/compressed/uncompressed zip entries.