TFileSystemProvider (TrueZIP Path 7.3-rc-1 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 java.nio.file.spi.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
	`TFileSystemProvider()` Deprecated. Do NOT* call this constructor directly!*
`private`	`TFileSystemProvider(String scheme, URI root)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`checkAccess(java.nio.file.Path path, java.nio.file.AccessMode... modes)`
`void`	`copy(java.nio.file.Path source, java.nio.file.Path target, java.nio.file.CopyOption... options)`
`private static void`	`copy(TPath src, TPath dst, java.nio.file.CopyOption... options)`
`void`	`createDirectory(java.nio.file.Path dir, java.nio.file.attribute.FileAttribute<?>... attrs)`
`void`	`delete(java.nio.file.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 java.nio.file.attribute.FileAttributeView> V`	`getFileAttributeView(java.nio.file.Path path, Class<V> type, java.nio.file.LinkOption... options)`
`java.nio.file.FileStore`	`getFileStore(java.nio.file.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(java.nio.file.Path path)`
`boolean`	`isSameFile(java.nio.file.Path a, java.nio.file.Path b)`
`private static boolean`	`isSameFile0(java.nio.file.Path a, java.nio.file.Path b)`
`void`	`move(java.nio.file.Path source, java.nio.file.Path target, java.nio.file.CopyOption... options)`
`private static void`	`move(TPath source, TPath target, java.nio.file.CopyOption... options)`
`SeekableByteChannel`	`newByteChannel(java.nio.file.Path path, Set<? extends java.nio.file.OpenOption> options, java.nio.file.attribute.FileAttribute<?>... attrs)`
`java.nio.file.DirectoryStream<java.nio.file.Path>`	`newDirectoryStream(java.nio.file.Path dir, java.nio.file.DirectoryStream.Filter<? super java.nio.file.Path> filter)`
`TFileSystem`	`newFileSystem(java.nio.file.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(java.nio.file.Path path, java.nio.file.OpenOption... options)`
`OutputStream`	`newOutputStream(java.nio.file.Path path, java.nio.file.OpenOption... options)`
`private static TPath`	`promote(java.nio.file.Path path)`
`private static TConfig`	`push(Map<String,?> env)`
`<A extends java.nio.file.attribute.BasicFileAttributes> A`	`readAttributes(java.nio.file.Path path, Class<A> type, java.nio.file.LinkOption... options)`
`Map<String,Object>`	`readAttributes(java.nio.file.Path path, String attributes, java.nio.file.LinkOption... options)`
`void`	`setAttribute(java.nio.file.Path path, String attribute, Object value, java.nio.file.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_SCHEME
```
public static final String DEFAULT_SCHEME
```
    The scheme of the provider for the public no-arg constructor.
    
    See Also:
    Constant Field Values
  - 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
```
  - manager
```
private static final FsManager manager
```
  - providers
```
private static final Map<String,TFileSystemProvider> providers
```
  - scheme
```
private final String scheme
```
  - root
```
private final FsPath root
```
  - fileSystems
```
private Map<FsMountPoint,TFileSystem> fileSystems
```
- Constructor Detail
  - TFileSystemProvider
```
@Deprecated
public TFileSystemProvider()
```
    Deprecated. Do NOT call this constructor directly!
    
    Constructs a new TrueZIP file system provider which is identified by the URI scheme "tpath" for accessing any path within the root mount point URI "file:/".
    Do NOT call this constructor directly - it's solely provided in order to use this file system provider class with the service location feature of the NIO.2 API!
  - TFileSystemProvider
```
private TFileSystemProvider(String scheme,
                   URI root)
```
- Method Detail
  - 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.
  - 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!
  - getScheme
```
public String getScheme()
```
    Returns the default scheme of this provider.
    
    Specified by:
    
    getScheme in class java.nio.file.spi.FileSystemProvider
    
    Returns:
    the default scheme of this provider.
  - getRoot
```
public FsPath getRoot()
```
    Returns the root mount point of this provider.
    
    Returns:
    The root mount point of this provider.
  - push
```
private static TConfig push(Map<String,?> env)
```
  - newFileSystem
```
public TFileSystem newFileSystem(java.nio.file.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 java.nio.file.spi.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 java.nio.file.spi.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.
  - 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 java.nio.file.spi.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.
  - 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.
  - 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 java.nio.file.spi.FileSystemProvider
    
    Parameters:
    name - the uri to return a TPath for.
    
    Returns:
    the TPath
    
    Throws:
    
    IllegalArgumentException - if the given uri is opaque.
  - newByteChannel
```
public SeekableByteChannel newByteChannel(java.nio.file.Path path,
                                 Set<? extends java.nio.file.OpenOption> options,
                                 java.nio.file.attribute.FileAttribute<?>... attrs)
                                   throws IOException
```
    Specified by:
    
    newByteChannel in class java.nio.file.spi.FileSystemProvider
    
    Throws:
    
    IOException
  - newInputStream
```
public InputStream newInputStream(java.nio.file.Path path,
                         java.nio.file.OpenOption... options)
                           throws IOException
```
    Overrides:
    
    newInputStream in class java.nio.file.spi.FileSystemProvider
    
    Throws:
    
    IOException
  - newOutputStream
```
public OutputStream newOutputStream(java.nio.file.Path path,
                           java.nio.file.OpenOption... options)
                             throws IOException
```
    Overrides:
    
    newOutputStream in class java.nio.file.spi.FileSystemProvider
    
    Throws:
    
    IOException
  - newDirectoryStream
```
public java.nio.file.DirectoryStream<java.nio.file.Path> newDirectoryStream(java.nio.file.Path dir,
                                                                   java.nio.file.DirectoryStream.Filter<? super java.nio.file.Path> filter)
                                                                     throws IOException
```
    Specified by:
    
    newDirectoryStream in class java.nio.file.spi.FileSystemProvider
    
    Throws:
    
    IOException
  - createDirectory
```
public void createDirectory(java.nio.file.Path dir,
                   java.nio.file.attribute.FileAttribute<?>... attrs)
                     throws IOException
```
    Specified by:
    
    createDirectory in class java.nio.file.spi.FileSystemProvider
    
    Throws:
    
    IOException
  - delete
```
public void delete(java.nio.file.Path path)
            throws IOException
```
    Specified by:
    
    delete in class java.nio.file.spi.FileSystemProvider
    
    Throws:
    
    IOException
  - delete
```
private static void delete(TPath path)
                    throws IOException
```
    Throws:
    
    IOException
  - copy
```
public void copy(java.nio.file.Path source,
        java.nio.file.Path target,
        java.nio.file.CopyOption... options)
          throws IOException
```
    Specified by:
    
    copy in class java.nio.file.spi.FileSystemProvider
    
    Throws:
    
    IOException
  - copy
```
private static void copy(TPath src,
        TPath dst,
        java.nio.file.CopyOption... options)
                  throws IOException
```
    Throws:
    
    IOException
  - move
```
public void move(java.nio.file.Path source,
        java.nio.file.Path target,
        java.nio.file.CopyOption... options)
          throws IOException
```
    Specified by:
    
    move in class java.nio.file.spi.FileSystemProvider
    
    Throws:
    
    IOException
  - move
```
private static void move(TPath source,
        TPath target,
        java.nio.file.CopyOption... options)
                  throws IOException
```
    Throws:
    
    IOException
  - isSameFile
```
public boolean isSameFile(java.nio.file.Path a,
                 java.nio.file.Path b)
                   throws IOException
```
    Specified by:
    
    isSameFile in class java.nio.file.spi.FileSystemProvider
    
    Throws:
    
    IOException
  - isSameFile0
```
private static boolean isSameFile0(java.nio.file.Path a,
                  java.nio.file.Path b)
                            throws IOException
```
    Throws:
    
    IOException
  - isHidden
```
public boolean isHidden(java.nio.file.Path path)
                 throws IOException
```
    Specified by:
    
    isHidden in class java.nio.file.spi.FileSystemProvider
    
    Throws:
    
    IOException
  - getFileStore
```
public java.nio.file.FileStore getFileStore(java.nio.file.Path path)
                                     throws IOException
```
    Specified by:
    
    getFileStore in class java.nio.file.spi.FileSystemProvider
    
    Throws:
    
    UnsupportedOperationException - always
    
    IOException
  - checkAccess
```
public void checkAccess(java.nio.file.Path path,
               java.nio.file.AccessMode... modes)
                 throws IOException
```
    Specified by:
    
    checkAccess in class java.nio.file.spi.FileSystemProvider
    
    Throws:
    
    IOException
  - getFileAttributeView
```
@Nullable
public <V extends java.nio.file.attribute.FileAttributeView> V getFileAttributeView(java.nio.file.Path path,
                                                                                    Class<V> type,
                                                                                    java.nio.file.LinkOption... options)
```
    Specified by:
    
    getFileAttributeView in class java.nio.file.spi.FileSystemProvider
  - readAttributes
```
public <A extends java.nio.file.attribute.BasicFileAttributes> A readAttributes(java.nio.file.Path path,
                                                                       Class<A> type,
                                                                       java.nio.file.LinkOption... options)
                                                                     throws IOException
```
    Specified by:
    
    readAttributes in class java.nio.file.spi.FileSystemProvider
    
    Throws:
    
    IOException
  - readAttributes
```
public Map<String,Object> readAttributes(java.nio.file.Path path,
                                String attributes,
                                java.nio.file.LinkOption... options)
                                  throws IOException
```
    Specified by:
    
    readAttributes in class java.nio.file.spi.FileSystemProvider
    
    Throws:
    
    UnsupportedOperationException - always
    
    IOException
  - setAttribute
```
public void setAttribute(java.nio.file.Path path,
                String attribute,
                Object value,
                java.nio.file.LinkOption... options)
                  throws IOException
```
    Specified by:
    
    setAttribute in class java.nio.file.spi.FileSystemProvider
    
    Throws:
    
    UnsupportedOperationException - always
    
    IOException
  - promote
```
private static TPath promote(java.nio.file.Path path)
```

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_SCHEME

DEFAULT_ROOT_MOUNT_POINT

DEFAULT_ROOT_MOUNT_POINT_URI

manager

providers

scheme

root

fileSystems

Constructor Detail

TFileSystemProvider

TFileSystemProvider

Method Detail

get

umount

getScheme

getRoot

push

newFileSystem

newFileSystem

getFileSystem

getFileSystem

getPath

newByteChannel

newInputStream

newOutputStream

newDirectoryStream

createDirectory

delete

delete

copy

copy

move

move

isSameFile

isSameFile0

isHidden

getFileStore

checkAccess

getFileAttributeView

readAttributes

readAttributes

setAttribute

promote