TFileSystemProvider (TrueZIP Path 7.3.2 API)

java.lang.Object
- java.nio.file.spi.FileSystemProvider
- - de.schlichtherle.truezip.nio.file.TFileSystemProvider

@ThreadSafe
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public final class TFileSystemProvider
extends FileSystemProvider

A FileSystemProvider implementation based on the TrueZIP Kernel module.

Since:: TrueZIP 7.2
Author:: Christian Schlichtherle

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class TFileSystemProvider.Holder

static interface TFileSystemProvider.Parameter
Keys for environment maps.

Nested Classes
Modifier and Type	Class and Description
`private static class`	`TFileSystemProvider.Holder`
`static interface`	`TFileSystemProvider.Parameter` Keys for environment maps.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_ROOT_MOUNT_POINT` The root mount point of the provider for the public no-arg constructor.
`private static URI`	`DEFAULT_ROOT_MOUNT_POINT_URI`
`static String`	`DEFAULT_SCHEME` The scheme of the provider for the public no-arg constructor.
`private Map<FsMountPoint,TFileSystem>`	`fileSystems`
`private static FsManager`	`manager`
`private static Map<String,TFileSystemProvider>`	`providers`
`private FsPath`	`root`
`private String`	`scheme`

Constructor Summary

Constructors
Modifier Constructor and Description

private TFileSystemProvider(String scheme, URI root)

Constructors
Modifier	Constructor and Description
`private`	`TFileSystemProvider(String scheme, URI root)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`checkAccess(Path path, AccessMode... modes)`
`void`	`copy(Path source, Path target, CopyOption... options)`
`private static void`	`copy(TPath src, TPath dst, CopyOption... options)`
`void`	`createDirectory(Path dir, FileAttribute<?>... attrs)`
`void`	`delete(Path path)`
`private static void`	`delete(TPath path)`
`(package private) static TFileSystemProvider`	`get(URI name)` Obtains a file system provider for the given `TPath` URI.
`<V extends FileAttributeView> V`	`getFileAttributeView(Path path, Class<V> type, LinkOption... options)`
`FileStore`	`getFileStore(Path path)`
`(package private) TFileSystem`	`getFileSystem(TPath path)` Obtains a file system for the given path.
`TFileSystem`	`getFileSystem(URI uri)` Returns a file system for the given hierarchical `TPath` `uri`.
`TPath`	`getPath(URI name)` Returns a `TPath` for the given hierarchical `name`.
`FsPath`	`getRoot()` Returns the root mount point of this provider.
`String`	`getScheme()` Returns the default scheme of this provider.
`boolean`	`isHidden(Path path)`
`boolean`	`isSameFile(Path a, Path b)`
`private static boolean`	`isSameFile0(Path a, Path b)`
`void`	`move(Path source, Path target, CopyOption... options)`
`private static void`	`move(TPath source, TPath target, CopyOption... options)`
`SeekableByteChannel`	`newByteChannel(Path path, Set<? extends OpenOption> options, FileAttribute<?>... attrs)`
`DirectoryStream<Path>`	`newDirectoryStream(Path dir, DirectoryStream.Filter<? super Path> filter)`
`TFileSystem`	`newFileSystem(Path path, Map<String,?> configuration)` Scans the given `path` for prospective archive files using the given `configuration` and returns the file system for the innermost prospective archive file or throws an `UnsupportedOperationException` if no prospective archive file is detected.
`TFileSystem`	`newFileSystem(URI uri, Map<String,?> configuration)` Returns a file system for the given hierarchical `TPath` `uri`.
`InputStream`	`newInputStream(Path path, OpenOption... options)`
`OutputStream`	`newOutputStream(Path path, OpenOption... options)`
`private static TPath`	`promote(Path path)`
`private static TConfig`	`push(Map<String,?> env)`
`<A extends BasicFileAttributes> A`	`readAttributes(Path path, Class<A> type, LinkOption... options)`
`Map<String,Object>`	`readAttributes(Path path, String attributes, LinkOption... options)`
`void`	`setAttribute(Path path, String attribute, Object value, LinkOption... options)`
`static void`	`umount()` Commits all unsynchronized changes to the contents of all federated file systems (i.e. prospective archive files) to their respective parent file system, releases the associated resources (i.e. 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.

Methods inherited from class java.nio.file.spi.FileSystemProvider
createLink, createSymbolicLink, deleteIfExists, installedProviders, newAsynchronousFileChannel, newFileChannel, readSymbolicLink

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_ROOT_MOUNT_POINT
```
public static final String DEFAULT_ROOT_MOUNT_POINT
```
    The root mount point of the provider for the public no-arg constructor.
    
    See Also:
    Constant Field Values
  - DEFAULT_ROOT_MOUNT_POINT_URI
```
private static final URI DEFAULT_ROOT_MOUNT_POINT_URI
```
  - DEFAULT_SCHEME
```
public static final String DEFAULT_SCHEME
```
    The scheme of the provider for the public no-arg constructor.
    
    See Also:
    Constant Field Values
  - fileSystems
```
private Map<FsMountPoint,TFileSystem> fileSystems
```
  - manager
```
private static final FsManager manager
```
  - providers
```
private static final Map<String,TFileSystemProvider> providers
```
  - root
```
private final FsPath root
```
  - scheme
```
private final String scheme
```
- Constructor Detail
  - TFileSystemProvider
```
private TFileSystemProvider(String scheme,
                   URI root)
```
- Method Detail
  - checkAccess
```
public void checkAccess(Path path,
               AccessMode... modes)
                 throws IOException
```
    Specified by:
    
    checkAccess in class FileSystemProvider
    
    Throws:
    
    IOException
  - copy
```
public void copy(Path source,
        Path target,
        CopyOption... options)
          throws IOException
```
    Specified by:
    
    copy in class FileSystemProvider
    
    Throws:
    
    IOException
  - copy
```
private static void copy(TPath src,
        TPath dst,
        CopyOption... options)
                  throws IOException
```
    Throws:
    
    IOException
  - createDirectory
```
public void createDirectory(Path dir,
                   FileAttribute<?>... attrs)
                     throws IOException
```
    Specified by:
    
    createDirectory in class FileSystemProvider
    
    Throws:
    
    IOException
  - delete
```
public void delete(Path path)
            throws IOException
```
    Specified by:
    
    delete in class FileSystemProvider
    
    Throws:
    
    IOException
  - delete
```
private static void delete(TPath path)
                    throws IOException
```
    Throws:
    
    IOException
  - get
```
static TFileSystemProvider get(URI name)
```
    Obtains a file system provider for the given TPath URI.
    
    Parameters:
    name - a TPath URI.
    
    Returns:
    A file system provider.
  - getFileAttributeView
```
@Nullable
public <V extends FileAttributeView> V getFileAttributeView(Path path,
                                                            Class<V> type,
                                                            LinkOption... options)
```
    Specified by:
    
    getFileAttributeView in class FileSystemProvider
  - getFileStore
```
public FileStore getFileStore(Path path)
                       throws IOException
```
    Specified by:
    
    getFileStore in class FileSystemProvider
    
    Throws:
    
    UnsupportedOperationException - always
    
    IOException
  - getFileSystem
```
TFileSystem getFileSystem(TPath path)
```
    Obtains a file system for the given path. If a file system doesn't exist yet, it's created.
    
    Parameters:
    path - a path.
    
    Returns:
    A file system.
  - getFileSystem
```
public TFileSystem getFileSystem(URI uri)
```
    Returns a file system for the given hierarchical TPath uri.
    The uri is scanned for prospective archive files using the current configuration. Any trailing separators in uri get discarded. If one or more prospective archive files are found, the file system for the innermost prospective archive file is returned. Otherwise, the file system for the innermost directory is returned.
    
    Specified by:
    
    getFileSystem in class FileSystemProvider
    
    Parameters:
    uri - the TPath uri to return a file system for.
    
    Returns:
    the file system for the innermost prospective archive file or directory.
    
    Throws:
    
    IllegalArgumentException - if the given uri is opaque.
  - getPath
```
public TPath getPath(URI name)
```
    Returns a TPath for the given hierarchical name.
    The URI path component is scanned for prospective archive files using the current configuration. Any trailing separators in name get discarded.
    
    Specified by:
    
    getPath in class FileSystemProvider
    
    Parameters:
    name - the uri to return a TPath for.
    
    Returns:
    the TPath
    
    Throws:
    
    IllegalArgumentException - if the given uri is opaque.
  - getRoot
```
public FsPath getRoot()
```
    Returns the root mount point of this provider.
    
    Returns:
    The root mount point of this provider.
  - getScheme
```
public String getScheme()
```
    Returns the default scheme of this provider.
    
    Specified by:
    
    getScheme in class FileSystemProvider
    
    Returns:
    the default scheme of this provider.
  - isHidden
```
public boolean isHidden(Path path)
                 throws IOException
```
    Specified by:
    
    isHidden in class FileSystemProvider
    
    Throws:
    
    IOException
  - isSameFile
```
public boolean isSameFile(Path a,
                 Path b)
                   throws IOException
```
    Specified by:
    
    isSameFile in class FileSystemProvider
    
    Throws:
    
    IOException
  - isSameFile0
```
private static boolean isSameFile0(Path a,
                  Path b)
                            throws IOException
```
    Throws:
    
    IOException
  - move
```
public void move(Path source,
        Path target,
        CopyOption... options)
          throws IOException
```
    Specified by:
    
    move in class FileSystemProvider
    
    Throws:
    
    IOException
  - move
```
private static void move(TPath source,
        TPath target,
        CopyOption... options)
                  throws IOException
```
    Throws:
    
    IOException
  - newByteChannel
```
public SeekableByteChannel newByteChannel(Path path,
                                 Set<? extends OpenOption> options,
                                 FileAttribute<?>... attrs)
                                   throws IOException
```
    Specified by:
    
    newByteChannel in class FileSystemProvider
    
    Throws:
    
    IOException
  - newDirectoryStream
```
public DirectoryStream<Path> newDirectoryStream(Path dir,
                                       DirectoryStream.Filter<? super Path> filter)
                                         throws IOException
```
    Specified by:
    
    newDirectoryStream in class FileSystemProvider
    
    Throws:
    
    IOException
  - newFileSystem
```
public TFileSystem newFileSystem(Path path,
                        Map<String,?> configuration)
```
    Scans the given path for prospective archive files using the given configuration and returns the file system for the innermost prospective archive file or throws an UnsupportedOperationException if no prospective archive file is detected.
    First, the configuration TFileSystemProvider.Parameters get enumerated. If no value is set for a parameter key, the respective value of the current configuration gets used.
    Next, the path is scanned for prospective archive files using the configuration resulting from the first step. If one or more prospective archive files are found, the file system for the innermost prospective archive file is returned. Otherwise, an UnsupportedOperationException is thrown.
    
    Overrides:
    
    newFileSystem in class FileSystemProvider
    
    Parameters:
    path - the path to scan for prospective archive files.
    configuration - may contain a TArchiveDetector for the key TFileSystemProvider.Parameter.ARCHIVE_DETECTOR.
    
    Returns:
    the file system for the innermost prospective archive file.
    
    Throws:
    
    UnsupportedOperationException - if no prospective archive file has been detected according to the configuration resulting from merging the given configuration with the current configuration.
  - newFileSystem
```
public TFileSystem newFileSystem(URI uri,
                        Map<String,?> configuration)
```
    Returns a file system for the given hierarchical TPath uri.
    First, the configuration TFileSystemProvider.Parameters get enumerated. If no value is set for a parameter key, the respective value of the current configuration gets used.
    Next, the uri is scanned for prospective archive files using the configuration resulting from the first step. Any trailing separators in uri get discarded. If one or more prospective archive files are found, the file system for the innermost prospective archive file is returned. Otherwise, the file system for the innermost directory is returned.
    
    Specified by:
    
    newFileSystem in class FileSystemProvider
    
    Parameters:
    uri - the TPath uri to return a file system for.
    configuration - may contain a TArchiveDetector for the key TFileSystemProvider.Parameter.ARCHIVE_DETECTOR.
    
    Returns:
    the file system for the innermost prospective archive file or directory.
    
    Throws:
    
    IllegalArgumentException - if the given uri is opaque.
  - newInputStream
```
public InputStream newInputStream(Path path,
                         OpenOption... options)
                           throws IOException
```
    Overrides:
    
    newInputStream in class FileSystemProvider
    
    Throws:
    
    IOException
  - newOutputStream
```
public OutputStream newOutputStream(Path path,
                           OpenOption... options)
                             throws IOException
```
    Overrides:
    
    newOutputStream in class FileSystemProvider
    
    Throws:
    
    IOException
  - promote
```
private static TPath promote(Path path)
```
  - push
```
private static TConfig push(Map<String,?> env)
```
  - readAttributes
```
public <A extends BasicFileAttributes> A readAttributes(Path path,
                                               Class<A> type,
                                               LinkOption... options)
                                             throws IOException
```
    Specified by:
    
    readAttributes in class FileSystemProvider
    
    Throws:
    
    IOException
  - readAttributes
```
public Map<String,Object> readAttributes(Path path,
                                String attributes,
                                LinkOption... options)
                                  throws IOException
```
    Specified by:
    
    readAttributes in class FileSystemProvider
    
    Throws:
    
    UnsupportedOperationException - always
    
    IOException
  - setAttribute
```
public void setAttribute(Path path,
                String attribute,
                Object value,
                LinkOption... options)
                  throws IOException
```
    Specified by:
    
    setAttribute in class FileSystemProvider
    
    Throws:
    
    UnsupportedOperationException - always
    
    IOException
  - umount
```
public static void umount()
                   throws FsSyncException
```
    Commits all unsynchronized changes to the contents of all federated file systems (i.e. prospective archive files) to their respective parent file system, releases the associated resources (i.e. 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 files may get used even if the archive files where accessed read-only.
    
    Throws:
    
    FsSyncWarningException - if only warning conditions occur. This implies that the respective parent file system has been updated with constraints, such as a failure to set the last modification time of the entry for the federated file system (i.e. archive file) in its parent file system.
    
    FsSyncException - if any error conditions occur. This implies loss of data!

Class TFileSystemProvider

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.nio.file.spi.FileSystemProvider

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ROOT_MOUNT_POINT

DEFAULT_ROOT_MOUNT_POINT_URI

DEFAULT_SCHEME

fileSystems

manager

providers

root

scheme

Constructor Detail

TFileSystemProvider

Method Detail

checkAccess

copy

copy

createDirectory

delete

delete

get

getFileAttributeView

getFileStore

getFileSystem

getFileSystem

getPath

getRoot

getScheme

isHidden

isSameFile

isSameFile0

move

move

newByteChannel

newDirectoryStream

newFileSystem

newFileSystem

newInputStream

newOutputStream

promote

push

readAttributes

readAttributes

setAttribute

umount