net.java.truevfs.access

Class TFileSystem

java.lang.Object

java.nio.file.FileSystem

net.java.truevfs.access.TFileSystem

All Implemented Interfaces:

Closeable, AutoCloseable

@ThreadSafe
public final class TFileSystem
extends FileSystem

A FileSystem implementation for use with NIO.2.

Author:

Christian Schlichtherle

Method Summary

Modifier and Type	Method and Description
void	close() Commits all pending changes for this (federated) file system and all its federated child file systems 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.
Iterable<FileStore>	getFileStores()
TPath	getPath(String first, String... more) Constructs a new path from the given sub path strings.
PathMatcher	getPathMatcher(String syntaxAndPattern)
Iterable<Path>	getRootDirectories()
String	getSeparator() Returns File.separator.
UserPrincipalLookupService	getUserPrincipalLookupService()
boolean	isOpen() Returns true.
boolean	isReadOnly() Returns false.
WatchService	newWatchService()
TFileSystemProvider	provider()
Set<String>	supportedFileAttributeViews()
void	sync(net.java.truecommons.shed.BitField<FsSyncOption> options) Commits all pending changes for this (federated) file system and all its federated child file systems to their respective parent file system with respect to the given options.

Methods inherited from class java.lang.Object

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

Method Detail

close

public void close()
           throws FsSyncWarningException,
                  FsSyncException

Commits all pending changes for this (federated) file system and all its federated child file systems 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(FsSyncOptions.UMOUNT).

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class FileSystem

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. This implies some loss of data!

See Also:

sync(BitField)

getFileStores

public Iterable<FileStore> getFileStores()

Specified by:

getFileStores in class FileSystem

Throws:

UnsupportedOperationException - always

getPath

public TPath getPath(String first,
                     String... more)

Constructs a new path from the given sub path strings.

This method scans the path name resulting from the segment parameters to detect prospective archive files using the current archive detector TConfig.current().getArchiveDetector().

The supported path name separators are "File.separator" and "/". Any leading and trailing separators in the resulting path name current discarded.

Specified by:

getPath in class FileSystem

Parameters:

first - the first sub path string.

more - optional sub path strings.

getPathMatcher

public PathMatcher getPathMatcher(String syntaxAndPattern)

Specified by:

getPathMatcher in class FileSystem

Throws:

UnsupportedOperationException - always

getRootDirectories

public Iterable<Path> getRootDirectories()

Specified by:

getRootDirectories in class FileSystem

getSeparator

public String getSeparator()

Returns File.separator.

Specified by:

getSeparator in class FileSystem

Returns:

File.separator.

getUserPrincipalLookupService

public UserPrincipalLookupService getUserPrincipalLookupService()

Specified by:

getUserPrincipalLookupService in class FileSystem

Throws:

UnsupportedOperationException - always

isOpen

public boolean isOpen()

Returns true.

Specified by:

isOpen in class FileSystem

Returns:

true.

isReadOnly

public boolean isReadOnly()

Returns false.

Specified by:

isReadOnly in class FileSystem

Returns:

false.

newWatchService

public WatchService newWatchService()
                             throws IOException

Specified by:

newWatchService in class FileSystem

Throws:

UnsupportedOperationException - always

IOException

provider

public TFileSystemProvider provider()

Specified by:

provider in class FileSystem

supportedFileAttributeViews

public Set<String> supportedFileAttributeViews()

Specified by:

supportedFileAttributeViews in class FileSystem

sync

public void sync(net.java.truecommons.shed.BitField<FsSyncOption> options)
          throws FsSyncWarningException,
                 FsSyncException

Commits all pending changes for this (federated) file system and all its federated child file systems 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.FORCE_CLOSE_INPUT is cleared and FsSyncOption.FORCE_CLOSE_OUTPUT is set or 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_INPUT or FsSyncOption.FORCE_CLOSE_OUTPUT is set and an unclosed archive entry stream gets forcibly closed.

FsSyncException - if any error conditions apply. This implies some loss of data!