Field Detail

• UMOUNT

  public static final BitField<FsSyncOption> UMOUNT

  Equivalent to BitField.of(FsSyncOption.FORCE_CLOSE_INPUT, FsSyncOption.FORCE_CLOSE_OUTPUT, FsSyncOption.CLEAR_CACHE).

Constructor Detail

• FsManager

  public FsManager()

Method Detail

• equals

  public final boolean equals(Object that)

  Two file system managers are considered equal if and only if they are identical. This can't get overriden.

  Overrides:

  equals in class Object

  Parameters:

  that - the object to compare.

• getController

  public abstract FsController<?> getController(FsMountPoint mountPoint,
                              FsCompositeDriver driver)

  Returns a thread-safe file system controller for the given mount point. If and only if the given mount point addresses a federated file system, the returned file system controller is remembered for life cycle management, i.e. future lookup and synchronization operations.

  Parameters:

  mountPoint - the mount point of the file system.

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

  Returns:

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

• getSize

  public abstract int getSize()

  Returns the number of federated file systems managed by this instance.

  Returns:

  The number of federated file systems managed by this instance.

• hashCode

  public final int hashCode()

  Returns a hash code which is consistent with equals(java.lang.Object). This can't get overriden.

  Overrides:

  hashCode in class Object

• iterator

  public abstract Iterator<FsController<?>> iterator()

  Returns an iterator for the controller of all federated file systems managed by this instance.

  Important: The iterated file system controllers must be ordered so that all file systems appear before any of their parent file systems.

  Specified by:

  iterator in interface Iterable<FsController<?>>

  Returns:

  An iterator for the controller of all federated file systems managed by this instance.

• sync

  public final void sync(BitField<FsSyncOption> options)
                  throws FsSyncException

  Commits all unsynchronized changes to the contents of all federated file systems managed by this instance to their respective parent file system, releases the associated resources (e.g. target archive files) for access by third parties (e.g. other processes), cleans up any temporary allocated resources (e.g. temporary files) and purges any cached data. Note that temporary resources may get allocated even if the federated file systems were accessed read-only. As a side effect, this will reset the state of the respective file system controllers.

  This method calls sync(options, builder), where builder is an instance of FsSyncExceptionBuilder. If the call succeeds, the builder's AbstractExceptionBuilder.check() method is called to check out any FsSyncWarningException, too.

  Parameters:

  options - a bit field of synchronization options.

  Throws:

  FsSyncException - if committing the changes fails for any reason.

  IllegalArgumentException - if the combination of synchronization options is illegal, e.g. if FORCE_CLOSE_INPUT is cleared and FORCE_CLOSE_OUTPUT is set or if the synchronization option ABORT_CHANGES is set.

• sync

  public <X extends IOException> void sync(BitField<FsSyncOption> options,
                                  ExceptionHandler<? super IOException,X> handler)
            throws X extends IOException

  Commits all unsynchronized changes to the contents of all federated file systems managed by this instance to their respective parent file system, releases the associated resources (e.g. target archive files) for access by third parties (e.g. other processes), cleans up any temporary allocated resources (e.g. temporary files) and purges any cached data. Note that temporary resources may get allocated even if the federated file systems were accessed read-only. As a side effect, this will reset the state of the respective file system controllers.

  Type Parameters:

  X - The type of the IOException to throw at the discretion of the exception handler.

  Parameters:

  options - a bit field of synchronization options.

  handler - the exception handling strategy for consuming input IOExceptions and/or assembling output IOExceptions.

  Throws:

  IOException - at the discretion of the exception handler upon the occurence of an IOException.

  IllegalArgumentException - if the combination of synchronization options is illegal, e.g. if FsSyncOption.FORCE_CLOSE_INPUT is cleared and FsSyncOption.FORCE_CLOSE_OUTPUT is set or if the synchronization option FsSyncOption.ABORT_CHANGES is set.

• toString

  public String toString()

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

  Overrides:

  toString in class Object

• visit

  private <X extends IOException> void visit(FsManager.Visitor visitor,
                                   ExceptionHandler<? super IOException,X> handler)
              throws X extends IOException

  Visits the controller of all federated file systems managed by this instance.

  Type Parameters:

  X - The type of the IOException to throw at the discretion of the exception handler.

  Parameters:

  visitor - the visitor.

  handler - the exception handling strategy for consuming input IOExceptions and/or assembling output IOException.

  Throws:

  IOException - at the discretion of the exception handler upon the occurence of an IOException.