TPath (TrueZIP Path 7.2-beta-1 API)

java.lang.Object
- de.schlichtherle.truezip.nio.fsp.TPath

All Implemented Interfaces:

Comparable<java.nio.file.Path>, Iterable<java.nio.file.Path>, java.nio.file.Path, java.nio.file.Watchable
```
@Immutable
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public final class TPath
extends Object
implements java.nio.file.Path
```
A path implementation for the TrueZIP FileSystemProvider.

Author:

Christian Schlichtherle

Field Summary

Fields
Modifier and Type	Field and Description
`private static FsMountPoint`	`CURRENT_DIRECTORY`
`private TArchiveDetector`	`detector`
`private TFileSystem`	`fileSystem`
`private Integer`	`hashCode`
`private FsPath`	`path`
`private URI`	`uri`

Constructor Summary

Constructors
Modifier	Constructor and Description
`(package private)`	`TPath(FsPath parent, TArchiveDetector detector, String first, String... more)`
`(package private)`	`TPath(java.nio.file.Path path)`
	`TPath(String first, String... more)`
`(package private)`	`TPath(TArchiveDetector detector, java.nio.file.Path path)`
	`TPath(TArchiveDetector detector, String first, String... more)`
	`TPath(TArchiveDetector detector, URI uri)`
`private`	`TPath(TArchiveDetector detector, URI uri, FsPath path)`
	`TPath(TPath parent, String first, String... more)`
	`TPath(TPath parent, TArchiveDetector detector, String first, String... more)`
	`TPath(URI uri)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(java.nio.file.Path that)`
`(package private) void`	`createDirectory(java.nio.file.attribute.FileAttribute<?>... attrs)`
`(package private) void`	`delete()`
`boolean`	`endsWith(java.nio.file.Path that)`
`boolean`	`endsWith(String other)`
`boolean`	`equals(Object other)`
`TArchiveDetector`	`getArchiveDetector()` Returns the `TArchiveDetector` that was used to detect any archive files in the path of this `TPath` object at construction time.
`(package private) FsController<?>`	`getController()`
`static TArchiveDetector`	`getDefaultArchiveDetector()` Returns the `TArchiveDetector` to use if no archive detector is explicitly passed to the constructor of a `TPath` instance.
`(package private) FsEntry`	`getEntry()`
`TPath`	`getFileName()`
`TFileSystem`	`getFileSystem()`
`InputSocket<?>`	`getInputSocket(BitField<FsInputOption> options)`
`TPath`	`getName(int index)`
`int`	`getNameCount()`
`OutputSocket<?>`	`getOutputSocket(BitField<FsOutputOption> options, Entry template)`
`TPath`	`getParent()`
`(package private) FsPath`	`getPath()`
`TPath`	`getRoot()`
`(package private) URI`	`getUri()`
`int`	`hashCode()`
`private boolean`	`invariants()` Checks the invariants of this class and throws an AssertionError if any is violated even if assertion checking is disabled.
`boolean`	`isAbsolute()`
`boolean`	`isArchive()` Returns `true` if and only if this `TPath` addresses an archive file.
`boolean`	`isEntry()` Returns `true` if and only if this `TPath` addresses an entry located within an archive file.
`Iterator<java.nio.file.Path>`	`iterator()`
`(package private) java.nio.file.DirectoryStream<java.nio.file.Path>`	`newDirectoryStream(java.nio.file.DirectoryStream.Filter<? super java.nio.file.Path> filter)`
`TPath`	`normalize()`
`(package private) static TPath`	`promote(java.nio.file.Path path)`
`java.nio.file.WatchKey`	`register(java.nio.file.WatchService watcher, java.nio.file.WatchEvent.Kind<?>... events)`
`java.nio.file.WatchKey`	`register(java.nio.file.WatchService watcher, java.nio.file.WatchEvent.Kind<?>[] events, java.nio.file.WatchEvent.Modifier... modifiers)`
`TPath`	`relativize(java.nio.file.Path other)`
`java.nio.file.Path`	`resolve(java.nio.file.Path other)`
`TPath`	`resolve(String other)`
`TPath`	`resolveSibling(java.nio.file.Path other)`
`TPath`	`resolveSibling(String other)`
`static void`	`setDefaultArchiveDetector(TArchiveDetector detector)` Sets the `TArchiveDetector` to use if no archive detector is explicitly passed to the constructor of a `TPath` instance.
`boolean`	`startsWith(java.nio.file.Path that)`
`boolean`	`startsWith(String other)`
`TPath`	`subpath(int beginIndex, int endIndex)`
`TPath`	`toAbsolutePath()`
`TFile`	`toFile()`
`private FsPath`	`toPath(URI uri)`
`TPath`	`toRealPath(java.nio.file.LinkOption... options)`
`String`	`toString()`
`URI`	`toUri()`
`private static URI`	`uri(String first, String... more)`

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

- Field Detail
  - CURRENT_DIRECTORY
```
private static final FsMountPoint CURRENT_DIRECTORY
```
  - detector
```
private final TArchiveDetector detector
```
  - uri
```
private final URI uri
```
  - path
```
private volatile FsPath path
```
  - fileSystem
```
private volatile TFileSystem fileSystem
```
  - hashCode
```
private volatile Integer hashCode
```
- Constructor Detail
  - TPath
```
public TPath(String first,
     String... more)
```
  - TPath
```
public TPath(@CheckForNull
     TArchiveDetector detector,
     String first,
     String... more)
```
  - TPath
```
public TPath(TPath parent,
     String first,
     String... more)
```
  - TPath
```
public TPath(TPath parent,
     @CheckForNull
     TArchiveDetector detector,
     String first,
     String... more)
```
  - TPath
```
TPath(FsPath parent,
     @CheckForNull
     TArchiveDetector detector,
     String first,
     String... more)
```
  - TPath
```
public TPath(URI uri)
```
  - TPath
```
public TPath(@CheckForNull
     TArchiveDetector detector,
     URI uri)
```
  - TPath
```
private TPath(TArchiveDetector detector,
     URI uri,
     @CheckForNull
     FsPath path)
```
  - TPath
```
TPath(java.nio.file.Path path)
```
  - TPath
```
TPath(@CheckForNull
     TArchiveDetector detector,
     java.nio.file.Path path)
```
- Method Detail
  - uri
```
private static URI uri(String first,
      String... more)
```
  - invariants
```
private boolean invariants()
```
    Checks the invariants of this class and throws an AssertionError if any is violated even if assertion checking is disabled.
    The constructors call this method like this:
```
assert invariants();
```
    This calls the method if and only if assertions are enabled in order to assert that the instance invariants are properly obeyed. If assertions are disabled, the call to this method is thrown away by the HotSpot compiler, so there is no performance penalty.
    Returns:
    true
    
    Throws:
    
    AssertionError - If assertions are enabled and any invariant is violated.
  - getArchiveDetector
```
public TArchiveDetector getArchiveDetector()
```
    Returns the TArchiveDetector that was used to detect any archive files in the path of this TPath object at construction time.
    
    Returns:
    The TArchiveDetector that was used to detect any archive files in the path of this file object at construction time.
  - isArchive
```
public boolean isArchive()
```
    Returns true if and only if this TPath addresses an archive file. Whether or not this is true solely depends on the TArchiveDetector which was used to construct this TPath - no file system tests are performed by this method!
    
    Returns:
    true if and only if this TPath addresses an archive file.
    See Also:
    isEntry()
  - isEntry
```
public boolean isEntry()
```
    Returns true if and only if this TPath addresses an entry located within an archive file. Whether or not this is true solely depends on the TArchiveDetector which was used to construct this TPath - no file system tests are performed by this method!
    
    Returns:
    true if and only if this TPath addresses an entry located within an archive file.
    See Also:
    isArchive()
  - getDefaultArchiveDetector
```
public static TArchiveDetector getDefaultArchiveDetector()
```
    Returns the TArchiveDetector to use if no archive detector is explicitly passed to the constructor of a TPath instance.
    This class property is initially set to TArchiveDetector.ALL
    
    Returns:
    The TArchiveDetector to use if no archive detector is explicitly passed to the constructor of a TPath instance.
    See Also:
    setDefaultArchiveDetector(de.schlichtherle.truezip.file.TArchiveDetector)
  - setDefaultArchiveDetector
```
public static void setDefaultArchiveDetector(TArchiveDetector detector)
```
    Sets the TArchiveDetector to use if no archive detector is explicitly passed to the constructor of a TPath instance. When a new TPath instance is constructed, but no archive detector is provided, then the value of this class property is used. So changing the value of this class property affects only subsequently constructed TPath instances - not any existing ones.
    
    Parameters:
    detector - the TArchiveDetector to use for subsequently constructed TPath instances if no archive detector is explicitly provided to the constructor
    See Also:
    getDefaultArchiveDetector()
  - getUri
```
URI getUri()
```
  - getPath
```
FsPath getPath()
```
  - toPath
```
private FsPath toPath(URI uri)
```
  - getFileSystem
```
public TFileSystem getFileSystem()
```
    Specified by:
    
    getFileSystem in interface java.nio.file.Path
  - isAbsolute
```
public boolean isAbsolute()
```
    Specified by:
    
    isAbsolute in interface java.nio.file.Path
  - getRoot
```
@Nullable
public TPath getRoot()
```
    Specified by:
    
    getRoot in interface java.nio.file.Path
  - getFileName
```
public TPath getFileName()
```
    Specified by:
    
    getFileName in interface java.nio.file.Path
  - getParent
```
public TPath getParent()
```
    Specified by:
    
    getParent in interface java.nio.file.Path
  - getNameCount
```
public int getNameCount()
```
    Specified by:
    
    getNameCount in interface java.nio.file.Path
  - getName
```
public TPath getName(int index)
```
    Specified by:
    
    getName in interface java.nio.file.Path
  - subpath
```
public TPath subpath(int beginIndex,
            int endIndex)
```
    Specified by:
    
    subpath in interface java.nio.file.Path
  - promote
```
static TPath promote(java.nio.file.Path path)
```
  - startsWith
```
public boolean startsWith(java.nio.file.Path that)
```
    Specified by:
    
    startsWith in interface java.nio.file.Path
  - startsWith
```
public boolean startsWith(String other)
```
    Specified by:
    
    startsWith in interface java.nio.file.Path
  - endsWith
```
public boolean endsWith(java.nio.file.Path that)
```
    Specified by:
    
    endsWith in interface java.nio.file.Path
  - endsWith
```
public boolean endsWith(String other)
```
    Specified by:
    
    endsWith in interface java.nio.file.Path
  - normalize
```
public TPath normalize()
```
    Specified by:
    
    normalize in interface java.nio.file.Path
  - resolve
```
public java.nio.file.Path resolve(java.nio.file.Path other)
```
    Specified by:
    
    resolve in interface java.nio.file.Path
  - resolve
```
public TPath resolve(String other)
```
    Specified by:
    
    resolve in interface java.nio.file.Path
  - resolveSibling
```
public TPath resolveSibling(java.nio.file.Path other)
```
    Specified by:
    
    resolveSibling in interface java.nio.file.Path
  - resolveSibling
```
public TPath resolveSibling(String other)
```
    Specified by:
    
    resolveSibling in interface java.nio.file.Path
  - relativize
```
public TPath relativize(java.nio.file.Path other)
```
    Specified by:
    
    relativize in interface java.nio.file.Path
  - toFile
```
public TFile toFile()
```
    Specified by:
    
    toFile in interface java.nio.file.Path
  - toUri
```
public URI toUri()
```
    Specified by:
    
    toUri in interface java.nio.file.Path
  - toAbsolutePath
```
public TPath toAbsolutePath()
```
    Specified by:
    
    toAbsolutePath in interface java.nio.file.Path
  - toRealPath
```
public TPath toRealPath(java.nio.file.LinkOption... options)
                 throws IOException
```
    Specified by:
    
    toRealPath in interface java.nio.file.Path
    
    Throws:
    
    IOException
  - register
```
public java.nio.file.WatchKey register(java.nio.file.WatchService watcher,
                              java.nio.file.WatchEvent.Kind<?>[] events,
                              java.nio.file.WatchEvent.Modifier... modifiers)
                                throws IOException
```
    Specified by:
    
    register in interface java.nio.file.Path
    
    Specified by:
    
    register in interface java.nio.file.Watchable
    
    Throws:
    
    IOException
  - register
```
public java.nio.file.WatchKey register(java.nio.file.WatchService watcher,
                              java.nio.file.WatchEvent.Kind<?>... events)
                                throws IOException
```
    Specified by:
    
    register in interface java.nio.file.Path
    
    Specified by:
    
    register in interface java.nio.file.Watchable
    
    Throws:
    
    IOException
  - iterator
```
public Iterator<java.nio.file.Path> iterator()
```
    Specified by:
    
    iterator in interface Iterable<java.nio.file.Path>
    
    Specified by:
    
    iterator in interface java.nio.file.Path
  - equals
```
public boolean equals(Object other)
```
    Specified by:
    
    equals in interface java.nio.file.Path
    
    Overrides:
    
    equals in class Object
  - compareTo
```
public int compareTo(java.nio.file.Path that)
```
    Specified by:
    
    compareTo in interface Comparable<java.nio.file.Path>
    
    Specified by:
    
    compareTo in interface java.nio.file.Path
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.nio.file.Path
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface java.nio.file.Path
    
    Overrides:
    
    toString in class Object
  - getController
```
FsController<?> getController()
                        throws IOException
```
    Throws:
    
    IOException
  - getEntry
```
FsEntry getEntry()
           throws IOException
```
    Throws:
    
    IOException
  - getInputSocket
```
public InputSocket<?> getInputSocket(BitField<FsInputOption> options)
```
  - getOutputSocket
```
public OutputSocket<?> getOutputSocket(BitField<FsOutputOption> options,
                              @CheckForNull
                              Entry template)
```
  - newDirectoryStream
```
java.nio.file.DirectoryStream<java.nio.file.Path> newDirectoryStream(java.nio.file.DirectoryStream.Filter<? super java.nio.file.Path> filter)
                                                               throws IOException
```
    Throws:
    
    IOException
  - createDirectory
```
void createDirectory(java.nio.file.attribute.FileAttribute<?>... attrs)
               throws IOException
```
    Throws:
    
    IOException
  - delete
```
void delete()
      throws IOException
```
    Throws:
    
    IOException

Class TPath

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CURRENT_DIRECTORY

detector

uri

path

fileSystem

hashCode

Constructor Detail

TPath

TPath

TPath

TPath

TPath

TPath

TPath

TPath

TPath

TPath

Method Detail

uri

invariants

getArchiveDetector

isArchive

isEntry

getDefaultArchiveDetector

setDefaultArchiveDetector

getUri

getPath

toPath

getFileSystem

isAbsolute

getRoot

getFileName

getParent

getNameCount

getName

subpath

promote

startsWith

startsWith

endsWith

endsWith

normalize

resolve

resolve

resolveSibling

resolveSibling

relativize

toFile

toUri

toAbsolutePath

toRealPath

register

register

iterator

equals

compareTo

hashCode

toString

getController

getEntry

getInputSocket

getOutputSocket

newDirectoryStream

createDirectory

delete