net.java.truevfs.access

Class TFileSystemProvider

java.lang.Object

java.nio.file.spi.FileSystemProvider

net.java.truevfs.access.TFileSystemProvider

@ThreadSafe
 @ServiceImplementation(value=java.nio.file.spi.FileSystemProvider.class)
public final class TFileSystemProvider
extends java.nio.file.spi.FileSystemProvider

A FileSystemProvider implementation for use with NIO.2.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TFileSystemProvider.Parameter Keys for environment maps.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ROOT_MOUNT_POINT The root mount point of the provider for the public no-arg constructor.
static java.lang.String	DEFAULT_SCHEME The scheme of the provider for the public no-arg constructor.

Constructor Summary

Constructors

Constructor and Description
TFileSystemProvider() Deprecated. This constructor is solely provided in order to use this file system provider class with the service location feature of the NIO.2 API!

Method Summary

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)
void	createDirectory(java.nio.file.Path dir, java.nio.file.attribute.FileAttribute<?>... attrs)
void	delete(java.nio.file.Path path)
<V extends java.nio.file.attribute.FileAttributeView> V	getFileAttributeView(java.nio.file.Path path, java.lang.Class<V> type, java.nio.file.LinkOption... options)
java.nio.file.FileStore	getFileStore(java.nio.file.Path path)
TFileSystem	getFileSystem(java.net.URI uri) Returns a file system for the given hierarchical TPath uri.
TPath	getPath(java.net.URI name) Returns a TPath for the given hierarchical name.
java.lang.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)
void	move(java.nio.file.Path source, java.nio.file.Path target, java.nio.file.CopyOption... options)
java.nio.channels.SeekableByteChannel	newByteChannel(java.nio.file.Path path, java.util.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, java.util.Map<java.lang.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(java.net.URI uri, java.util.Map<java.lang.String,?> configuration) Returns a file system for the given hierarchical TPath uri.
java.io.InputStream	newInputStream(java.nio.file.Path path, java.nio.file.OpenOption... options)
java.io.OutputStream	newOutputStream(java.nio.file.Path path, java.nio.file.OpenOption... options)
<A extends java.nio.file.attribute.BasicFileAttributes> A	readAttributes(java.nio.file.Path path, java.lang.Class<A> type, java.nio.file.LinkOption... options)
java.util.Map<java.lang.String,java.lang.Object>	readAttributes(java.nio.file.Path path, java.lang.String attributes, java.nio.file.LinkOption... options)
void	setAttribute(java.nio.file.Path path, java.lang.String attribute, java.lang.Object value, java.nio.file.LinkOption... options)

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 java.lang.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 java.lang.String DEFAULT_ROOT_MOUNT_POINT

The root mount point of the provider for the public no-arg constructor.

See Also:

Constant Field Values

Constructor Detail

TFileSystemProvider

@Deprecated
public TFileSystemProvider()

Deprecated. This constructor is solely provided in order to use this file system provider class with the service location feature of the NIO.2 API!

Constructs a new TrueVFS file system provider which is identified by the URI scheme "tpath" for accessing any path within the root mount point URI "file:/".

Method Detail

getScheme

public java.lang.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.

newFileSystem

public TFileSystem newFileSystem(java.nio.file.Path path,
                                 java.util.Map<java.lang.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 current 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:

java.lang.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(java.net.URI uri,
                                 java.util.Map<java.lang.String,?> configuration)

Returns a file system for the given hierarchical TPath uri.

First, the configuration TFileSystemProvider.Parameters current 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 current 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:

java.lang.IllegalArgumentException - if the given uri is opaque.

getFileSystem

public TFileSystem getFileSystem(java.net.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 current 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:

java.lang.IllegalArgumentException - if the given uri is opaque.

getPath

public TPath getPath(java.net.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 current discarded.

Specified by:

getPath in class java.nio.file.spi.FileSystemProvider

Parameters:

name - the uri to return a TPath for.

Returns:

the TPath

Throws:

java.lang.IllegalArgumentException - if the given uri is opaque.

newByteChannel

public java.nio.channels.SeekableByteChannel newByteChannel(java.nio.file.Path path,
                                                            java.util.Set<? extends java.nio.file.OpenOption> options,
                                                            java.nio.file.attribute.FileAttribute<?>... attrs)
                                                     throws java.io.IOException

Specified by:

newByteChannel in class java.nio.file.spi.FileSystemProvider

Throws:

java.io.IOException

newInputStream

public java.io.InputStream newInputStream(java.nio.file.Path path,
                                          java.nio.file.OpenOption... options)
                                   throws java.io.IOException

Overrides:

newInputStream in class java.nio.file.spi.FileSystemProvider

Throws:

java.io.IOException

newOutputStream

public java.io.OutputStream newOutputStream(java.nio.file.Path path,
                                            java.nio.file.OpenOption... options)
                                     throws java.io.IOException

Overrides:

newOutputStream in class java.nio.file.spi.FileSystemProvider

Throws:

java.io.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 java.io.IOException

Specified by:

newDirectoryStream in class java.nio.file.spi.FileSystemProvider

Throws:

java.io.IOException

createDirectory

public void createDirectory(java.nio.file.Path dir,
                            java.nio.file.attribute.FileAttribute<?>... attrs)
                     throws java.io.IOException

Specified by:

createDirectory in class java.nio.file.spi.FileSystemProvider

Throws:

java.io.IOException

delete

public void delete(java.nio.file.Path path)
            throws java.io.IOException

Specified by:

delete in class java.nio.file.spi.FileSystemProvider

Throws:

java.io.IOException

copy

public void copy(java.nio.file.Path source,
                 java.nio.file.Path target,
                 java.nio.file.CopyOption... options)
          throws java.io.IOException

Specified by:

copy in class java.nio.file.spi.FileSystemProvider

Throws:

java.io.IOException

move

public void move(java.nio.file.Path source,
                 java.nio.file.Path target,
                 java.nio.file.CopyOption... options)
          throws java.io.IOException

Specified by:

move in class java.nio.file.spi.FileSystemProvider

Throws:

java.io.IOException

isSameFile

public boolean isSameFile(java.nio.file.Path a,
                          java.nio.file.Path b)
                   throws java.io.IOException

Specified by:

isSameFile in class java.nio.file.spi.FileSystemProvider

Throws:

java.io.IOException

isHidden

public boolean isHidden(java.nio.file.Path path)
                 throws java.io.IOException

Specified by:

isHidden in class java.nio.file.spi.FileSystemProvider

Throws:

java.io.IOException

getFileStore

public java.nio.file.FileStore getFileStore(java.nio.file.Path path)
                                     throws java.io.IOException

Specified by:

getFileStore in class java.nio.file.spi.FileSystemProvider

Throws:

java.io.IOException

checkAccess

public void checkAccess(java.nio.file.Path path,
                        java.nio.file.AccessMode... modes)
                 throws java.io.IOException

Specified by:

checkAccess in class java.nio.file.spi.FileSystemProvider

Throws:

java.io.IOException

getFileAttributeView

@Nullable
public <V extends java.nio.file.attribute.FileAttributeView> V getFileAttributeView(java.nio.file.Path path,
                                                                                              java.lang.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,
                                                                                java.lang.Class<A> type,
                                                                                java.nio.file.LinkOption... options)
                                                                         throws java.io.IOException

Specified by:

readAttributes in class java.nio.file.spi.FileSystemProvider

Throws:

java.io.IOException

readAttributes

public java.util.Map<java.lang.String,java.lang.Object> readAttributes(java.nio.file.Path path,
                                                                       java.lang.String attributes,
                                                                       java.nio.file.LinkOption... options)
                                                                throws java.io.IOException

Specified by:

readAttributes in class java.nio.file.spi.FileSystemProvider

Throws:

java.io.IOException

setAttribute

public void setAttribute(java.nio.file.Path path,
                         java.lang.String attribute,
                         java.lang.Object value,
                         java.nio.file.LinkOption... options)
                  throws java.io.IOException

Specified by:

setAttribute in class java.nio.file.spi.FileSystemProvider

Throws:

java.io.IOException