net.java.truevfs.comp.zipdriver

Class JarDriver

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CheckedJarDriver, OdfDriver, ZipRaesDriver

@Immutable
public class JarDriver
extends AbstractZipDriver<JarDriverEntry>

An archive driver for Java Archive files (JAR). JAR files use the UTF-8 character set for the encoding of entry names and comments. They also apply the date/time conversion rules according to DateTimeConverter.JAR. This configuration makes this driver applicable for all countries. However, it pretty much constrains the interoperability of this driver to Java applications and Info-ZIP. Therefore, while you should not use this driver to access plain old ZIP files, you should definitely use it for custom application file formats

Other than this, JAR files are treated like plain old ZIP files. In particular, this class does not check or ensure a certain directory structure or the existance of certain entries (e.g. META-INF/MANIFEST.MF) within a JAR file.

This driver does not check the CRC value of any entries in existing archives - use CheckedJarDriver instead.

Sub-classes must be thread-safe and should be immutable!

Author:

Christian Schlichtherle

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	JAR_CHARSET The character set for entry names and comments in JAR files, which is "UTF-8".

Constructor Summary

Constructors

Constructor and Description
JarDriver()

Method Summary

Modifier and Type	Method and Description
Charset	getCharset() Returns the character set to use for encoding character based meta data such as entry names or file comments to binary data when writing an archive file.
JarDriverEntry	newEntry(String name) Returns a new ZIP driver entry with the given name.
JarDriverEntry	newEntry(String name, ZipEntry template) Returns a new ZIP driver entry with the given name and all other properties copied from the given template.

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, newOutput, 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

Field Detail

JAR_CHARSET

public static final Charset JAR_CHARSET

The character set for entry names and comments in JAR files, which is "UTF-8".

Constructor Detail

JarDriver

public JarDriver()

Method Detail

getCharset

public Charset getCharset()

Returns the character set to use for encoding character based meta data such as entry names or file comments to binary data when writing an archive file. Depending on the archive file format, this may get used for decoding binary data when reading an archive file, too.

This is an immutable property - multiple calls must return the same object.

Specified by:

getCharset in interface ZipCharsetParameters

Specified by:

getCharset in class FsArchiveDriver<JarDriverEntry>

Returns:

JAR_CHARSET.

newEntry

public JarDriverEntry newEntry(String name)

Description copied from class: AbstractZipDriver

Returns a new ZIP driver entry with the given name.

Specified by:

newEntry in interface ZipEntryFactory<JarDriverEntry>

Specified by:

newEntry in class AbstractZipDriver<JarDriverEntry>

Parameters:

name - the entry name.

Returns:

A new abstract ZIP driver entry.

newEntry

public JarDriverEntry newEntry(String name,
                               ZipEntry template)

Description copied from class: AbstractZipDriver

Returns a new ZIP driver entry with the given name and all other properties copied from the given template.

Specified by:

newEntry in class AbstractZipDriver<JarDriverEntry>

Parameters:

name - the entry name.

template - the template entry.

Returns:

A new ZIP driver entry.