TFileSystem (TrueZIP Path 7.5.1 API)

java.lang.Object
- java.nio.file.FileSystem
- - de.schlichtherle.truezip.nio.file.TFileSystem

All Implemented Interfaces:

Closeable, AutoCloseable
```
@ThreadSafe
public final class TFileSystem
extends java.nio.file.FileSystem
```
A FileSystem 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 class`	`TFileSystem.FsEntryAttributes`
`private class`	`TFileSystem.FsEntryAttributeView`
`private static class`	`TFileSystem.Stream`

Field Summary

Fields
Modifier and Type Field and Description

private de.schlichtherle.truezip.fs.FsController<?> controller

private TFileSystemProvider provider

Fields
Modifier and Type	Field and Description
`private de.schlichtherle.truezip.fs.FsController<?>`	`controller`
`private TFileSystemProvider`	`provider`

Constructor Summary

Constructors
Constructor and Description

TFileSystem(TPath path)

Constructors
Constructor and Description
`TFileSystem(TPath path)`

Method Summary

Methods
Modifier and Type	Method and Description
`(package private) void`	`checkAccess(TPath path, java.nio.file.AccessMode... modes)`
`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.
`(package private) void`	`createDirectory(TPath path, java.nio.file.attribute.FileAttribute<?>... attrs)`
`(package private) void`	`delete(TPath path)`
`private de.schlichtherle.truezip.fs.FsController<?>`	`getController()`
`(package private) de.schlichtherle.truezip.fs.FsEntry`	`getEntry(TPath path)`
`(package private) <V extends java.nio.file.attribute.FileAttributeView> V`	`getFileAttributeView(TPath path, Class<V> type, java.nio.file.LinkOption... options)`
`Iterable<java.nio.file.FileStore>`	`getFileStores()`
`(package private) de.schlichtherle.truezip.socket.InputSocket<?>`	`getInputSocket(TPath path, de.schlichtherle.truezip.util.BitField<de.schlichtherle.truezip.fs.FsInputOption> options)`
`(package private) de.schlichtherle.truezip.fs.FsMountPoint`	`getMountPoint()`
`(package private) de.schlichtherle.truezip.socket.OutputSocket<?>`	`getOutputSocket(TPath path, de.schlichtherle.truezip.util.BitField<de.schlichtherle.truezip.fs.FsOutputOption> options, de.schlichtherle.truezip.entry.Entry template)`
`TPath`	`getPath(String first, String... more)` Constructs a new path from the given sub path strings.
`java.nio.file.PathMatcher`	`getPathMatcher(String syntaxAndPattern)`
`Iterable<java.nio.file.Path>`	`getRootDirectories()`
`String`	`getSeparator()` Returns `File.separator`.
`java.nio.file.attribute.UserPrincipalLookupService`	`getUserPrincipalLookupService()`
`private boolean`	`invariants()`
`static boolean`	`isLenient()` Equivalent to `TConfig.get().isLenient()`.
`boolean`	`isOpen()` Returns `true`.
`boolean`	`isReadOnly()` Returns `false`.
`(package private) SeekableByteChannel`	`newByteChannel(TPath path, Set<? extends java.nio.file.OpenOption> options, java.nio.file.attribute.FileAttribute<?>... attrs)`
`(package private) java.nio.file.DirectoryStream<java.nio.file.Path>`	`newDirectoryStream(TPath path, java.nio.file.DirectoryStream.Filter<? super java.nio.file.Path> filter)`
`(package private) InputStream`	`newInputStream(TPath path, java.nio.file.OpenOption... options)`
`(package private) OutputStream`	`newOutputStream(TPath path, java.nio.file.OpenOption... options)`
`java.nio.file.WatchService`	`newWatchService()`
`TFileSystemProvider`	`provider()`
`(package private) <A extends java.nio.file.attribute.BasicFileAttributes> A`	`readAttributes(TPath path, Class<A> type, java.nio.file.LinkOption... options)`
`static void`	`setLenient(boolean lenient)` Equivalent to `TConfig.get().setLenient(lenient)`.
`Set<String>`	`supportedFileAttributeViews()`
`void`	`sync(de.schlichtherle.truezip.util.BitField<de.schlichtherle.truezip.fs.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

Field Detail

controller

private final de.schlichtherle.truezip.fs.FsController<?> controller

provider

private final TFileSystemProvider provider

Constructor Detail
- TFileSystem
```
TFileSystem(TPath path)
```

Method Detail

checkAccess

void checkAccess(TPath path,
               java.nio.file.AccessMode... modes)
           throws IOException

Throws:: IOException

close
```
public void close()
           throws de.schlichtherle.truezip.fs.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 java.nio.file.FileSystem

Throws:

de.schlichtherle.truezip.fs.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.

de.schlichtherle.truezip.fs.FsSyncException - if any error conditions apply. This implies some loss of data!
See Also:
sync(BitField)

createDirectory

void createDirectory(TPath path,
                   java.nio.file.attribute.FileAttribute<?>... attrs)
               throws IOException

Throws:: IOException

delete

void delete(TPath path)
      throws IOException

Throws:: IOException

getController

private de.schlichtherle.truezip.fs.FsController<?> getController()

getEntry

de.schlichtherle.truezip.fs.FsEntry getEntry(TPath path)
                                       throws IOException

Throws:: IOException

getFileAttributeView

@Nullable
<V extends java.nio.file.attribute.FileAttributeView> V getFileAttributeView(TPath path,
                                                                                    Class<V> type,
                                                                                    java.nio.file.LinkOption... options)

getFileStores
```
public Iterable<java.nio.file.FileStore> getFileStores()
```
Specified by:

getFileStores in class java.nio.file.FileSystem

Throws:

UnsupportedOperationException - always

getInputSocket

de.schlichtherle.truezip.socket.InputSocket<?> getInputSocket(TPath path,
                                                            de.schlichtherle.truezip.util.BitField<de.schlichtherle.truezip.fs.FsInputOption> options)

getMountPoint

de.schlichtherle.truezip.fs.FsMountPoint getMountPoint()

getOutputSocket

de.schlichtherle.truezip.socket.OutputSocket<?> getOutputSocket(TPath path,
                                                              de.schlichtherle.truezip.util.BitField<de.schlichtherle.truezip.fs.FsOutputOption> options,
                                                              @CheckForNull
                                                              de.schlichtherle.truezip.entry.Entry template)

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 default archive detector.
The supported path name separators are "File.separator" and "/". Any leading and trailing separators in the resulting path name get discarded.

Specified by:

getPath in class java.nio.file.FileSystem

Parameters:
first - the first sub path string.
more - optional sub path strings.

getPathMatcher
```
public java.nio.file.PathMatcher getPathMatcher(String syntaxAndPattern)
```
Specified by:

getPathMatcher in class java.nio.file.FileSystem

Throws:

UnsupportedOperationException - always

getRootDirectories
```
public Iterable<java.nio.file.Path> getRootDirectories()
```
Specified by:

getRootDirectories in class java.nio.file.FileSystem

getSeparator
```
public String getSeparator()
```
Returns File.separator.

Specified by:

getSeparator in class java.nio.file.FileSystem

Returns:
File.separator.

getUserPrincipalLookupService
```
public java.nio.file.attribute.UserPrincipalLookupService getUserPrincipalLookupService()
```
Specified by:

getUserPrincipalLookupService in class java.nio.file.FileSystem

Throws:

UnsupportedOperationException - always

invariants
```
private boolean invariants()
```

isLenient
```
public static boolean isLenient()
```
Equivalent to TConfig.get().isLenient().

isOpen
```
public boolean isOpen()
```
Returns true.

Specified by:

isOpen in class java.nio.file.FileSystem

Returns:
true.

isReadOnly
```
public boolean isReadOnly()
```
Returns false.

Specified by:

isReadOnly in class java.nio.file.FileSystem

Returns:
false.

newByteChannel

SeekableByteChannel newByteChannel(TPath path,
                                 Set<? extends java.nio.file.OpenOption> options,
                                 java.nio.file.attribute.FileAttribute<?>... attrs)
                             throws IOException

Throws:: IOException

newDirectoryStream

java.nio.file.DirectoryStream<java.nio.file.Path> newDirectoryStream(TPath path,
                                                                   java.nio.file.DirectoryStream.Filter<? super java.nio.file.Path> filter)
                                                               throws IOException

Throws:: IOException

newInputStream

InputStream newInputStream(TPath path,
                         java.nio.file.OpenOption... options)
                     throws IOException

Throws:: IOException

newOutputStream

OutputStream newOutputStream(TPath path,
                           java.nio.file.OpenOption... options)
                       throws IOException

Throws:: IOException

newWatchService
```
public java.nio.file.WatchService newWatchService()
                                           throws IOException
```
Specified by:

newWatchService in class java.nio.file.FileSystem

Throws:

UnsupportedOperationException - always

IOException

provider
```
public TFileSystemProvider provider()
```
Specified by:

provider in class java.nio.file.FileSystem

readAttributes

<A extends java.nio.file.attribute.BasicFileAttributes> A readAttributes(TPath path,
                                                                       Class<A> type,
                                                                       java.nio.file.LinkOption... options)
                                                               throws IOException

Throws:: IOException

setLenient
```
public static void setLenient(boolean lenient)
```
Equivalent to TConfig.get().setLenient(lenient).

supportedFileAttributeViews
```
public Set<String> supportedFileAttributeViews()
```
Specified by:

supportedFileAttributeViews in class java.nio.file.FileSystem

sync
```
public void sync(de.schlichtherle.truezip.util.BitField<de.schlichtherle.truezip.fs.FsSyncOption> options)
          throws de.schlichtherle.truezip.fs.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.

de.schlichtherle.truezip.fs.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.

de.schlichtherle.truezip.fs.FsSyncException - if any error conditions apply. This implies some loss of data!

Class TFileSystem

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

controller

provider

Constructor Detail

TFileSystem

Method Detail

checkAccess

close

createDirectory

delete

getController

getEntry

getFileAttributeView

getFileStores

getInputSocket

getMountPoint

getOutputSocket

getPath

getPathMatcher

getRootDirectories

getSeparator

getUserPrincipalLookupService

invariants

isLenient

isOpen

isReadOnly

newByteChannel

newDirectoryStream

newInputStream

newOutputStream

newWatchService

provider

readAttributes

setLenient

supportedFileAttributeViews

sync