net.java.truevfs.driver.odf

Class OdfDriver

java.lang.Object

net.java.truecommons.shed.UniqueObject

net.java.truevfs.kernel.spec.FsDriver

net.java.truevfs.kernel.spec.FsArchiveDriver<E>

net.java.truevfs.comp.zipdriver.AbstractZipDriver<JarDriverEntry>

net.java.truevfs.comp.zipdriver.JarDriver

net.java.truevfs.driver.odf.OdfDriver

All Implemented Interfaces:

ZipCharsetParameters, ZipEntryFactory<JarDriverEntry>, ZipFileParameters<JarDriverEntry>, ZipOutputStreamParameters, ZipParameters, FsController.Factory<FsManager>, FsModel.Factory<FsManager>

Direct Known Subclasses:

CheckedOdfDriver

@Immutable
public class OdfDriver
extends JarDriver

An archive driver for application archive files according to the Open Document Format (ODF) Specification, V1.0 and later. This driver simply ensures that an entry named mimetype, if present at all, is always written as the very first entry using the method STORED rather than DEFLATED in the resulting archive file in order to meet the requirements of the ODF Specification. Other than this, ODF files are treated like regular JAR files. In particular, this class does not check an ODF file for the existence of the META-INF/manifest.xml entry or any other entry.

When using this driver to create or modify an ODF file, then in order to achieve best performance, the mimetype entry should always get written first in order to avoid temp file buffering of all other entries.

Subclasses must be thread-safe and should be immutable!

Author:

Christian Schlichtherle

See Also:

Open Document Format for Office Applications (OpenDocument) v1.0; Section 17.4: MIME Type Stream, Open Document Format for Office Applications (OpenDocument) v1.1; Section 17.4: MIME Type Stream, Open Document Format for Office Applications (OpenDocument) Version 1.2; Part 3: Packages; Section 3.3: MIME Type Stream, OdfOutputService

Field Summary

Fields inherited from class net.java.truevfs.comp.zipdriver.JarDriver

JAR_CHARSET

Constructor Summary

Constructors

Constructor and Description
OdfDriver()

Method Summary

Modifier and Type	Method and Description
protected net.java.truecommons.cio.OutputService<JarDriverEntry>	newOutput(FsModel model, FsOutputSocketSink sink, net.java.truecommons.cio.InputService<JarDriverEntry> input) Creates a new input service for writing archive entries for the given model to the target archive file referenced by sink.

Methods inherited from class net.java.truevfs.comp.zipdriver.JarDriver

getCharset, newEntry, newEntry

Methods inherited from class net.java.truevfs.comp.zipdriver.AbstractZipDriver

check, decorate, fileSystemUri, getKeyManagerMap, getLevel, getMethod, getOverheadSize, getPool, getPostambled, getPreambled, getRedundantContentSupport, getRedundantMetaDataSupport, mountPointUri, newEntry, newInput, newZipInput, rdc, sink, zipCryptoParameters

Methods inherited from class net.java.truevfs.kernel.spec.FsArchiveDriver

checkEncodable, isArchiveDriver, newController, newEntry, newInput, newOutput, normalize, source, toString

Methods inherited from class net.java.truevfs.kernel.spec.FsDriver

decorate, newModel

Methods inherited from class net.java.truecommons.shed.UniqueObject

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OdfDriver

public OdfDriver()

Method Detail

newOutput

protected net.java.truecommons.cio.OutputService<JarDriverEntry> newOutput(FsModel model,
                                                                           FsOutputSocketSink sink,
                                                                           @CheckForNull @WillNotClose
                                                                           net.java.truecommons.cio.InputService<JarDriverEntry> input)
                                                                    throws IOException

Description copied from class: FsArchiveDriver

Creates a new input service for writing archive entries for the given model to the target archive file referenced by sink.

Overrides:

newOutput in class AbstractZipDriver<JarDriverEntry>

Parameters:

model - the file system model.

sink - the sink for writing the target archive file.

input - the nullable InputService for the target archive file. If not null, then the target archive file is going to get updated. This parameter is guaranteed to be the product of this driver's factory method FsArchiveDriver.newInput(FsModel, BitField, FsController, FsNodeName).

Returns:

A new output service for writing the target archive file. Note that this service does not need to be thread-safe!

Throws:

IOException - on any I/O error.

See Also:

FsArchiveDriver.newOutput(FsModel, BitField, FsController, FsNodeName, InputService)