net.java.truevfs.comp.zipdriver

Class ZipOutputService<E extends AbstractZipDriverEntry>

java.lang.Object

java.io.OutputStream

net.java.truecommons.io.DecoratingOutputStream

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

net.java.truevfs.comp.zipdriver.ZipOutputService<E>

Type Parameters:

E - the type of the ZIP driver entries.

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Iterable<E>, net.java.truecommons.cio.Container<E>, net.java.truecommons.cio.OutputService<E>, net.java.truecommons.shed.Stream<E>

@NotThreadSafe
public final class ZipOutputService<E extends AbstractZipDriverEntry>
extends AbstractZipOutputStream<E>
implements net.java.truecommons.cio.OutputService<E>

An output service for writing ZIP files. This output service can only write one entry concurrently.

Author:

Christian Schlichtherle

See Also:

ZipInputService

Field Summary

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

out

Constructor Summary

Constructors

Constructor and Description
ZipOutputService(FsModel model, FsOutputSocketSink sink, ZipInputService<E> source, AbstractZipDriver<E> driver)

Method Summary

Modifier and Type	Method and Description
void	close() Retains the postamble of the source source ZIP file, if any.
E	entry(String name) Returns the entry for the given name or null if no entry with this name exists in this ZIP file.
protected ZipCryptoParameters	getCryptoParameters() Returns the parameters for encryption or authentication of entries.
FsModel	getModel() Returns the file system model provided to the constructor.
boolean	isBusy() Returns whether this ZIP output service is busy writing an archive entry or not.
Iterator<E>	iterator() Returns an iteration of all entries written to this ZIP file so far.
net.java.truecommons.cio.OutputSocket<E>	output(E local)
int	size() Returns the number of ZIP entries written so far.

Methods inherited from class net.java.truevfs.comp.zip.AbstractZipOutputStream

closeEntry, finish, getCharset, getComment, getLevel, getMethod, getRawCharset, length, putNextEntry, putNextEntry, setComment, setLevel, setMethod

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

ZipOutputService

@CreatesObligation
public ZipOutputService(FsModel model,
                                           FsOutputSocketSink sink,
                                           @CheckForNull @WillNotClose
                                           ZipInputService<E> source,
                                           AbstractZipDriver<E> driver)
                                    throws IOException

Throws:

IOException

Method Detail

close

public void close()
           throws IOException

Retains the postamble of the source source ZIP file, if any.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface net.java.truecommons.shed.Stream<E extends AbstractZipDriverEntry>

Overrides:

close in class AbstractZipOutputStream<E extends AbstractZipDriverEntry>

Throws:

IOException - On any I/O error.

entry

@CheckForNull
public E entry(String name)

Description copied from class: AbstractZipOutputStream

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!

Specified by:

entry in interface net.java.truecommons.cio.Container<E extends AbstractZipDriverEntry>

Overrides:

entry in class AbstractZipOutputStream<E extends AbstractZipDriverEntry>

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.

getCryptoParameters

protected ZipCryptoParameters getCryptoParameters()

Description copied from class: AbstractZipOutputStream

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

Specified by:

getCryptoParameters in class AbstractZipOutputStream<E extends AbstractZipDriverEntry>

getModel

public FsModel getModel()

Returns the file system model provided to the constructor.

Returns:

The file system model provided to the constructor.

isBusy

public boolean isBusy()

Returns whether this ZIP output service is busy writing an archive entry or not.

Overrides:

isBusy in class AbstractZipOutputStream<E extends AbstractZipDriverEntry>

Returns:

Whether this ZIP output service is busy writing an archive entry or not.

iterator

public Iterator<E> iterator()

Description copied from class: AbstractZipOutputStream

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 AbstractZipDriverEntry>

Specified by:

iterator in interface net.java.truecommons.cio.Container<E extends AbstractZipDriverEntry>

Overrides:

iterator in class AbstractZipOutputStream<E extends AbstractZipDriverEntry>

output

public net.java.truecommons.cio.OutputSocket<E> output(E local)

Specified by:

output in interface net.java.truecommons.cio.OutputService<E extends AbstractZipDriverEntry>

size

public int size()

Description copied from class: AbstractZipOutputStream

Returns the number of ZIP entries written so far.

Specified by:

size in interface net.java.truecommons.cio.Container<E extends AbstractZipDriverEntry>

Overrides:

size in class AbstractZipOutputStream<E extends AbstractZipDriverEntry>