org.codehaus.plexus.archiver.zip

Class ZipOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.codehaus.plexus.archiver.zip.ZipOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class ZipOutputStream
extends FilterOutputStream

Reimplementation of java.util.zip.ZipOutputStream that does handle the extended functionality of this package, especially internal/external file attributes and extra fields with different layouts for local file data and central directory entries.

This class will try to use RandomAccessFile when you know that the output is going to go to a file.

If RandomAccessFile cannot be used, this implementation will use a Data Descriptor to store size and CRC information for DEFLATED entries, this means, you don't need to calculate them yourself. Unfortunately this is not possible for the STORED method, here setting the CRC and uncompressed size information is required before putNextEntry can be called.

Version:

$Revision$ $Date$ from org.apache.ant.tools.zip.ZipOutputStream v1.24

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	buf This buffer servers as a Deflater.
protected static ZipLong	CFH_SIG central file header signature
protected static ZipLong	DD_SIG data descriptor signature
protected Deflater	def This Deflater object is used for output.
static int	DEFLATED Compression method for deflated entries.
protected static ZipLong	EOCD_SIG end of central dir signature
protected static ZipLong	LFH_SIG local file header signature
static int	STORED Compression method for deflated entries.

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
ZipOutputStream(File file) Creates a new ZIP OutputStream writing to a File.
ZipOutputStream(OutputStream out) Creates a new ZIP OutputStream filtering the underlying stream.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this output stream and releases any system resources associated with the stream.
void	closeEntry() Writes all necessary data for this entry.
protected void	deflate() Writes next block of compressed data to the output stream.
void	finish() Finishs writing the contents and closes this as well as the underlying stream.
void	flush() Flushes this output stream and forces any buffered output bytes to be written out to the stream.
protected byte[]	getBytes(String name) Retrieve the bytes for the given String in the encoding set for this Stream.
String	getEncoding() The encoding to use for filenames and the file comment.
boolean	isSeekable() This method indicates whether this archive is writing to a seekable stream (i.e., to a random access file).
void	putNextEntry(ZipEntry ze) Begin writing next entry.
void	setComment(String comment) Set the file comment.
void	setEncoding(String encoding) The encoding to use for filenames and the file comment.
void	setLevel(int level) Sets the compression level for subsequent entries.
void	setMethod(int method) Sets the default compression method for subsequent entries.
protected static ZipLong	toDosTime(Date time) Convert a Date object to a DOS date/time field.
void	write(byte[] b, int offset, int length) Writes bytes to ZIP entry.
void	write(int b) Writes a single byte to ZIP entry.
protected void	writeCentralDirectoryEnd() Writes the "End of central dir record"
protected void	writeCentralFileHeader(ZipEntry ze) Writes the central file header entry
protected void	writeDataDescriptor(ZipEntry ze) Writes the data descriptor entry
protected void	writeLocalFileHeader(ZipEntry ze) Writes the local file header entry
protected void	writeOut(byte[] data) Write bytes to output or random access file
protected void	writeOut(byte[] data, int offset, int length) Write bytes to output or random access file

Methods inherited from class java.io.FilterOutputStream

write

Methods inherited from class java.lang.Object

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

Field Detail

def

protected Deflater def

This Deflater object is used for output.

This attribute is only protected to provide a level of API backwards compatibility. This class used to extend DeflaterOutputStream up to Revision 1.13.

Since:

1.14

buf

protected byte[] buf

This buffer servers as a Deflater.

This attribute is only protected to provide a level of API backwards compatibility. This class used to extend DeflaterOutputStream up to Revision 1.13.

Since:

1.14

DEFLATED

public static final int DEFLATED

Compression method for deflated entries.

Since:

1.1

See Also:

Constant Field Values

STORED

public static final int STORED

Compression method for deflated entries.

Since:

1.1

See Also:

Constant Field Values

LFH_SIG

protected static final ZipLong LFH_SIG

local file header signature

Since:

1.1

DD_SIG

protected static final ZipLong DD_SIG

data descriptor signature

Since:

1.1

CFH_SIG

protected static final ZipLong CFH_SIG

central file header signature

Since:

1.1

EOCD_SIG

protected static final ZipLong EOCD_SIG

end of central dir signature

Since:

1.1

Constructor Detail

ZipOutputStream

public ZipOutputStream(OutputStream out)

Creates a new ZIP OutputStream filtering the underlying stream.

Since:

1.1

ZipOutputStream

public ZipOutputStream(File file)
                throws IOException

Creates a new ZIP OutputStream writing to a File. Will use random access if possible.

Throws:

IOException

Since:

1.14

Method Detail

isSeekable

public boolean isSeekable()

This method indicates whether this archive is writing to a seekable stream (i.e., to a random access file).

For seekable streams, you don't need to calculate the CRC or uncompressed size for STORED entries before invoking putNextEntry(org.codehaus.plexus.archiver.zip.ZipEntry).

Since:

1.17

setEncoding

public void setEncoding(String encoding)

The encoding to use for filenames and the file comment.

For a list of possible values see http://java.sun.com/products/jdk/1.2/docs/guide/internat/encoding.doc.html. Defaults to the platform's default character encoding.

Since:

1.3

getEncoding

public String getEncoding()

The encoding to use for filenames and the file comment.

Returns:

null if using the platform's default character encoding.

Since:

1.3

finish

public void finish()
            throws IOException

Finishs writing the contents and closes this as well as the underlying stream.

Throws:

IOException

Since:

1.1

closeEntry

public void closeEntry()
                throws IOException

Writes all necessary data for this entry.

Throws:

IOException

Since:

1.1

putNextEntry

public void putNextEntry(ZipEntry ze)
                  throws IOException

Begin writing next entry.

Throws:

IOException

Since:

1.1

setComment

public void setComment(String comment)

Set the file comment.

Since:

1.1

setLevel

public void setLevel(int level)

Sets the compression level for subsequent entries.

Default is Deflater.DEFAULT_COMPRESSION.

Since:

1.1

setMethod

public void setMethod(int method)

Sets the default compression method for subsequent entries.

Default is DEFLATED.

Since:

1.1

write

public void write(byte[] b,
         int offset,
         int length)
           throws IOException

Writes bytes to ZIP entry.

Overrides:

write in class FilterOutputStream

Throws:

IOException

write

public void write(int b)
           throws IOException

Writes a single byte to ZIP entry.

Delegates to the three arg method.

Overrides:

write in class FilterOutputStream

Throws:

IOException

Since:

1.14

close

public void close()
           throws IOException

Closes this output stream and releases any system resources associated with the stream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FilterOutputStream

Throws:

IOException - if an I/O error occurs.

Since:

1.14

flush

public void flush()
           throws IOException

Flushes this output stream and forces any buffered output bytes to be written out to the stream.

Specified by:

flush in interface Flushable

Overrides:

flush in class FilterOutputStream

Throws:

IOException - if an I/O error occurs.

Since:

1.14

deflate

protected final void deflate()
                      throws IOException

Writes next block of compressed data to the output stream.

Throws:

IOException

Since:

1.14

writeLocalFileHeader

protected void writeLocalFileHeader(ZipEntry ze)
                             throws IOException

Writes the local file header entry

Throws:

IOException

Since:

1.1

writeDataDescriptor

protected void writeDataDescriptor(ZipEntry ze)
                            throws IOException

Writes the data descriptor entry

Throws:

IOException

Since:

1.1

writeCentralFileHeader

protected void writeCentralFileHeader(ZipEntry ze)
                               throws IOException

Writes the central file header entry

Throws:

IOException

Since:

1.1

writeCentralDirectoryEnd

protected void writeCentralDirectoryEnd()
                                 throws IOException

Writes the "End of central dir record"

Throws:

IOException

Since:

1.1

toDosTime

protected static ZipLong toDosTime(Date time)

Convert a Date object to a DOS date/time field.

Stolen from InfoZip's fileio.c

Since:

1.1

getBytes

protected byte[] getBytes(String name)
                   throws ZipException

Retrieve the bytes for the given String in the encoding set for this Stream.

Throws:

ZipException

Since:

1.3

writeOut

protected final void writeOut(byte[] data)
                       throws IOException

Write bytes to output or random access file

Throws:

IOException

Since:

1.14

writeOut

protected final void writeOut(byte[] data,
            int offset,
            int length)
                       throws IOException

Write bytes to output or random access file

Throws:

IOException

Since:

1.14