ZipDriver (TrueZIP Driver ZIP 7.3-rc-1 API)

java.lang.Object
- de.schlichtherle.truezip.fs.FsDriver
- - de.schlichtherle.truezip.fs.archive.FsArchiveDriver<E>
  - - de.schlichtherle.truezip.fs.archive.FsCharsetArchiveDriver<ZipArchiveEntry>
    - - de.schlichtherle.truezip.fs.archive.zip.ZipDriver

All Implemented Interfaces:

ZipEntryFactory<ZipArchiveEntry>

Direct Known Subclasses:

CheckedZipDriver, JarDriver, ReadOnlySfxDriver
```
@Immutable
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public class ZipDriver
extends FsCharsetArchiveDriver<ZipArchiveEntry>
implements ZipEntryFactory<ZipArchiveEntry>
```
An archive driver which builds ZIP files. Do not use this driver for custom application file formats - use JarDriver instead!
This driver does not check the CRC value of any entries in existing archives - use CheckedZipDriver instead!

Author:

Christian Schlichtherle

See Also:
CheckedZipDriver

Field Summary

Fields
Modifier and Type	Field and Description
`private IOPoolProvider`	`provider`
`private static Charset`	`ZIP_CHARSET` The default character set for entry names and comments, which is `"IBM437"`.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ZipDriver(IOPoolProvider provider)` Equivalent to `new ZipDriver(provider, ZIP_CHARSET)`.
`protected`	`ZipDriver(IOPoolProvider provider, Charset charset)` Constructs a new ZIP driver.

Method Summary

Methods
Modifier and Type	Method and Description
`protected int`	`getLevel()` Returns the value of the property `level`.
`protected int`	`getMethod()` Returns the value of the property `method`.
`OptionOutputSocket`	`getOutputSocket(FsController<?> controller, FsEntryName name, BitField<FsOutputOption> options, Entry template)` This implementation modifies `options` in the following way before it forwards the call to `controller`: `FsOutputOption.STORE` is set.
`protected IOPool<?>`	`getPool()`
`protected boolean`	`getPostambled()` Returns the value of the property `postambled`.
`protected boolean`	`getPreambled()` Returns the value of the property `preambled`.
`boolean`	`getRedundantContentSupport()`
`boolean`	`getRedundantMetaDataSupport()`
`ZipArchiveEntry`	`newEntry(String name)` Returns a new ZIP entry with the given `name`.
`ZipArchiveEntry`	`newEntry(String name, Entry.Type type, Entry template, BitField<FsOutputOption> mknod)`
`protected ZipArchiveEntry`	`newEntry(String name, ZipArchiveEntry template)`
`InputShop<ZipArchiveEntry>`	`newInputShop(FsModel model, InputSocket<?> input)` The implementation in the class `ZipDriver` acquires a read only file from the given socket and forwards the call to `newInputShop(de.schlichtherle.truezip.fs.FsModel, de.schlichtherle.truezip.socket.InputSocket<?>)`.
`protected InputShop<ZipArchiveEntry>`	`newInputShop(ReadOnlyFile rof)`
`protected OutputShop<ZipArchiveEntry>`	`newOutputShop(FsModel model, OptionOutputSocket output, ZipInputShop source)`
`OutputShop<ZipArchiveEntry>`	`newOutputShop(FsModel model, OutputSocket<?> output, InputShop<ZipArchiveEntry> source)` This implementation first checks if `FsOutputOption.GROW` is set for the given `output` socket.
`protected OutputShop<ZipArchiveEntry>`	`newOutputShop(OutputStream out, ZipInputShop source)`
`private OutputShop<ZipArchiveEntry>`	`newOutputShop0(FsModel model, OptionOutputSocket output, ZipInputShop source)`

Methods inherited from class de.schlichtherle.truezip.fs.archive.FsCharsetArchiveDriver
assertEncodable, getCharset, toString, toZipOrTarEntryName

Methods inherited from class de.schlichtherle.truezip.fs.archive.FsArchiveDriver
getClosedIcon, getInputSocket, getOpenIcon, isFederated, newController, newEntry, newInputStream, newOutputStream, newReadOnlyFile

Methods inherited from class de.schlichtherle.truezip.fs.FsDriver
getPriority

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ZIP_CHARSET
```
private static final Charset ZIP_CHARSET
```
    The default character set for entry names and comments, which is "IBM437".
  - provider
```
private final IOPoolProvider provider
```
- Constructor Detail
  - ZipDriver
```
public ZipDriver(IOPoolProvider provider)
```
    Equivalent to new ZipDriver(provider, ZIP_CHARSET).
  - ZipDriver
```
protected ZipDriver(IOPoolProvider provider,
         Charset charset)
```
    Constructs a new ZIP driver.
    
    Parameters:
    provider - the I/O pool service to use for allocating temporary I/O entries.
    charset - the character set to use for entry names and comments.
- Method Detail
  - getRedundantContentSupport
```
public boolean getRedundantContentSupport()
```
    Overrides:
    
    getRedundantContentSupport in class FsArchiveDriver<ZipArchiveEntry>
    
    Returns:
    The implementation in the class ZipDriver returns true because when reading a ZIP file sequentially, each ZIP entry should "override" any previously read ZIP entry with an equal name. This holds true even if the central directory is used to access the ZIP entries in random order.
  - getRedundantMetaDataSupport
```
public boolean getRedundantMetaDataSupport()
```
    Overrides:
    
    getRedundantMetaDataSupport in class FsArchiveDriver<ZipArchiveEntry>
    
    Returns:
    The implementation in the class ZipDriver returns true because when reading a ZIP file sequentially, each ZIP entry should "override" any previously read ZIP entry with an equal name. This holds true even if the central directory is used to access the ZIP entries in random order.
  - getPool
```
protected final IOPool<?> getPool()
```
    Specified by:
    
    getPool in class FsArchiveDriver<ZipArchiveEntry>
  - getPreambled
```
protected boolean getPreambled()
```
    Returns the value of the property preambled. If this is true, then a ZIP file is allowed to contain arbitrary data as its preamble before the actual ZIP file data. Self Extracting Archives typically use a preamble to store the application code that is required to extract the ZIP file contents.
    Note that searching for a preamble can seriously degrade the performance if the file is not compatible to the ZIP File Format Specification.
    The implementation in the class ZipDriver returns false.
    
    Returns:
    The value of the property preambled.
  - getPostambled
```
protected boolean getPostambled()
```
    Returns the value of the property postambled. If this is true, then a ZIP file is allowed to contain arbitrary length data as its postamble after the actual ZIP file data.
    If this is false, then a ZIP file may still have a postamble. However, the postamble must not exceed 64KB size, including the End Of Central Directory record and thus the ZIP file comment. This causes the initial ZIP file compatibility test to fail fast if the file is not compatible to the ZIP File Format Specification.
    Note that searching for an arbitrary length postamble can seriously degrade the performance if the file is not compatible to the ZIP File Format Specification. So this should be set to true only if Self Extracting Archives with very large postambles need to get supported.
    The implementation in the class ZipDriver returns false.
    
    Returns:
    The value of the property postambled.
  - getMethod
```
protected int getMethod()
```
    Returns the value of the property method. This is the compression method to use when writing an entry to a ZIP output stream.
    The implementation in the class ZipDriver returns ZipEntry.DEFLATED.
    
    Returns:
    The value of the property method.
  - getLevel
```
protected int getLevel()
```
    Returns the value of the property level. This is the compression level to use when deflating an entry to a ZIP output stream.
    The implementation in the class ZipDriver returns Deflater.BEST_COMPRESSION.
    
    Returns:
    The value of the property level.
  - newInputShop
```
public InputShop<ZipArchiveEntry> newInputShop(FsModel model,
                                      InputSocket<?> input)
                                        throws IOException
```
    The implementation in the class ZipDriver acquires a read only file from the given socket and forwards the call to newInputShop(de.schlichtherle.truezip.fs.FsModel, de.schlichtherle.truezip.socket.InputSocket<?>).
    
    Specified by:
    
    newInputShop in class FsArchiveDriver<ZipArchiveEntry>
    
    Throws:
    
    IOException
  - newInputShop
```
protected InputShop<ZipArchiveEntry> newInputShop(ReadOnlyFile rof)
                                           throws IOException
```
    Throws:
    
    IOException
  - getOutputSocket
```
public OptionOutputSocket getOutputSocket(FsController<?> controller,
                                 FsEntryName name,
                                 BitField<FsOutputOption> options,
                                 @CheckForNull
                                 Entry template)
```
    This implementation modifies options in the following way before it forwards the call to controller:
    1. FsOutputOption.STORE is set.
    2. If FsOutputOption.GROW is set, FsOutputOption.APPEND gets set too, and FsOutputOption.CACHE gets cleared.
    The resulting output socket is then wrapped in a private nested class for an upcast in newOutputShop(de.schlichtherle.truezip.fs.FsModel, de.schlichtherle.truezip.socket.OutputSocket<?>, de.schlichtherle.truezip.socket.InputShop<de.schlichtherle.truezip.fs.archive.zip.ZipArchiveEntry>). Thus, when overriding this method, newOutputShop(de.schlichtherle.truezip.fs.FsModel, de.schlichtherle.truezip.socket.OutputSocket<?>, de.schlichtherle.truezip.socket.InputShop<de.schlichtherle.truezip.fs.archive.zip.ZipArchiveEntry>) should get overridden, too. Otherwise, a class cast exception will get thrown in newOutputShop(de.schlichtherle.truezip.fs.FsModel, de.schlichtherle.truezip.socket.OutputSocket<?>, de.schlichtherle.truezip.socket.InputShop<de.schlichtherle.truezip.fs.archive.zip.ZipArchiveEntry>).
    Overrides:
    
    getOutputSocket in class FsArchiveDriver<ZipArchiveEntry>
  - newOutputShop
```
public final OutputShop<ZipArchiveEntry> newOutputShop(FsModel model,
                                        OutputSocket<?> output,
                                        @CheckForNull
                                        InputShop<ZipArchiveEntry> source)
                                                throws IOException
```
    This implementation first checks if FsOutputOption.GROW is set for the given output socket. If this is the case and the given source is not null, then it's marked for appending to it. Then, an output stream is acquired from the given output socket and the parameters are forwarded to newOutputShop(FsModel, OptionOutputSocket, ZipInputShop) and the result gets wrapped in a new FsMultiplexedOutputShop which uses the current getPool().
    
    Specified by:
    
    newOutputShop in class FsArchiveDriver<ZipArchiveEntry>
    
    Throws:
    
    IOException
  - newOutputShop0
```
private OutputShop<ZipArchiveEntry> newOutputShop0(FsModel model,
                                         OptionOutputSocket output,
                                         @CheckForNull
                                         ZipInputShop source)
                                            throws IOException
```
    Throws:
    
    IOException
  - newOutputShop
```
protected OutputShop<ZipArchiveEntry> newOutputShop(FsModel model,
                                        OptionOutputSocket output,
                                        @CheckForNull
                                        ZipInputShop source)
                                             throws IOException
```
    Throws:
    
    IOException
  - newOutputShop
```
protected OutputShop<ZipArchiveEntry> newOutputShop(OutputStream out,
                                        @CheckForNull
                                        ZipInputShop source)
                                             throws IOException
```
    Throws:
    
    IOException
  - newEntry
```
public ZipArchiveEntry newEntry(String name,
                       Entry.Type type,
                       Entry template,
                       BitField<FsOutputOption> mknod)
                         throws CharConversionException
```
    Specified by:
    
    newEntry in class FsArchiveDriver<ZipArchiveEntry>
    
    Throws:
    
    CharConversionException
  - newEntry
```
public ZipArchiveEntry newEntry(String name)
```
    Description copied from interface: ZipEntryFactory
    
    Returns a new ZIP entry with the given name.
    
    Specified by:
    
    newEntry in interface ZipEntryFactory<ZipArchiveEntry>
    
    Parameters:
    name - the entry name.
    
    Returns:
    A new ZIP entry with the given name.
  - newEntry
```
protected ZipArchiveEntry newEntry(String name,
                       ZipArchiveEntry template)
```

Class ZipDriver

Field Summary

Constructor Summary

Method Summary

Methods inherited from class de.schlichtherle.truezip.fs.archive.FsCharsetArchiveDriver

Methods inherited from class de.schlichtherle.truezip.fs.archive.FsArchiveDriver

Methods inherited from class de.schlichtherle.truezip.fs.FsDriver

Methods inherited from class java.lang.Object

Field Detail

ZIP_CHARSET

provider

Constructor Detail

ZipDriver

ZipDriver

Method Detail

getRedundantContentSupport

getRedundantMetaDataSupport

getPool

getPreambled

getPostambled

getMethod

getLevel

newInputShop

newInputShop

getOutputSocket

newOutputShop

newOutputShop0

newOutputShop

newOutputShop

newEntry

newEntry

newEntry