net.java.truevfs.access

Class TVFS

java.lang.Object

net.java.truevfs.access.TVFS

public final class TVFS
extends Object

Static utility methods for virtual file system operations with global scope. If you are not sure which method you should use, try umount() - it does the right thing for most use cases.

Author:

Christian Schlichtherle

Method Summary

Modifier and Type	Method and Description
static void	sync(net.java.truecommons.shed.BitField<FsSyncOption> options) Commits all pending changes for all (nested) archive files to their respective parent file system with respect to the given options.
static void	sync(FsMountPoint tree, net.java.truecommons.shed.BitField<FsSyncOption> options) Commits all pending changes for all (nested) archive files within the given (virtual) directory tree to their respective parent file system with respect to the given options.
static void	sync(FsMountPoint tree, FsSyncOption... options) Commits all pending changes for all (nested) archive files within the given (virtual) directory tree to their respective parent file system with respect to the given options.
static void	sync(FsSyncOption... options) Commits all pending changes for all (nested) archive files to their respective parent file system with respect to the given options.
static void	sync(TFile tree, net.java.truecommons.shed.BitField<FsSyncOption> options) Commits all pending changes for all (nested) archive files within the given (virtual) directory tree to their respective parent file system with respect to the given options.
static void	sync(TFile tree, FsSyncOption... options) Commits all pending changes for all (nested) archive files within the given (virtual) directory tree to their respective parent file system with respect to the given options.
static void	umount() Commits all pending changes for all (nested) archive files to their respective parent file system, closes their associated target archive file in order to allow access by third parties (e.g. other processes), cleans up any temporary allocated resources (e.g. temporary files) and purges any cached data.
static void	umount(FsMountPoint tree) Commits all pending changes for all (nested) archive files within the given (virtual) directory tree to their respective parent file system, closes their associated target archive file in order to allow access by third parties (e.g. other processes), cleans up any temporary allocated resources (e.g. temporary files) and purges any cached data.
static void	umount(TFile tree) Commits all pending changes for all (nested) archive files within the given (virtual) directory tree to their respective parent file system, closes their associated target archive file in order to allow access by third parties (e.g. other processes), cleans up any temporary allocated resources (e.g. temporary files) and purges any cached data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

sync

@ExpertFeature(value=THE_PRESENCE_OR_ABSENCE_OF_SOME_OPTIONS_MAY_YIELD_UNWANTED_SIDE_EFFECTS)
public static void sync(net.java.truecommons.shed.BitField<FsSyncOption> options)
                                                                                                               throws FsSyncWarningException,
                                                                                                                      FsSyncException

Commits all pending changes for all (nested) archive files to their respective parent file system with respect to the given options.

Parameters:

options - a bit field of options for the synchronization operation.

Throws:

IllegalArgumentException - if the combination of synchronization options is illegal, e.g. if FsSyncOption.ABORT_CHANGES is set.

FsSyncWarningException - if only warning conditions apply. This implies that the respective parent file system has been synchronized with constraints, e.g. if FsSyncOption.FORCE_CLOSE_IO is set and an unclosed archive entry stream gets forcibly closed.

FsSyncException - if any error conditions apply.

sync

@ExpertFeature(value=THE_PRESENCE_OR_ABSENCE_OF_SOME_OPTIONS_MAY_YIELD_UNWANTED_SIDE_EFFECTS)
public static void sync(FsMountPoint tree,
                                                                                                                      net.java.truecommons.shed.BitField<FsSyncOption> options)
                                                                                                               throws FsSyncWarningException,
                                                                                                                      FsSyncException

Commits all pending changes for all (nested) archive files within the given (virtual) directory tree to their respective parent file system with respect to the given options.

Parameters:

tree - a file or directory in the (virtual) file system space.

options - a bit field of options for the synchronization operation.

Throws:

IllegalArgumentException - if the combination of synchronization options is illegal, e.g. if FsSyncOption.ABORT_CHANGES is set.

FsSyncWarningException - if only warning conditions apply. This implies that the respective parent file system has been synchronized with constraints, e.g. if FsSyncOption.FORCE_CLOSE_IO is set and an unclosed archive entry stream gets forcibly closed.

FsSyncException - if any error conditions apply.

sync

@ExpertFeature(value=THE_PRESENCE_OR_ABSENCE_OF_SOME_OPTIONS_MAY_YIELD_UNWANTED_SIDE_EFFECTS)
public static void sync(FsMountPoint tree,
                                                                                                                      FsSyncOption... options)
                                                                                                               throws FsSyncWarningException,
                                                                                                                      FsSyncException

Commits all pending changes for all (nested) archive files within the given (virtual) directory tree to their respective parent file system with respect to the given options.

Parameters:

tree - a file or directory in the (virtual) file system space.

options - an array of options for the synchronization operation.

Throws:

IllegalArgumentException - if the combination of synchronization options is illegal, e.g. if FsSyncOption.ABORT_CHANGES is set.

FsSyncWarningException - if only warning conditions apply. This implies that the respective parent file system has been synchronized with constraints, e.g. if FsSyncOption.FORCE_CLOSE_IO is set and an unclosed archive entry stream gets forcibly closed.

FsSyncException - if any error conditions apply.

sync

@ExpertFeature(value=THE_PRESENCE_OR_ABSENCE_OF_SOME_OPTIONS_MAY_YIELD_UNWANTED_SIDE_EFFECTS)
public static void sync(FsSyncOption... options)
                                                                                                               throws FsSyncWarningException,
                                                                                                                      FsSyncException

Commits all pending changes for all (nested) archive files to their respective parent file system with respect to the given options.

Parameters:

options - an array of options for the synchronization operation.

Throws:

IllegalArgumentException - if the combination of synchronization options is illegal, e.g. if FsSyncOption.ABORT_CHANGES is set.

FsSyncWarningException - if only warning conditions apply. This implies that the respective parent file system has been synchronized with constraints, e.g. if FsSyncOption.FORCE_CLOSE_IO is set and an unclosed archive entry stream gets forcibly closed.

FsSyncException - if any error conditions apply.

sync

@ExpertFeature(value=THE_PRESENCE_OR_ABSENCE_OF_SOME_OPTIONS_MAY_YIELD_UNWANTED_SIDE_EFFECTS)
public static void sync(TFile tree,
                                                                                                                      net.java.truecommons.shed.BitField<FsSyncOption> options)
                                                                                                               throws FsSyncWarningException,
                                                                                                                      FsSyncException

Commits all pending changes for all (nested) archive files within the given (virtual) directory tree to their respective parent file system with respect to the given options.

Parameters:

tree - a file or directory in the (virtual) file system space.

options - a bit field of options for the synchronization operation.

Throws:

IllegalArgumentException - if the combination of synchronization options is illegal, e.g. if FsSyncOption.ABORT_CHANGES is set.

FsSyncWarningException - if only warning conditions apply. This implies that the respective parent file system has been synchronized with constraints, e.g. if FsSyncOption.FORCE_CLOSE_IO is set and an unclosed archive entry stream gets forcibly closed.

FsSyncException - if any error conditions apply.

sync

@ExpertFeature(value=THE_PRESENCE_OR_ABSENCE_OF_SOME_OPTIONS_MAY_YIELD_UNWANTED_SIDE_EFFECTS)
public static void sync(TFile tree,
                                                                                                                      FsSyncOption... options)
                                                                                                               throws FsSyncWarningException,
                                                                                                                      FsSyncException

Commits all pending changes for all (nested) archive files within the given (virtual) directory tree to their respective parent file system with respect to the given options.

Parameters:

tree - a file or directory in the (virtual) file system space.

options - an array of options for the synchronization operation.

Throws:

IllegalArgumentException - if the combination of synchronization options is illegal, e.g. if FsSyncOption.ABORT_CHANGES is set.

FsSyncWarningException - if only warning conditions apply. This implies that the respective parent file system has been synchronized with constraints, e.g. if FsSyncOption.FORCE_CLOSE_IO is set and an unclosed archive entry stream gets forcibly closed.

FsSyncException - if any error conditions apply.

umount

public static void umount()
                   throws FsSyncWarningException,
                          FsSyncException

Commits all pending changes for all (nested) archive files to their respective parent file system, closes their associated target archive file in order to allow 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 files may of used even for read-only access to archive files, so calling this operation is essential. However, if the client application never calls this operation, then it gets called by a shutdown hook. The shutdown hook gets removed as soon as this operation gets called in order to leak no memory in dynamic class loader environments.

Calling this method is equivalent to sync(FsSyncOptions.UMOUNT).

Throws:

FsSyncWarningException - if only warning conditions apply. This implies that the respective parent file system has been synchronized with constraints, e.g. if an unclosed archive entry stream gets forcibly closed.

FsSyncException - if any error conditions apply.

umount

public static void umount(FsMountPoint tree)
                   throws FsSyncWarningException,
                          FsSyncException

Commits all pending changes for all (nested) archive files within the given (virtual) directory tree to their respective parent file system, closes their associated target archive file in order to allow access by third parties (e.g. other processes), cleans up any temporary allocated resources (e.g. temporary files) and purges any cached data.

Calling this method is equivalent to sync(tree, FsSyncOptions.UMOUNT).

Parameters:

tree - a file or directory in the (virtual) file system space.

Throws:

FsSyncWarningException - if only warning conditions apply. This implies that the respective parent file system has been synchronized with constraints, e.g. if an unclosed archive entry stream gets forcibly closed.

FsSyncException - if any error conditions apply.

umount

public static void umount(TFile tree)
                   throws FsSyncWarningException,
                          FsSyncException

Commits all pending changes for all (nested) archive files within the given (virtual) directory tree to their respective parent file system, closes their associated target archive file in order to allow access by third parties (e.g. other processes), cleans up any temporary allocated resources (e.g. temporary files) and purges any cached data.

Calling this method is equivalent to sync(tree, FsSyncOptions.UMOUNT).

Parameters:

tree - a file or directory in the (virtual) file system space.

Throws:

FsSyncWarningException - if only warning conditions apply. This implies that the respective parent file system has been synchronized with constraints, e.g. if an unclosed archive entry stream gets forcibly closed.

FsSyncException - if any error conditions apply.