TPath (TrueVFS 0.12.0 API)

java.lang.Object
- net.java.truevfs.access.TPath

All Implemented Interfaces:

Comparable<Path>, Iterable<Path>, Path, Watchable, TRex
```
@Immutable
public final class TPath
extends Object
implements Path, TRex
```
A Path implementation for use with NIO.2. Applications should directly instantiate this class to overcome the restrictions of the file system provider service location in the NIO.2 API for JSE 7. Once created, it's safe to use TPath instances polymorphically as Path instances.
Objects of this class are immutable and inherently volatile because all virtual file system state is managed by the TrueVFS Kernel module.
You should never use object identity ('==') to test for equality of objects of this class with another object. Use the method equals(Object) instead.
Unless otherwise noted, you should not assume that calling the same method on an instance of this class multiple times will return the same object.
Unless otherwise noted, when an instance of this class is created, the resulting path name gets scanned for prospective archive files using the current archive detector TConfig.current().getArchiveDetector(). To change this, wrap the object creation in a code block which pushes a temporary configuration on the inheritbale thread local stack of configurations as follows:
```
 // Create reference to the current directory.
 TPath directory = new TPath("");
 // This is how you would detect a prospective archive file, supposing
 // the JAR of the module TrueVFS Driver ZIP is present on the run time
 // class path.
 TPath archive = directory.resolve("archive.zip");
 TPath file;
 try (TConfig config = TConfig.open()) {
     config.setArchiveDetector(TArchiveDetector.NULL);
     // Ignore prospective archive file here.
     file = directory.resolve("archive.zip");
 }
 // Once created, the prospective archive file detection does not change
 // because a TPath is immutable.
 assert archive.getArchiveDetector() == TArchiveDetector.ALL;
 assert archive.isArchive();
 assert file.getArchiveDetector() == TArchiveDetector.NULL;
 assert !file.isArchive();
 
```
Mind that you should either use archive or file from the previous example to do any subsequent I/O - but not both - so that you don't bypass or corrupt the state which gets implicitly associated with any archive file by the TrueVFS Kernel module!
Author:

Christian Schlichtherle

Constructor Summary

Constructors
Constructor and Description
`TPath(File file)` Constructs a new path from the given file.
`TPath(Path path)` Constructs a new path from the given path.
`TPath(String first, String... more)` Constructs a new path from the given path strings.
`TPath(URI name)` Constructs a new path from the given hierarchical URI.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Path other)` The natural ordering imposed by this implementation is identical to the natural ordering of path's `name`.
`boolean`	`endsWith(Path that)`
`boolean`	`endsWith(String other)`
`boolean`	`equals(Object other)` This path is considered equal to the given `other` object if and only if the other object is identical to this object or if the other object is a `TPath` object with a `file system` which is considered `equal` to this path's file system and a `name` which is considered `equal` to this path's name.
`TArchiveDetector`	`getArchiveDetector()` Returns the `TArchiveDetector` which was used to detect any archive files in the path name of this object at construction time.
`TPath`	`getFileName()`
`TFileSystem`	`getFileSystem()` Returns the `TFileSystem` for this path.
`FsMountPoint`	`getMountPoint()` Returns the file system mount point for this path.
`TPath`	`getName(int index)`
`int`	`getNameCount()`
`FsNodeName`	`getNodeName()` Returns the file system entry name.
`FsNodePath`	`getNodePath()` Returns the file system node path with an absolute URI.
`TPath`	`getParent()`
`TPath`	`getRoot()`
`URI`	`getUri()` Returns the absolute URI for this object.
`int`	`hashCode()` Returns a hash code which is consistent with `equals(Object)`.
`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<Path>`	`iterator()`
`TPath`	`normalize()`
`WatchKey`	`register(WatchService watcher, WatchEvent.Kind<?>... events)`
`WatchKey`	`register(WatchService watcher, WatchEvent.Kind<?>[] events, WatchEvent.Modifier... modifiers)`
`TPath`	`relativize(Path other)`
`TPath`	`resolve(Path other)`
`TPath`	`resolve(String other)`
`TPath`	`resolveSibling(Path other)`
`TPath`	`resolveSibling(String other)`
`boolean`	`startsWith(Path that)`
`boolean`	`startsWith(String other)`
`TPath`	`subpath(int beginIndex, int endIndex)`
`TPath`	`toAbsolutePath()`
`TFile`	`toFile()` Returns a new `TFile` object for this path.
`TPath`	`toNonArchivePath()` Returns a path object for the same path name, but does not detect any archive file name patterns in the last path name segment.
`TPath`	`toPath()` Returns a path representation of this object.
`TPath`	`toRealPath(LinkOption... options)`
`String`	`toString()`
`URI`	`toUri()`

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - TPath
```
public TPath(File file)
```
    Constructs a new path from the given file.
    This constructor is required for interoperability with the TFile class because it does not support TFile.toPath().
    If file is an instance of TFile, its archive detector and file system node path get shared with this instance.
    Otherwise, this constructor scans the path name of the file to detect prospective archive files using the current archive detector TConfig.current().getArchiveDetector().
    Examples
    
    On all platforms:
    
    Relative path name:
    
    Path path = new TPath(new File("app.war/WEB-INF/lib", "lib.jar/META-INF/MANIFEST.MF"));
    
    On POSIX platforms (Unix, Linux, Mac OS X):
    
    Absolute path name with plain File:
    
    Path path = new TPath(new File("/home/christian/archive.zip"));
    
    Absolute path name with plain TFile:
    
    Path path = new TPath(new TFile("/home/christian/archive.zip"));
    
    On the Windows platform:
    
    Absolute path name with plain File:
    
    Path path = new TPath(new File("c:\home\christian\archive.zip"));
    
    Absolute path name with TFile:
    
    Path path = new TPath(new TFile("c:\home\christian\archive.zip"));
    
    Parameters:
    
    file - a file. If this is an instance of TFile, its archive detector and file system node path get shared with this instance.
  - TPath
```
public TPath(Path path)
```
    Constructs a new path from the given path.
    This constructor scans the path name of the given path to detect prospective archive files using the current archive detector TConfig.current().getArchiveDetector().
    Examples
    
    On all platforms:
    
    Relative path name:
    
    Path path = new TPath(Paths.current("app.war/WEB-INF/lib", "lib.jar/META-INF/MANIFEST.MF"));
    
    Parameters:
    
    path - a path.
  - TPath
```
public TPath(String first,
             String... more)
```
    Constructs a new path from the given path strings.
    The supported path name separators are "File.separator" and "/". Any trailing separators in the resulting path name get discarded.
    This constructor scans the path name resulting from the segment parameters to detect prospective archive files using the current archive detector TConfig.current().getArchiveDetector().
    Examples
    
    On all platforms:
    
    Relative path name:
    
    Path path = new TPath("app.war/WEB-INF/lib", "lib.jar/META-INF/MANIFEST.MF");
    
    On POSIX platforms (Unix, Linux, Mac OS X):
    
    Absolute path name:
    
    Path path = new TPath("/home/christian/archive.zip");
    
    On the Windows platform:
    
    Relative path name:
    
    Path path = new TPath("app.war\WEB-INF\lib", "lib.jar\META-INF\MANIFEST.MF");
    
    Absolute path name with C: drive letter and wierd case letters:
    
    Path path = new TPath("c:\UsErS\cHrIsTiAn\ArChIvE.zIp");
    
    Absolute path name with separated UNC host and share name and forward slash separator:
    
    Path path = new TPath("//host", "share", "archive.zip");
    
    Dito with mixed slash separators:
    
    Path path = new TPath("\\host/share\archive.zip");
    
    Parameters:
    
    first - the first sub path string.
    
    more - optional sub path strings.
  - TPath
```
public TPath(URI name)
```
    Constructs a new path from the given hierarchical URI.
    If the scheme component of the URI is undefined and the scheme specific part does not start with a "/", then the URI gets resolved against the "file:" based URI for the current directory in the platform file system. Otherwise, if the scheme component is undefined, then the URI gets resolved against the URI "file:/".
    This constructor scans the path component of the URI to detect prospective archive files using the current archive detector TConfig.current().getArchiveDetector().
    Examples
    
    On all platforms:
    
    Relative URI with relative path component:
    
    Path path = new TPath(new URI("app.war/WEB-INF/lib/lib.jar/META-INF/MANIFEST.MF"));
    
    HTTP URI:
    
    Path path = new TPath(new URI("http://acme.com/download/everything.tar.gz/README.TXT"));
    
    On POSIX platforms (Unix, Linux, Mac OS X):
    
    Relative URI with absolute path component:
    
    Path path = new TPath(new URI("/home/christian/archive.zip"));
    
    Dito with absolute, hierarchical URI:
    
    Path path = new TPath(new URI("file:/home/christian/archive.zip"));
    
    On the Windows platform:
    
    Relative URI with relative path component with C: drive letter and following absolute path name:
    
    Path path = new TPath(new URI("c%3A/Users/christian/archive.zip"));
    
    Dito with absolute, hierarchical URI:
    
    Path path = new TPath(new URI("file:/c:/Users/christian/archive.zip"));
    
    Relative URI with UNC host and share name:
    
    Path path = new TPath(new URI("//host/share/archive.zip"));
    
    Dito with absolute, hierarchical URI:
    
    Path path = new TPath(new URI("file://host/share/archive.zip"));
    
    Parameters:
    
    name - the path name. This must be a hierarchical URI with an undefined fragment component. Any trailing separators in the path component get discarded.
    
    Throws:
    
    IllegalArgumentException - if the preconditions for the parameter do not hold.
- Method Detail
  - compareTo
```
public int compareTo(Path other)
```
    The natural ordering imposed by this implementation is identical to the natural ordering of path's name. On Windows, case is ignored when comparing the path names.
    
    Specified by:
    
    compareTo in interface Comparable<Path>
    
    Specified by:
    
    compareTo in interface Path
  - endsWith
```
public boolean endsWith(Path that)
```
    Specified by:
    
    endsWith in interface Path
  - endsWith
```
public boolean endsWith(String other)
```
    Specified by:
    
    endsWith in interface Path
  - equals
```
public boolean equals(Object other)
```
    This path is considered equal to the given other object if and only if the other object is identical to this object or if the other object is a TPath object with a file system which is considered equal to this path's file system and a name which is considered equal to this path's name. On Windows, case is ignored when comparing the path names.
    
    Specified by:
    
    equals in interface Path
    
    Overrides:
    
    equals in class Object
  - getArchiveDetector
```
public TArchiveDetector getArchiveDetector()
```
    Description copied from interface: TRex
    
    Returns the TArchiveDetector which was used to detect any archive files in the path name of this object at construction time.
    
    Specified by:
    
    getArchiveDetector in interface TRex
    
    Returns:
    
    The TArchiveDetector which was used to detect any archive files in the path name of this object at construction time.
  - getFileName
```
@Nullable
public TPath getFileName()
```
    Specified by:
    
    getFileName in interface Path
  - getFileSystem
```
public TFileSystem getFileSystem()
```
    Returns the TFileSystem for this path. Multiple invocations of this method will return the same object.
    
    Specified by:
    
    getFileSystem in interface Path
    
    Returns:
    
    the TFileSystem for this path.
  - getMountPoint
```
public FsMountPoint getMountPoint()
```
    Description copied from interface: TRex
    
    Returns the file system mount point for this path. Note that multiple calls to this method result in objects which are required to compare equal, but are not necessarily identical.
    
    Specified by:
    
    getMountPoint in interface TRex
    
    Returns:
    
    the file system mount point for this path.
  - getName
```
public TPath getName(int index)
```
    Specified by:
    
    getName in interface Path
  - getNameCount
```
public int getNameCount()
```
    Specified by:
    
    getNameCount in interface Path
  - getNodeName
```
public FsNodeName getNodeName()
```
    Description copied from interface: TRex
    
    Returns the file system entry name. Note that multiple calls to this method result in objects which are required to compare equal, but are not necessarily identical.
    
    Specified by:
    
    getNodeName in interface TRex
    
    Returns:
    
    the file system entry name.
  - getNodePath
```
public FsNodePath getNodePath()
```
    Description copied from interface: TRex
    
    Returns the file system node path with an absolute URI. Note that multiple calls to this method result in objects which are required to compare equal, but are not necessarily identical.
    
    Specified by:
    
    getNodePath in interface TRex
    
    Returns:
    
    the file system node path with an absolute URI.
  - getParent
```
@Nullable
public TPath getParent()
```
    Specified by:
    
    getParent in interface Path
  - getRoot
```
@Nullable
public TPath getRoot()
```
    Specified by:
    
    getRoot in interface Path
  - getUri
```
public URI getUri()
```
    Description copied from interface: TRex
    
    Returns the absolute URI for this object.
    
    Specified by:
    
    getUri in interface TRex
    
    Returns:
    
    the absolute URI for this object.
  - hashCode
```
public int hashCode()
```
    Returns a hash code which is consistent with equals(Object).
    
    Specified by:
    
    hashCode in interface Path
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    A hash code which is consistent with equals(Object).
  - isAbsolute
```
public boolean isAbsolute()
```
    Specified by:
    
    isAbsolute in interface Path
  - 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()
  - iterator
```
public Iterator<Path> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Path>
    
    Specified by:
    
    iterator in interface Path
  - normalize
```
public TPath normalize()
```
    Specified by:
    
    normalize in interface Path
  - register
```
public WatchKey register(WatchService watcher,
                         WatchEvent.Kind<?>... events)
                  throws IOException
```
    Specified by:
    
    register in interface Path
    
    Specified by:
    
    register in interface Watchable
    
    Throws:
    
    UnsupportedOperationException - always
    
    IOException
  - register
```
public WatchKey register(WatchService watcher,
                         WatchEvent.Kind<?>[] events,
                         WatchEvent.Modifier... modifiers)
                  throws IOException
```
    Specified by:
    
    register in interface Path
    
    Specified by:
    
    register in interface Watchable
    
    Throws:
    
    UnsupportedOperationException - always
    
    IOException
  - relativize
```
public TPath relativize(Path other)
```
    Specified by:
    
    relativize in interface Path
  - resolve
```
public TPath resolve(Path other)
```
    Specified by:
    
    resolve in interface Path
  - resolve
```
public TPath resolve(String other)
```
    Specified by:
    
    resolve in interface Path
  - resolveSibling
```
public TPath resolveSibling(Path other)
```
    Specified by:
    
    resolveSibling in interface Path
  - resolveSibling
```
public TPath resolveSibling(String other)
```
    Specified by:
    
    resolveSibling in interface Path
  - startsWith
```
public boolean startsWith(Path that)
```
    Specified by:
    
    startsWith in interface Path
  - startsWith
```
public boolean startsWith(String other)
```
    Specified by:
    
    startsWith in interface Path
  - subpath
```
public TPath subpath(int beginIndex,
                     int endIndex)
```
    Specified by:
    
    subpath in interface Path
  - toAbsolutePath
```
public TPath toAbsolutePath()
```
    Specified by:
    
    toAbsolutePath in interface Path
  - toFile
```
public TFile toFile()
```
    Returns a new TFile object for this path. If this path was constructed by the file constructor, then the returned new TFile object compares equal with that file object, even if it was a plain File object.
    
    Specified by:
    
    toFile in interface Path
    
    Specified by:
    
    toFile in interface TRex
    
    Returns:
    
    A TFile object for this path.
    
    Throws:
    
    UnsupportedOperationException - if this path is not file based, i.e. if the scheme component of the URI of this path is not file.
  - toNonArchivePath
```
@ExpertFeature(level=INTERMEDIATE,
               value=INJECTING_A_DIFFERENT_DETECTOR_FOR_THE_SAME_PATH_MAY_CORRUPT_DATA)
public TPath toNonArchivePath()
```
    Returns a path object for the same path name, but does not detect any archive file name patterns in the last path name segment. The parent path object is unaffected by this transformation, so the path name of this path object may address an entry in an archive file.
    Warning: Doing I/O on the returned path object will yield inconsistent results and may even cause loss of data if the last path name segment addresses an archive file which is currently mounted by the TrueVFS Kernel!
    
    Returns:
    
    A path object for the same path name, but does not detect any archive file name patterns in the last path name segment.
    
    See Also:
    
    TFileSystem.close(), TVFS.umount()
  - toPath
```
public TPath toPath()
```
    Description copied from interface: TRex
    
    Returns a path representation of this object.
    
    Specified by:
    
    toPath in interface TRex
    
    Returns:
    
    A path representation of this object.
  - toRealPath
```
public TPath toRealPath(LinkOption... options)
                 throws IOException
```
    Specified by:
    
    toRealPath in interface Path
    
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface Path
    
    Overrides:
    
    toString in class Object
  - toUri
```
public URI toUri()
```
    Specified by:
    
    toUri in interface Path

Class TPath

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

TPath

Examples

TPath

Examples

TPath

Examples

TPath

Examples

Method Detail

compareTo

endsWith

endsWith

equals

getArchiveDetector

getFileName

getFileSystem

getMountPoint

getName

getNameCount

getNodeName

getNodePath

getParent

getRoot

getUri

hashCode

isAbsolute

isArchive

isEntry

iterator

normalize

register

register

relativize

resolve

resolve

resolveSibling

resolveSibling

startsWith

startsWith

subpath

toAbsolutePath

toFile

toNonArchivePath

toPath

toRealPath

toString

toUri