net.java.truevfs.comp.zipdriver

Class ZipDriver

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

net.java.truevfs.comp.zipdriver.ZipDriver

All Implemented Interfaces:

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

Direct Known Subclasses:

CheckedZipDriver, ReadOnlySfxDriver

@Immutable
public class ZipDriver
extends AbstractZipDriver<ZipDriverEntry>

An archive driver for ZIP files. By default, ZIP files use the IBM437 character set for the encoding of entry names and comments (unless the General Purpose Bit 11 is present in accordance with appendix D of the ZIP File Format Specification). They also apply the date/time conversion rules according to DateTimeConverter.ZIP. This configuration pretty much constrains the applicability of this driver to North American and Western European countries. However, this driver generally provides best interoperability with third party tools like the Windows Explorer, WinZip, 7-Zip etc. To some extent this applies even outside these countries. Therefore, while you should use this driver to access plain old ZIP files, you should not use it for custom application file formats - use the JarDriver instead in this case.

This driver does not check the CRC value of any entries in existing archives - use CheckedZipDriver 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	ZIP_CHARSET The character set for entry names and comments in "traditional" ZIP files, which is "IBM437".

Constructor Summary

Constructors

Constructor and Description
ZipDriver()

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.
ZipDriverEntry	newEntry(String name) Returns a new ZIP driver entry with the given name.
ZipDriverEntry	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

ZIP_CHARSET

public static final Charset ZIP_CHARSET

The character set for entry names and comments in "traditional" ZIP files, which is "IBM437".

Constructor Detail

ZipDriver

public ZipDriver()

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

Returns:

ZIP_CHARSET.

newEntry

public ZipDriverEntry newEntry(String name)

Description copied from class: AbstractZipDriver

Returns a new ZIP driver entry with the given name.

Specified by:

newEntry in interface ZipEntryFactory<ZipDriverEntry>

Specified by:

newEntry in class AbstractZipDriver<ZipDriverEntry>

Parameters:

name - the entry name.

Returns:

A new abstract ZIP driver entry.

newEntry

public ZipDriverEntry 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<ZipDriverEntry>

Parameters:

name - the entry name.

template - the template entry.

Returns:

A new ZIP driver entry.