Constructor Detail

• FsArchiveDriver

  public FsArchiveDriver()

Method Detail

• assertEncodable

  protected void assertEncodable(String name)
                          throws CharConversionException

  Ensures that the given entry name can get encoded by this driver's character set.

  The implementation in the class FsArchiveDriver is just a stub and does nothing.

  Parameters:

  name - an entry name.

  Throws:

  CharConversionException - If the entry name contains characters which cannot get encoded.

• getInputSocket

  public InputSocket<?> getInputSocket(FsController<?> controller,
                              FsEntryName name,
                              BitField<FsInputOption> options)

  Called to prepare reading an archive file artifact of this driver from name in controller using options.

  This method may get overridden in order to modify the given options before forwarding the call to the given controller. The implementation in the class FsArchiveDriver simply forwards the call to the given controller with the given options unaltered.

  Parameters:

  controller - the controller to use for reading an artifact of this driver.

  name - the entry name.

  options - the options to use.

  Returns:

  An input socket for reading an artifact of this driver.

  Since:

  TrueZIP 7.1

• getOutputSocket

  public OutputSocket<?> getOutputSocket(FsController<?> controller,
                                FsEntryName name,
                                BitField<FsOutputOption> options,
                                @CheckForNull
                                Entry template)

  Called to prepare writing an archive file artifact of this driver to the entry name in controller using options and the nullable template.

  This method may get overridden in order to modify the given options before forwarding the call to the given controller. The implementation in the class FsArchiveDriver simply forwards the call to the given controller with the given options unaltered.

  Parameters:

  controller - the controller to use for writing an artifact of this driver.

  name - the entry name.

  options - the options to use.

  template - the template to use.

  Returns:

  An output socket for writing an artifact of this driver.

  Since:

  TrueZIP 7.1

• getPool

  protected abstract IOPool<?> getPool()

  Returns the I/O buffer pool to use for allocating temporary I/O buffers.

  Multiple invocations should return the same I/O buffer pool. However, callers should cache the return value for subsequent use in case it isn't always the same.

  Returns:

  The I/O buffer pool to use for allocating temporary I/O buffers.

• getRedundantContentSupport

  public boolean getRedundantContentSupport()

  Returns true if and only if the archive files produced by this archive driver may contain redundant archive entry contents. If the return value is true, then an archive file may contain redundant archive entry contents, but only the last contents written should get used when reading the archive file.

  Returns:

  The implementation in the class FsArchiveDriver returns false for backwards compatibility.

  Since:

  TrueZIP 7.3

• getRedundantMetaDataSupport

  public boolean getRedundantMetaDataSupport()

  Returns true if and only if the archive files produced by this archive driver may contain redundant archive entry meta data. If the return value is true, then an archive file may contain redundant archive entry meta data, but only the last meta data written should get used when reading the archive file. This usually implies the existence of a central directory in the resulting archive file.

  Returns:

  The implementation in the class FsArchiveDriver returns false for backwards compatibility.

  Since:

  TrueZIP 7.3

• isFederated

  public final boolean isFederated()

  Returns true iff this file system driver implements a federated file system type, i.e. if the type of file system must be a member of a parent file system.

  The implementation in the class FsDriver returns false.

  The implementation in the class FsArchiveDriver always returns true.

  Overrides:

  isFederated in class FsDriver

  Returns:

  true iff the type of the file system implemented by this file system driver is federated, i.e. must be a member of a parent file system.

• newController

  public final FsController<? extends FsModel> newController(FsManager manager,
                                              FsModel model,
                                              @CheckForNull
                                              FsController<? extends FsModel> parent)

  Returns a new thread-safe file system controller for the mount point of the given file system model and nullable parent file system controller.

  When called, you may assert the following precondition:

  assert null == parent
           ? null == model.getParent()
           : parent.getModel().equals(model.getParent())
   

  The implementation in the class FsDriver simply forwards the call to FsDriver.newController(FsModel, FsController).

  The implementation in the class FsArchiveDriver simply forwards the call to the given file system manager after asserting that model.getParent().equals(parent.getModel()) is true.

  Overrides:

  newController in class FsDriver

  Parameters:

  manager - the file system manager for the new controller.

  model - the file system model.

  parent - the nullable parent file system controller.

  Returns:

  A new thread-safe file system controller for the given mount point and nullable parent file system controller.

  See Also:

  FsCompositeDriver.newController(de.schlichtherle.truezip.fs.FsManager, de.schlichtherle.truezip.fs.FsModel, de.schlichtherle.truezip.fs.FsController<? extends de.schlichtherle.truezip.fs.FsModel>)

• newController

  public FsController<?> newController(FsModel model,
                              @Nonnull
                              FsController<?> parent)

  Returns a new thread-safe file system controller for the mount point of the given file system model and parent file system controller.

  When called, you may assert the following precondition: model.getParent().equals(parent.getModel()) Note that the parent file system controller of an archive file system is never null.

  Specified by:

  newController in class FsDriver

  Parameters:

  model - the file system model.

  parent - the non-null parent file system controller.

  Returns:

  A new thread-safe file system controller for the given mount point and parent file system controller.

  See Also:

  FsCompositeDriver.newController(de.schlichtherle.truezip.fs.FsManager, de.schlichtherle.truezip.fs.FsModel, de.schlichtherle.truezip.fs.FsController<? extends de.schlichtherle.truezip.fs.FsModel>)

• newEntry

  public final E newEntry(String name,
           Entry.Type type,
           @CheckForNull
           Entry template)
                                          throws CharConversionException

  Equivalent to newEntry(name, type, template, FsOutputOptions.NONE).

  Parameters:

  name - an entry name.

  type - an entry type.

  template - if not null, then the new entry shall inherit as much properties from this entry as possible - with the exception of its name and type.

  Returns:

  A new entry for the given name.

  Throws:

  CharConversionException - if name contains characters which are invalid.

• newEntry

  public abstract E newEntry(String name,
           Entry.Type type,
           @CheckForNull
           Entry template,
           BitField<FsOutputOption> options)
                                             throws CharConversionException

  Returns a new entry for the given name. The implementation may need to fix this name in order to form a valid entry name for their particular requirements.

  If template is not null, then the returned entry shall inherit as much properties from this template as possible - with the exception of its name and type. Furthermore, if name and type are equal to the name and type of this template, then the returned entry shall be a (deep) clone of the template which shares no mutable state with the template.

  Parameters:

  name - an entry name.

  type - an entry type.

  template - if not null, then the new entry shall inherit as much properties from this entry as possible - with the exception of its name and type.

  options - when called from FsController.mknod(de.schlichtherle.truezip.fs.FsEntryName, de.schlichtherle.truezip.entry.Entry.Type, de.schlichtherle.truezip.util.BitField<de.schlichtherle.truezip.fs.FsOutputOption>, de.schlichtherle.truezip.entry.Entry), this is its options parameter, otherwise it's typically an empty set.

  Returns:

  A new entry for the given name.

  Throws:

  CharConversionException - TODO: This has been deprecated and should get removed.

• newInputShop

  @CreatesObligation
  public abstract InputShop<E> newInputShop(FsModel model,
                                            InputSocket<?> input)
                                                            throws IOException

  Creates a new input shop for reading the archive entries for the given model from the given input socket's target.

  Note that the returned input shop does not need to be thread-safe.

  Parameters:

  model - the file system model.

  input - the input socket for reading the contents of the archive file from its target. This is guaranteed to be the product of this driver's getInputSocket(de.schlichtherle.truezip.fs.FsController<?>, de.schlichtherle.truezip.fs.FsEntryName, de.schlichtherle.truezip.util.BitField<de.schlichtherle.truezip.fs.FsInputOption>) method.

  Returns:

  A new input shop.

  Throws:

  IOException - on any I/O error. If the file system entry for the given model exists in the parent file system and is not a Entry.Type.SPECIAL type, then this exception is deemed to indicate a persistent false positive archive file and gets cached until the file system controller for the given model is synced again. Otherwise, this exception is deemed to indicate a transient false positive archive file and does not get cached.

• newOutputShop

  @CreatesObligation
  public abstract OutputShop<E> newOutputShop(FsModel model,
                                              OutputSocket<?> output,
                                              @CheckForNull@WillNotClose
                                              InputShop<E> source)
                                                              throws IOException

  Creates a new output shop for writing archive entries for the given model to the given output socket's target.

  Note that the returned output shop does not need to be thread-safe.

  Parameters:

  model - the file system model.

  output - the output socket for writing the contents of the archive file to its target. This is guaranteed to be the product of this driver's getOutputSocket(de.schlichtherle.truezip.fs.FsController<?>, de.schlichtherle.truezip.fs.FsEntryName, de.schlichtherle.truezip.util.BitField<de.schlichtherle.truezip.fs.FsOutputOption>, de.schlichtherle.truezip.entry.Entry) method.

  source - the InputShop if archive is going to get updated. If not null, this is guaranteed to be the product of this driver's newInputShop(de.schlichtherle.truezip.fs.FsModel, de.schlichtherle.truezip.socket.InputSocket<?>) factory method. This feature could get used to copy some meta data which is specific to the type of archive this driver supports, e.g. the comment of a ZIP file.

  Returns:

  A new output shop.

  Throws:

  IOException - on any I/O error.