net.java.truevfs.comp.zip

Class AbstractZipOutputStream<E extends ZipEntry>

java.lang.Object

java.io.OutputStream

net.java.truecommons.io.DecoratingOutputStream

net.java.truevfs.comp.zip.AbstractZipOutputStream<E>

Type Parameters:

E - the type of the ZIP entries.

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Iterable<E>

Direct Known Subclasses:

ZipOutputService, ZipOutputStream

@NotThreadSafe
public abstract class AbstractZipOutputStream<E extends ZipEntry>
extends net.java.truecommons.io.DecoratingOutputStream
implements Iterable<E>

Provides unsafe (raw) access to a ZIP file using shared ZipEntry instances.

Warning: This class is not intended for public use - its API may change at will without prior notification!

Author:

Christian Schlichtherle

See Also:

AbstractZipFile

Field Summary

Fields inherited from class net.java.truecommons.io.DecoratingOutputStream

out

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractZipOutputStream(net.java.truecommons.io.Sink sink, AbstractZipFile<E> appendee, ZipOutputStreamParameters param) Constructs a raw ZIP output stream which decorates the given output stream and optionally apppends to the given raw ZIP file.

Method Summary

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 to the underlying stream.
E	entry(String name) Returns the entry for the given name or null if no entry with this name exists in this ZIP file.
void	finish() Closes the current entry and writes the Central Directory to the underlying output stream.
String	getCharset() Returns the name of the character set which is used for encoding entry names and the file comment.
String	getComment() Returns the file comment.
protected abstract ZipCryptoParameters	getCryptoParameters() Returns the parameters for encryption or authentication of entries.
int	getLevel() Returns the compression level for entries.
int	getMethod() Returns the default compression method for subsequent entries.
Charset	getRawCharset() Returns the character set which is used for encoding entry names and the file comment.
boolean	isBusy() Returns true if and only if this AbstractZipOutputStream is currently writing a ZIP entry.
Iterator<E>	iterator() Returns an iteration of all entries written to this ZIP file so far.
long	length() Returns the total number of (compressed) bytes this stream has written to the underlying stream.
void	putNextEntry(E entry) Equivalent to putNextEntry(entry, true).
void	putNextEntry(E entry, boolean process) Starts writing the next ZIP entry to the underlying stream.
void	setComment(String comment) Sets the file comment.
void	setLevel(int level) Sets the compression level for entries.
void	setMethod(int method) Sets the default compression method for entries.
int	size() Returns the number of ZIP entries written so far.

Methods inherited from class net.java.truecommons.io.DecoratingOutputStream

flush, toString, write, write, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AbstractZipOutputStream

@CreatesObligation
protected AbstractZipOutputStream(net.java.truecommons.io.Sink sink,
                                                     @CheckForNull @WillNotClose
                                                     AbstractZipFile<E> appendee,
                                                     ZipOutputStreamParameters param)
                                              throws IOException

Constructs a raw ZIP output stream which decorates the given output stream and optionally apppends to the given raw ZIP file.

Parameters:

sink - the sink to write the ZIP file to. If appendee is not null, then this must be set up so that it appends to the same ZIP file from which appendee is reading.

appendee - the nullable raw ZIP file to append to. This may already be closed.

param - the parameters for writing the ZIP file.

Throws:

IOException

Method Detail

close

public void close()
           throws IOException

Closes this output stream and releases any system resources associated with the stream. This closes the open output stream writing to this ZIP file, if any.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class net.java.truecommons.io.DecoratingOutputStream

Throws:

IOException - On any I/O error.

closeEntry

public void closeEntry()
                throws IOException

Writes all necessary data for this entry to the underlying stream.

Throws:

ZipException - If and only if writing the entry is impossible because the resulting file would not comply to the ZIP file format specification.

IOException - On any I/O error.

entry

public E entry(String name)

Returns the entry for the given name or null if no entry with this name exists in this ZIP file. Note that the returned entry is shared with this instance - it is an error to change its state!

Parameters:

name - the name of the ZIP entry.

Returns:

The entry for the given name or null if no entry with this name exists in this ZIP file.

finish

public void finish()
            throws IOException

Closes the current entry and writes the Central Directory to the underlying output stream.

Notes:

• The underlying stream is not closed.
• Unlike Sun's implementation in J2SE 1.4.2, you may continue to use this ZIP output stream with putNextEntry(...) and the like. When you finally close the stream, the central directory will contain all entries written.

Throws:

ZipException - If and only if writing the entry is impossible because the resulting file would not comply to the ZIP file format specification.

IOException - On any I/O error.

getCharset

public String getCharset()

Returns the name of the character set which is used for encoding entry names and the file comment.

getComment

@Nullable
public String getComment()

Returns the file comment.

Returns:

The file comment.

getCryptoParameters

@CheckForNull
protected abstract ZipCryptoParameters getCryptoParameters()

Returns the parameters for encryption or authentication of entries. Returns The parameters for encryption or authentication of entries.

getLevel

public int getLevel()

Returns the compression level for entries. This property is only used if the effective compression method is ZipEntry.DEFLATED or ZipEntry.BZIP2.

Returns:

The compression level for entries.

See Also:

setLevel(int)

getMethod

public int getMethod()

Returns the default compression method for subsequent entries. This property is only used if a ZipEntry does not specify a compression method. The initial value is ZipEntry.DEFLATED.

See Also:

setMethod(int), ZipEntry.getMethod()

getRawCharset

public Charset getRawCharset()

Returns the character set which is used for encoding entry names and the file comment.

isBusy

public boolean isBusy()

Returns true if and only if this AbstractZipOutputStream is currently writing a ZIP entry.

iterator

public Iterator<E> iterator()

Returns an iteration of all entries written to this ZIP file so far. Note that the iterated entries are shared with this instance. It is illegal to put more entries into this ZIP output stream concurrently or modify the state of the iterated entries.

Specified by:

iterator in interface Iterable<E extends ZipEntry>

length

public long length()

Returns the total number of (compressed) bytes this stream has written to the underlying stream.

putNextEntry

public final void putNextEntry(E entry)
                        throws IOException

Equivalent to putNextEntry(entry, true).

Throws:

IOException

putNextEntry

public void putNextEntry(E entry,
                         boolean process)
                  throws ZipException,
                         IOException

Starts writing the next ZIP entry to the underlying stream. Note that if two or more entries with the same name are written consecutively to this stream, the last entry written will shadow all other entries, i.e. all of them are written to the ZIP file (and hence require space), but only the last will be listed in the central directory. This is unlike the genuine java.util.zip.ZipOutputStream which would throw a ZipException in this method when another entry with the same name is to be written.

Parameters:

entry - The entry to write.

process - Whether or not the entry contents should get processed, e.g. deflated. This should be set to false if and only if the application is going to copy entries from an input ZIP file to an output ZIP file. The entries' CRC-32, compressed size and uncompressed size properties must be set in advance.

Throws:

ZipException - If and only if writing the entry is impossible because the resulting file would not comply to the ZIP file format specification.

IOException - On any I/O error.

setComment

public void setComment(@CheckForNull
                       String comment)

Sets the file comment.

Parameters:

comment - the file comment.

Throws:

IllegalArgumentException - if the encoded comment is longer than UShort.MAX_VALUE bytes.

setLevel

public void setLevel(int level)

Sets the compression level for entries. This property is only used if the effective compression method is ZipEntry.DEFLATED or ZipEntry.BZIP2. Legal values are Deflater.DEFAULT_COMPRESSION or range from Deflater.NO_COMPRESSION to Deflater.BEST_COMPRESSION.

Parameters:

level - the compression level for entries.

Throws:

IllegalArgumentException - if the compression level is invalid.

See Also:

getLevel()

setMethod

public void setMethod(int method)

Sets the default compression method for entries. This property is only used if a ZipEntry does not specify a compression method. Legal values are ZipEntry.STORED, ZipEntry.DEFLATED and ZipEntry.BZIP2.

Parameters:

method - the default compression method for entries.

Throws:

IllegalArgumentException - if the method is invalid.

See Also:

getMethod(), ZipEntry.setMethod(int)

size

public int size()

Returns the number of ZIP entries written so far.