Field Detail

• manager

  protected final FsManager manager

  The decorated file system manager.

Constructor Detail

• FsDecoratingManager

  protected FsDecoratingManager(FsManager manager)

Method Detail

• accept

  public <X extends IOException> void accept(net.java.truecommons.shed.Filter<? super FsController> filter,
                                    net.java.truecommons.shed.Visitor<? super FsController,X> visitor)
              throws X extends IOException

  Description copied from interface: FsManager
  Invokes the given visitor on all managed file system controllers which get accepted by the given filter. This is the engine for calls to FsManager.sync(net.java.truecommons.shed.Filter<? super net.java.truevfs.kernel.spec.FsController>, net.java.truecommons.shed.Visitor<? super net.java.truevfs.kernel.spec.FsController, net.java.truevfs.kernel.spec.FsSyncException>).

  Parameters:

  filter - the filter for the managed file system controllers.

  visitor - the visitor for the filtered file system controllers.

  Throws:

  X extends IOException

• controller

  public FsController controller(FsCompositeDriver driver,
                        FsMountPoint mountPoint)

  Description copied from interface: FsManager
  Returns the thread-safe file system controller for the given mount point. The life cycle of the returned file system controller gets managed by this manager, i.e. it gets remembered for future lookup and synchronization.

  Parameters:

  driver - the composite file system driver which shall get used to create a new file system controller if required.

  mountPoint - the mount point of the file system.

  Returns:

  The thread-safe file system controller for the given mount point.

• newController

  public FsController newController(FsArchiveDriver<? extends FsArchiveEntry> context,
                           FsModel model,
                           @Nullable
                           FsController parent)

  Description copied from interface: FsController.Factory
  Returns a new file system controller for the mount point of the given file system model. This is a pure function without side effects.

  When called, you may assert the following precondition:

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

  Parameters:

  context - the calling context.

  model - the file system model.

  parent - the nullable parent file system controller.

  Returns:

  A new file system controller for the mount point of the given file system model.

• newModel

  public FsModel newModel(FsDriver context,
                 FsMountPoint mountPoint,
                 FsModel parent)

  Description copied from interface: FsModel.Factory
  Returns a new file system model for the given mount point. This is a pure function without side effects.

  When called, you may assert the following precondition:

  assert null == parent
           ? null == mountPoint.getParent()
           : parent.getMountPoint().equals(mountPoint.getParent());
   

  Parameters:

  context - the calling context.

  mountPoint - the mount point of the file system.

  parent - the nullable parent file system model.

  Returns:

  A new file system model for the given mount point.

• sync

  public void sync(net.java.truecommons.shed.Filter<? super FsController> filter,
          net.java.truecommons.shed.Visitor<? super FsController,FsSyncException> visitor)
            throws FsSyncException

  Description copied from interface: FsManager
  Invokes the given visitor to sync() all managed file system controllers which get accepted by the given filter.

  Call this method instead of FsManager.accept(net.java.truecommons.shed.Filter<? super net.java.truevfs.kernel.spec.FsController>, net.java.truecommons.shed.Visitor<? super net.java.truevfs.kernel.spec.FsController, X>) for sync()ing in order to support processing of additional aspects such as controlling a shutdown hook, logging statistics et al.

  The implementation needs to use an FsSyncExceptionBuilder while iterating over all managed file system controllers in order to ensure that all controllers get synced, even if one or more controllers fail with an FsSyncException.

  Specified by:

  sync in interface FsManager

  Overrides:

  sync in class FsAbstractManager

  Parameters:

  filter - the filter for the managed file system controllers. If set to Filter.ACCEPT_ANY, then the implementation may perform additional cleanup operations, e.g. remove a shutdown hook.

  visitor - the visitor for syncing the filtered file system controllers.

  Throws:

  FsSyncWarningException - if only warning conditions apply. This implies that the respective file system controller has been sync()ed with constraints, e.g. if an open archive entry stream or channel gets forcibly close()d.

  FsSyncException - if any error conditions apply.

• toString

  public String toString()

  Returns a string representation of this object for debugging and logging purposes.

  Overrides:

  toString in class Object