OpenJDK 27 · java.nio.file.Path · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public int	Returns: zero if the argument is `equal` to this path, a value less than zero if this path is lexicographically less than the argument, or a value greater than zero if this path is lexicographically greater than the argument compareTo(Path the path compared to this path. other) Redeclares java.lang.Comparable.compareTo. Compares two abstract paths lexicographically.
public boolean	Returns: `true` if this path ends with the given path; otherwise `false` endsWith(Path the given path other) Tests if this path ends with the given path.
public default boolean	Returns: `true` if this path ends with the given path; otherwise `false` endsWith(String the given path string other) Tests if this path ends with a `Path`, constructed by converting the given path string, in exactly the manner specified by the `endsWith(Path)` method.
public boolean	Returns: `true` if, and only if, the given object is a `Path` that is identical to this `Path` equals(Object the object to which this object is to be compared other) Tests this path for equality with the given object.
public Path	Returns: a path representing the name of the file or directory, or `null` if this path has zero elements getFileName() Returns the name of the file or directory denoted by this path as a `Path` object.
public FileSystem	Returns: the file system that created this object getFileSystem() Returns the file system that created this object.
public Path	Returns: the name element getName(int the index of the element index) Returns a name element of this path as a `Path` object.
public int	Returns: the number of elements in the path, or `0` if this path only represents a root component getNameCount() Returns the number of name elements in the path.
public Path	Returns: a path representing the path's parent getParent() Returns the parent path, or `null` if this path does not have a parent.
public Path	Returns: a path representing the root component of this path, or `null` getRoot() Returns the root component of this path as a `Path` object, or `null` if this path does not have a root component.
public int	Returns: the hash-code value for this path hashCode() Computes a hash code for this path.
public boolean	Returns: `true` if, and only if, this path is absolute isAbsolute() Tells whether or not this path is absolute.
public default Iterator<Path>	Returns: an iterator over the name elements of this path iterator() Implements java.lang.Iterable.iterator. Returns an iterator over the name elements of this path.
public Path	Returns: the resulting path or this path if it does not contain redundant name elements; an empty path is returned if this path does not have a root component and all name elements are redundant normalize() Returns a path that is this path with redundant name elements eliminated.
public static Path	Returns: the resulting `Path` of(String the path string or initial part of the path string first, String... additional strings to be joined to form the path string more) Returns a `Path` by converting a path string, or a sequence of strings that when joined form a path string.
public static Path	Returns: the resulting `Path` of(URI the URI to convert uri) Returns a `Path` by converting a URI.
public WatchKey	Returns: a key representing the registration of this object with the given watch service register(WatchService the watch service to which this object is to be registered watcher, WatchEvent.Kind<?>[] the events for which this object should be registered events, WatchEvent.Modifier... the modifiers, if any, that modify how the object is registered modifiers) Redeclares java.nio.file.Watchable.register. Registers the file located by this path with a watch service.
public default WatchKey	Returns: A key representing the registration of this object with the given watch service register(WatchService The watch service to which this object is to be registered watcher, WatchEvent.Kind<?>... The events for which this object should be registered events) Implements java.nio.file.Watchable.register. Registers the file located by this path with a watch service.
public Path	Returns: the resulting relative path, or an empty path if both paths are equal relativize(Path the path to relativize against this path other) Constructs a relative path between this path and a given path.
public Path	Returns: the resulting path resolve(Path the path to resolve against this path other) Resolve the given path against this path.
public default Path	Returns: the resulting path resolve(String the path string to resolve against this path other) Converts a given path string to a `Path` and resolves it against this `Path` in exactly the manner specified by the `resolve` method.
public default Path	Returns: the resulting path resolve(Path the first path to resolve against this path first, Path... additional paths to iteratively resolve more) Resolves a path against this path, and then iteratively resolves any additional paths.
public default Path	Returns: the resulting path resolve(String the first path string to convert to a path and resolve against this path first, String... additional path strings to be iteratively converted to paths and resolved more) Converts a path string to a path, resolves that path against this path, and then iteratively performs the same procedure for any additional path strings.
public default Path	Returns: the resulting path resolveSibling(Path the path to resolve against this path's parent other) Resolves the given path against this path's `parent` path.
public default Path	Returns: the resulting path resolveSibling(String the path string to resolve against this path's parent other) Converts a given path string to a `Path` and resolves it against this path's `parent` path in exactly the manner specified by the `resolveSibling` method.
public boolean	Returns: `true` if this path starts with the given path; otherwise `false` startsWith(Path the given path other) Tests if this path starts with the given path.
public default boolean	Returns: `true` if this path starts with the given path; otherwise `false` startsWith(String the given path string other) Tests if this path starts with a `Path`, constructed by converting the given path string, in exactly the manner specified by the `startsWith(Path)` method.
public Path	Returns: a new `Path` object that is a subsequence of the name elements in this `Path` subpath(int the index of the first element, inclusive beginIndex, int the index of the last element, exclusive endIndex) Returns a relative `Path` that is a subsequence of the name elements of this path.
public Path	Returns: a `Path` object representing the absolute path toAbsolutePath() Returns a `Path` object representing the absolute path of this path.
public default File	Returns: a `File` object representing this path toFile() Returns a `File` object representing this path.
public Path	Returns: an absolute path represent the real path of the file located by this object toRealPath(LinkOption... options indicating how symbolic links are handled options) Returns the real path of an existing file.
public String	Returns: the string representation of this path toString() Returns the string representation of this path.
public URI	Returns: the URI representing this path toUri() Returns a URI to represent this path.

Inherited from java.lang.Iterable:: forEach spliterator

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(Path other) Redeclares java.lang.Comparable.compareTo. Compares two abstract paths lexicographically. The ordering defined by this method is provider specific, and in the case of the default provider, platform specific. This method does not access the file system and neither file is required to exist. This method may not be used to compare paths that are associated with different file system providers. Parameters other:Path the path compared to this path. Returns:int zero if the argument is `equal` to this path, a value less than zero if this path is lexicographically less than the argument, or a value greater than zero if this path is lexicographically greater than the argument Annotations @Override Exceptions ClassCastException: if the paths are associated with different providers

public int compareTo(Path other)

Redeclares java.lang.Comparable.compareTo.

Compares two abstract paths lexicographically. The ordering defined by this method is provider specific, and in the case of the default provider, platform specific. This method does not access the file system and neither file is required to exist.

This method may not be used to compare paths that are associated with different file system providers.

Parameters

other:Path: the path compared to this path.

Returns:int

zero if the argument is equal to this path, a value less than zero if this path is lexicographically less than the argument, or a value greater than zero if this path is lexicographically greater than the argument

Annotations

@Override

Exceptions

ClassCastException:: if the paths are associated with different providers

endsWith back to summary

endsWith	back to summary
public boolean endsWith(Path other) Tests if this path ends with the given path. If the given path has N elements, and no root component, and this path has N or more elements, then this path ends with the given path if the last N elements of each path, starting at the element farthest from the root, are equal. If the given path has a root component then this path ends with the given path if the root component of this path ends with the root component of the given path, and the corresponding elements of both paths are equal. Whether or not the root component of this path ends with the root component of the given path is file system specific. If this path does not have a root component and the given path has a root component then this path does not end with the given path. If the given path is associated with a different `FileSystem` to this path then `false` is returned. Parameters other:Path the given path Returns:boolean `true` if this path ends with the given path; otherwise `false`

public boolean endsWith(Path other)

Tests if this path ends with the given path.

If the given path has N elements, and no root component, and this path has N or more elements, then this path ends with the given path if the last N elements of each path, starting at the element farthest from the root, are equal.

If the given path has a root component then this path ends with the given path if the root component of this path ends with the root component of the given path, and the corresponding elements of both paths are equal. Whether or not the root component of this path ends with the root component of the given path is file system specific. If this path does not have a root component and the given path has a root component then this path does not end with the given path.

If the given path is associated with a different FileSystem to this path then false is returned.

Parameters

other:Path: the given path

Returns:boolean

true if this path ends with the given path; otherwise false

endsWith back to summary

endsWith	back to summary
public default boolean endsWith(String other) Tests if this path ends with a `Path`, constructed by converting the given path string, in exactly the manner specified by the `endsWith(Path)` method. On UNIX for example, the path "`foo/bar`" ends with "`foo/bar`" and "`bar`". It does not end with "`r`" or "`/bar`". Note that trailing separators are not taken into account, and so invoking this method on the `Path` "`foo/bar`" with the `String` "`bar/`" returns `true`. Implementation Specification The default implementation is equivalent for this path to: `endsWith(getFileSystem().getPath(other));` endsWith(getFileSystem().getPath(other)); Parameters other:String the given path string Returns:boolean `true` if this path ends with the given path; otherwise `false` Exceptions InvalidPathException: If the path string cannot be converted to a Path.

public default boolean endsWith(String other)

Tests if this path ends with a Path, constructed by converting the given path string, in exactly the manner specified by the endsWith(Path) method. On UNIX for example, the path "foo/bar" ends with "foo/bar" and "bar". It does not end with "r" or "/bar". Note that trailing separators are not taken into account, and so invoking this method on the Path "foo/bar" with the String "bar/" returns true.

Implementation Specification

The default implementation is equivalent for this path to:

endsWith(getFileSystem().getPath(other));

Parameters

other:String: the given path string

Returns:boolean

true if this path ends with the given path; otherwise false

Exceptions

InvalidPathException:: If the path string cannot be converted to a Path.

equals back to summary

equals	back to summary
public boolean equals(Object other) Tests this path for equality with the given object. If the given object is not a Path, or is a Path associated with a different `FileSystem`, then this method returns `false`. Whether or not two path are equal depends on the file system implementation. In some cases the paths are compared without regard to case, and others are case sensitive. This method does not access the file system and the file is not required to exist. Where required, the `isSameFile` method may be used to check if two paths locate the same file. This method satisfies the general contract of the `Object.equals` method. Parameters other:Object the object to which this object is to be compared Returns:boolean `true` if, and only if, the given object is a `Path` that is identical to this `Path` Annotations @Override

public boolean equals(Object other)

Tests this path for equality with the given object.

If the given object is not a Path, or is a Path associated with a different FileSystem, then this method returns false.

Whether or not two path are equal depends on the file system implementation. In some cases the paths are compared without regard to case, and others are case sensitive. This method does not access the file system and the file is not required to exist. Where required, the isSameFile method may be used to check if two paths locate the same file.

This method satisfies the general contract of the Object.equals method.

Parameters

other:Object: the object to which this object is to be compared

Returns:boolean

true if, and only if, the given object is a Path that is identical to this Path

Annotations

@Override

getFileName back to summary

getFileName	back to summary
public Path getFileName() Returns the name of the file or directory denoted by this path as a `Path` object. The file name is the farthest element from the root in the directory hierarchy. Returns:Path a path representing the name of the file or directory, or `null` if this path has zero elements

public Path getFileName()

Returns the name of the file or directory denoted by this path as a Path object. The file name is the farthest element from the root in the directory hierarchy.

Returns:Path: a path representing the name of the file or directory, or null if this path has zero elements

getFileSystem	back to summary
public FileSystem getFileSystem() Returns the file system that created this object. Returns:FileSystem the file system that created this object

getFileSystem

back to summary

public FileSystem getFileSystem()

Returns the file system that created this object.

Returns:FileSystem: the file system that created this object

getName back to summary

getName	back to summary
public Path getName(int index) Returns a name element of this path as a `Path` object. The `index` parameter is the index of the name element to return. The element that is closest to the root in the directory hierarchy has index `0`. The element that is farthest from the root has index `count-1`. Parameters index:int the index of the element Returns:Path the name element Exceptions IllegalArgumentException: if `index` is negative, `index` is greater than or equal to the number of elements, or this path has zero name elements

public Path getName(int index)

Returns a name element of this path as a Path object.

The index parameter is the index of the name element to return. The element that is closest to the root in the directory hierarchy has index 0. The element that is farthest from the root has index count-1.

Parameters

index:int: the index of the element

Returns:Path

the name element

Exceptions

IllegalArgumentException:: if index is negative, index is greater than or equal to the number of elements, or this path has zero name elements

getNameCount back to summary

getNameCount	back to summary
public int getNameCount() Returns the number of name elements in the path. Returns:int the number of elements in the path, or `0` if this path only represents a root component

public int getNameCount()

Returns the number of name elements in the path.

Returns:int: the number of elements in the path, or 0 if this path only represents a root component

getParent back to summary

getParent	back to summary
public Path getParent() Returns the parent path, or `null` if this path does not have a parent. The parent of this path object consists of this path's root component, if any, and each element in the path except for the farthest from the root in the directory hierarchy. This method does not access the file system; the path or its parent may not exist. Furthermore, this method does not eliminate special names such as "." and ".." that may be used in some implementations. On UNIX for example, the parent of "`/a/b/c`" is "`/a/b`", and the parent of `"x/y/.`" is "`x/y`". This method may be used with the `normalize` method, to eliminate redundant names, for cases where shell-like navigation is required. If this path has more than one element, and no root component, then this method is equivalent to evaluating the expression: `subpath(0, getNameCount()-1);` subpath(0, getNameCount()-1); Returns:Path a path representing the path's parent

public Path getParent()

Returns the parent path, or null if this path does not have a parent.

The parent of this path object consists of this path's root component, if any, and each element in the path except for the farthest from the root in the directory hierarchy. This method does not access the file system; the path or its parent may not exist. Furthermore, this method does not eliminate special names such as "." and ".." that may be used in some implementations. On UNIX for example, the parent of "/a/b/c" is "/a/b", and the parent of "x/y/." is "x/y". This method may be used with the normalize method, to eliminate redundant names, for cases where shell-like navigation is required.

If this path has more than one element, and no root component, then this method is equivalent to evaluating the expression:

subpath(0, getNameCount()-1);

Returns:Path: a path representing the path's parent

getRoot back to summary

getRoot	back to summary
public Path getRoot() Returns the root component of this path as a `Path` object, or `null` if this path does not have a root component. Returns:Path a path representing the root component of this path, or `null`

public Path getRoot()

Returns the root component of this path as a Path object, or null if this path does not have a root component.

Returns:Path: a path representing the root component of this path, or null

hashCode back to summary

hashCode	back to summary
public int hashCode() Computes a hash code for this path. The hash code is based upon the components of the path, and satisfies the general contract of the `Object.hashCode` method. Returns:int the hash-code value for this path Annotations @Override

public int hashCode()

Computes a hash code for this path.

The hash code is based upon the components of the path, and satisfies the general contract of the Object.hashCode method.

Returns:int

the hash-code value for this path

Annotations

@Override

isAbsolute back to summary

isAbsolute	back to summary
public boolean isAbsolute() Tells whether or not this path is absolute. An absolute path is complete in that it doesn't need to be combined with other path information in order to locate a file. Returns:boolean `true` if, and only if, this path is absolute

public boolean isAbsolute()

Tells whether or not this path is absolute.

An absolute path is complete in that it doesn't need to be combined with other path information in order to locate a file.

Returns:boolean: true if, and only if, this path is absolute

iterator back to summary

iterator	back to summary
public default Iterator<Path> iterator() Implements java.lang.Iterable.iterator. Returns an iterator over the name elements of this path. The first element returned by the iterator represents the name element that is closest to the root in the directory hierarchy, the second element is the next closest, and so on. The last element returned is the name of the file or directory denoted by this path. The `root` component, if present, is not returned by the iterator. Implementation Specification The default implementation returns an `Iterator<Path>` which, for this path, traverses the `Path`s returned by `getName(index)`, where `index` ranges from zero to `getNameCount() - 1`, inclusive. Returns:Iterator<Path> an iterator over the name elements of this path Annotations @Override

public default Iterator<Path> iterator()

Implements java.lang.Iterable.iterator.

Returns an iterator over the name elements of this path.

The first element returned by the iterator represents the name element that is closest to the root in the directory hierarchy, the second element is the next closest, and so on. The last element returned is the name of the file or directory denoted by this path. The root component, if present, is not returned by the iterator.

Implementation Specification

The default implementation returns an Iterator<Path> which, for this path, traverses the Paths returned by getName(index), where index ranges from zero to getNameCount() - 1, inclusive.

Returns:Iterator<Path>

an iterator over the name elements of this path

Annotations

@Override

normalize back to summary

normalize	back to summary
public Path normalize() Returns a path that is this path with redundant name elements eliminated. The precise definition of this method is implementation dependent but in general it derives from this path, a path that does not contain redundant name elements. In many file systems, the "`.`" and "`..`" are special names used to indicate the current directory and parent directory. In such file systems all occurrences of "`.`" are considered redundant. If a "`..`" is preceded by a non-"`..`" name then both names are considered redundant (the process to identify such names is repeated until it is no longer applicable). This method does not access the file system; the path may not locate a file that exists. Eliminating "`..`" and a preceding name from a path may result in the path that locates a different file than the original path. This can arise when the preceding name is a symbolic link. Returns:Path the resulting path or this path if it does not contain redundant name elements; an empty path is returned if this path does not have a root component and all name elements are redundant See Also `getParent`, `toRealPath`

public Path normalize()

Returns a path that is this path with redundant name elements eliminated.

The precise definition of this method is implementation dependent but in general it derives from this path, a path that does not contain redundant name elements. In many file systems, the "." and ".." are special names used to indicate the current directory and parent directory. In such file systems all occurrences of "." are considered redundant. If a ".." is preceded by a non-".." name then both names are considered redundant (the process to identify such names is repeated until it is no longer applicable).

This method does not access the file system; the path may not locate a file that exists. Eliminating ".." and a preceding name from a path may result in the path that locates a different file than the original path. This can arise when the preceding name is a symbolic link.

Returns:Path: the resulting path or this path if it does not contain redundant name elements; an empty path is returned if this path does not have a root component and all name elements are redundant
See Also: getParent, toRealPath

of back to summary

of	back to summary
public static Path of(String first, String... more) Returns a `Path` by converting a path string, or a sequence of strings that when joined form a path string. If `more` does not specify any elements then the value of the `first` parameter is the path string to convert. If `more` specifies one or more elements then each non-empty string, including `first`, is considered to be a sequence of name elements and is joined to form a path string. The details as to how the Strings are joined is provider specific but typically they will be joined using the `name-separator` as the separator. For example, if the name separator is "`/`" and `getPath("/foo","bar","gus")` is invoked, then the path string `"/foo/bar/gus"` is converted to a `Path`. A `Path` representing an empty path is returned if `first` is the empty string and `more` does not contain any non-empty strings. The `Path` is obtained by invoking the `getPath` method of the `default` `FileSystem`. Note that while this method is very convenient, using it will imply an assumed reference to the default `FileSystem` and limit the utility of the calling code. Hence it should not be used in library code intended for flexible reuse. A more flexible alternative is to use an existing `Path` instance as an anchor, such as: `Path dir = ... Path path = dir.resolve("file");` Path dir = ... Path path = dir.resolve("file"); Parameters first:String the path string or initial part of the path string more:String[] additional strings to be joined to form the path string Returns:Path the resulting `Path` Exceptions InvalidPathException: if the path string cannot be converted to a `Path` Since 11 See Also `FileSystem#getPath`

public static Path of(String first, String... more)

Returns a Path by converting a path string, or a sequence of strings that when joined form a path string. If more does not specify any elements then the value of the first parameter is the path string to convert. If more specifies one or more elements then each non-empty string, including first, is considered to be a sequence of name elements and is joined to form a path string. The details as to how the Strings are joined is provider specific but typically they will be joined using the name-separator as the separator. For example, if the name separator is "/" and getPath("/foo","bar","gus") is invoked, then the path string "/foo/bar/gus" is converted to a Path. A Path representing an empty path is returned if first is the empty string and more does not contain any non-empty strings.

The Path is obtained by invoking the getPath method of the default FileSystem.

Note that while this method is very convenient, using it will imply an assumed reference to the default FileSystem and limit the utility of the calling code. Hence it should not be used in library code intended for flexible reuse. A more flexible alternative is to use an existing Path instance as an anchor, such as:

Path dir = ...
Path path = dir.resolve("file");

Parameters

first:String: the path string or initial part of the path string
more:String[]: additional strings to be joined to form the path string

Returns:Path

the resulting Path

Exceptions

InvalidPathException:: if the path string cannot be converted to a Path

Since

See Also

FileSystem#getPath

of back to summary

of	back to summary
public static Path of(URI uri) Returns a `Path` by converting a URI. This method iterates over the `installed` providers to locate the provider that is identified by the URI `scheme` of the given URI. URI schemes are compared without regard to case. If the provider is found then its `getPath` method is invoked to convert the URI. In the case of the default provider, identified by the URI scheme "file", the given URI has a non-empty path component, and undefined query and fragment components. Whether the authority component may be present is platform specific. The returned `Path` is associated with the `default` file system. The default provider provides a similar round-trip guarantee to the `java.io.File` class. For a given `Path` p it is guaranteed that `Path.of(`p`.toUri()).equals(` p`.toAbsolutePath())` so long as the original `Path`, the `URI`, and the new `Path` are all created in (possibly different invocations of) the same Java virtual machine. Whether other providers make any guarantees is provider specific and therefore unspecified. Parameters uri:URI the URI to convert Returns:Path the resulting `Path` Exceptions IllegalArgumentException: if preconditions on the `uri` parameter do not hold. The format of the URI is provider specific. FileSystemNotFoundException: The file system, identified by the URI, does not exist and cannot be created automatically, or the provider identified by the URI's scheme component is not installed Since 11

public static Path of(URI uri)

Returns a Path by converting a URI.

This method iterates over the installed providers to locate the provider that is identified by the URI scheme of the given URI. URI schemes are compared without regard to case. If the provider is found then its getPath method is invoked to convert the URI.

In the case of the default provider, identified by the URI scheme "file", the given URI has a non-empty path component, and undefined query and fragment components. Whether the authority component may be present is platform specific. The returned Path is associated with the default file system.

The default provider provides a similar round-trip guarantee to the java.io.File class. For a given Path p it is guaranteed that

Path.of(p.toUri()).equals( p.toAbsolutePath())

so long as the original Path, the URI, and the new Path are all created in (possibly different invocations of) the same Java virtual machine. Whether other providers make any guarantees is provider specific and therefore unspecified.

Parameters

uri:URI: the URI to convert

Returns:Path

the resulting Path

Exceptions

IllegalArgumentException:: if preconditions on the uri parameter do not hold. The format of the URI is provider specific.
FileSystemNotFoundException:: The file system, identified by the URI, does not exist and cannot be created automatically, or the provider identified by the URI's scheme component is not installed

Since

register	back to summary
public WatchKey register(WatchService watcher, WatchEvent.Kind<?>[] events, WatchEvent.Modifier... modifiers) throws IOException Redeclares java.nio.file.Watchable.register. Registers the file located by this path with a watch service. In this release, this path locates a directory that exists. The directory is registered with the watch service so that entries in the directory can be watched. The `events` parameter is the events to register and may contain the following events: `ENTRY_CREATE` - entry created or moved into the directory `ENTRY_DELETE` - entry deleted or moved out of the directory `ENTRY_MODIFY` - entry in directory was modified The `context` for these events is the relative path between the directory located by this path, and the path that locates the directory entry that is created, deleted, or modified. The set of events may include additional implementation specific event that are not defined by the enum `StandardWatchEventKinds` The `modifiers` parameter specifies modifiers that qualify how the directory is registered. This release does not define any standard modifiers. It may contain implementation specific modifiers. Where a file is registered with a watch service by means of a symbolic link then it is implementation specific if the watch continues to depend on the existence of the symbolic link after it is registered. Parameters watcher:WatchService the watch service to which this object is to be registered events:WatchEvent.Kind<?>[] the events for which this object should be registered modifiers:WatchEvent.Modifier[] the modifiers, if any, that modify how the object is registered Returns:WatchKey a key representing the registration of this object with the given watch service Annotations @Override Exceptions IOException: if an I/O error occurs UnsupportedOperationException: if unsupported events or modifiers are specified IllegalArgumentException: if an invalid combination of events or modifiers is specified ClosedWatchServiceException: if the watch service is closed NotDirectoryException: if the file is registered to watch the entries in a directory and the file is not a directory (optional specific exception)

public WatchKey register(WatchService watcher, WatchEvent.Kind<?>[] events, WatchEvent.Modifier... modifiers) throws IOException

Redeclares java.nio.file.Watchable.register.

Registers the file located by this path with a watch service.

In this release, this path locates a directory that exists. The directory is registered with the watch service so that entries in the directory can be watched. The events parameter is the events to register and may contain the following events:

ENTRY_CREATE - entry created or moved into the directory
ENTRY_DELETE - entry deleted or moved out of the directory
ENTRY_MODIFY - entry in directory was modified

The context for these events is the relative path between the directory located by this path, and the path that locates the directory entry that is created, deleted, or modified.

The set of events may include additional implementation specific event that are not defined by the enum StandardWatchEventKinds

The modifiers parameter specifies modifiers that qualify how the directory is registered. This release does not define any standard modifiers. It may contain implementation specific modifiers.

Where a file is registered with a watch service by means of a symbolic link then it is implementation specific if the watch continues to depend on the existence of the symbolic link after it is registered.

Parameters

watcher:WatchService: the watch service to which this object is to be registered
events:WatchEvent.Kind<?>[]: the events for which this object should be registered
modifiers:WatchEvent.Modifier[]: the modifiers, if any, that modify how the object is registered

Returns:WatchKey

a key representing the registration of this object with the given watch service

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs
UnsupportedOperationException:: if unsupported events or modifiers are specified
IllegalArgumentException:: if an invalid combination of events or modifiers is specified
ClosedWatchServiceException:: if the watch service is closed
NotDirectoryException:: if the file is registered to watch the entries in a directory and the file is not a directory (optional specific exception)

register	back to summary
public default WatchKey register(WatchService watcher, WatchEvent.Kind<?>... events) throws IOException Implements java.nio.file.Watchable.register. Registers the file located by this path with a watch service. An invocation of this method behaves in exactly the same way as the invocation `register(watcher, events, new WatchEvent.Modifier[0]);` register(watcher, events, new WatchEvent.Modifier[0]); Usage Example: Suppose we wish to register a directory for entry create, delete, and modify events: `Path dir = ... WatchService watcher = ... WatchKey key = dir.register(watcher, ENTRY_CREATE, ENTRY_DELETE, ENTRY_MODIFY);` Path dir = ... WatchService watcher = ... WatchKey key = dir.register(watcher, ENTRY_CREATE, ENTRY_DELETE, ENTRY_MODIFY); Implementation Specification The default implementation is equivalent for this path to: `register(watcher, events, new WatchEvent.Modifier[0]);` register(watcher, events, new WatchEvent.Modifier[0]); Parameters watcher:WatchService The watch service to which this object is to be registered events:WatchEvent.Kind<?>[] The events for which this object should be registered Returns:WatchKey A key representing the registration of this object with the given watch service Annotations @Override Exceptions IOException: If an I/O error occurs UnsupportedOperationException: If unsupported events are specified IllegalArgumentException: If an invalid combination of events is specified ClosedWatchServiceException: If the watch service is closed NotDirectoryException: If the file is registered to watch the entries in a directory and the file is not a directory (optional specific exception)

public default WatchKey register(WatchService watcher, WatchEvent.Kind<?>... events) throws IOException

Implements java.nio.file.Watchable.register.

Registers the file located by this path with a watch service.

An invocation of this method behaves in exactly the same way as the invocation

register(watcher, events, new WatchEvent.Modifier[0]);

Usage Example: Suppose we wish to register a directory for entry create, delete, and modify events:

Path dir = ...
WatchService watcher = ...

WatchKey key = dir.register(watcher, ENTRY_CREATE, ENTRY_DELETE, ENTRY_MODIFY);

Implementation Specification

The default implementation is equivalent for this path to:

register(watcher, events, new WatchEvent.Modifier[0]);

Parameters

watcher:WatchService: The watch service to which this object is to be registered
events:WatchEvent.Kind<?>[]: The events for which this object should be registered

Returns:WatchKey

A key representing the registration of this object with the given watch service

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs
UnsupportedOperationException:: If unsupported events are specified
IllegalArgumentException:: If an invalid combination of events is specified
ClosedWatchServiceException:: If the watch service is closed
NotDirectoryException:: If the file is registered to watch the entries in a directory and the file is not a directory (optional specific exception)

relativize back to summary

relativize	back to summary
public Path relativize(Path other) Constructs a relative path between this path and a given path. Relativization is the inverse of `resolution`. This method attempts to construct a `relative` path that when `resolved` against this path, yields a path that locates the same file as the given path. For example, on UNIX, if this path is `"/a/b"` and the given path is `"/a/b/c/d"` then the resulting relative path would be `"c/d"`. Where this path and the given path do not have a `root` component, then a relative path can be constructed. A relative path cannot be constructed if only one of the paths have a root component. Where both paths have a root component then it is implementation dependent if a relative path can be constructed. If this path and the given path are `equal` then an empty path is returned. For any two `normalized` paths p and q, where q does not have a root component, p`.relativize(`p `.resolve(`q`)).equals(`q`)` When symbolic links are supported, then whether the resulting path, when resolved against this path, yields a path that can be used to locate the `same` file as `other` is implementation dependent. For example, if this path is `"/a/b"` and the given path is `"/a/x"` then the resulting relative path may be `"../x"`. If `"b"` is a symbolic link then is implementation dependent if `"a/b/../x"` would locate the same file as `"/a/x"`. Parameters other:Path the path to relativize against this path Returns:Path the resulting relative path, or an empty path if both paths are equal Exceptions IllegalArgumentException: if `other` is not a `Path` that can be relativized against this path

public Path relativize(Path other)

Constructs a relative path between this path and a given path.

Relativization is the inverse of resolution. This method attempts to construct a relative path that when resolved against this path, yields a path that locates the same file as the given path. For example, on UNIX, if this path is "/a/b" and the given path is "/a/b/c/d" then the resulting relative path would be "c/d". Where this path and the given path do not have a root component, then a relative path can be constructed. A relative path cannot be constructed if only one of the paths have a root component. Where both paths have a root component then it is implementation dependent if a relative path can be constructed. If this path and the given path are equal then an empty path is returned.

For any two normalized paths p and q, where q does not have a root component,

p.relativize(p .resolve(q)).equals(q)

When symbolic links are supported, then whether the resulting path, when resolved against this path, yields a path that can be used to locate the same file as other is implementation dependent. For example, if this path is "/a/b" and the given path is "/a/x" then the resulting relative path may be "../x". If "b" is a symbolic link then is implementation dependent if "a/b/../x" would locate the same file as "/a/x".

Parameters

other:Path: the path to relativize against this path

Returns:Path

the resulting relative path, or an empty path if both paths are equal

Exceptions

IllegalArgumentException:: if other is not a Path that can be relativized against this path

resolve back to summary

resolve	back to summary
public Path resolve(Path other) Resolve the given path against this path. If the `other` parameter is an `absolute` path then this method trivially returns `other`. If `other` is an empty path then this method trivially returns this path. Otherwise this method considers this path to be a directory and resolves the given path against this path. In the simplest case, the given path does not have a `root` component, in which case this method joins the given path to this path and returns a resulting path that `ends` with the given path. Where the given path has a root component then resolution is highly implementation dependent and therefore unspecified. Parameters other:Path the path to resolve against this path Returns:Path the resulting path See Also `relativize`

public Path resolve(Path other)

Resolve the given path against this path.

If the other parameter is an absolute path then this method trivially returns other. If other is an empty path then this method trivially returns this path. Otherwise this method considers this path to be a directory and resolves the given path against this path. In the simplest case, the given path does not have a root component, in which case this method joins the given path to this path and returns a resulting path that ends with the given path. Where the given path has a root component then resolution is highly implementation dependent and therefore unspecified.

Parameters

other:Path: the path to resolve against this path

Returns:Path

the resulting path

See Also

relativize

resolve back to summary

resolve	back to summary
public default Path resolve(String other) Converts a given path string to a `Path` and resolves it against this `Path` in exactly the manner specified by the `resolve` method. For example, suppose that the name separator is "`/`" and a path represents "`foo/bar`", then invoking this method with the path string "`gus`" will result in the `Path` "`foo/bar/gus`". Implementation Specification The default implementation is equivalent for this path to: `resolve(getFileSystem().getPath(other));` resolve(getFileSystem().getPath(other)); Parameters other:String the path string to resolve against this path Returns:Path the resulting path Exceptions InvalidPathException: if the path string cannot be converted to a Path. See Also `FileSystem#getPath`

public default Path resolve(String other)

Converts a given path string to a Path and resolves it against this Path in exactly the manner specified by the resolve method. For example, suppose that the name separator is "/" and a path represents "foo/bar", then invoking this method with the path string "gus" will result in the Path "foo/bar/gus".

Implementation Specification

The default implementation is equivalent for this path to:

resolve(getFileSystem().getPath(other));

Parameters

other:String: the path string to resolve against this path

Returns:Path

the resulting path

Exceptions

InvalidPathException:: if the path string cannot be converted to a Path.

See Also

FileSystem#getPath

resolve back to summary

resolve	back to summary
public default Path resolve(Path first, Path... more) Resolves a path against this path, and then iteratively resolves any additional paths. This method resolves `first` against this `Path` as if by calling `resolve(Path)`. If `more` has one or more elements then it resolves the first element against the result, then iteratively resolves all subsequent elements. This method returns the result from the final resolve. Implementation Specification The default implementation is equivalent to the result obtained with: `Path result = resolve(first); for (Path p : more) { result = result.resolve(p); }` Path result = resolve(first); for (Path p : more) { result = result.resolve(p); } Parameters first:Path the first path to resolve against this path more:Path[] additional paths to iteratively resolve Returns:Path the resulting path Since 22 See Also `resolve(Path)`

public default Path resolve(Path first, Path... more)

Resolves a path against this path, and then iteratively resolves any additional paths.

This method resolves first against this Path as if by calling resolve(Path). If more has one or more elements then it resolves the first element against the result, then iteratively resolves all subsequent elements. This method returns the result from the final resolve.

Implementation Specification

The default implementation is equivalent to the result obtained with:

Path result = resolve(first);
for (Path p : more) {
    result = result.resolve(p);
}

Parameters

first:Path: the first path to resolve against this path
more:Path[]: additional paths to iteratively resolve

Returns:Path

the resulting path

Since

See Also

resolve(Path)

resolve back to summary

resolve	back to summary
public default Path resolve(String first, String... more) Converts a path string to a path, resolves that path against this path, and then iteratively performs the same procedure for any additional path strings. This method converts `first` to a `Path` and resolves that `Path` against this `Path` as if by calling `resolve(String)`. If `more` has one or more elements then it converts the first element to a path, resolves that path against the result, then iteratively converts and resolves all subsequent elements. This method returns the result from the final resolve. Implementation Specification The default implementation is equivalent to the result obtained with: `Path result = resolve(first); for (String s : more) { result = result.resolve(s); }` Path result = resolve(first); for (String s : more) { result = result.resolve(s); } Parameters first:String the first path string to convert to a path and resolve against this path more:String[] additional path strings to be iteratively converted to paths and resolved Returns:Path the resulting path Exceptions InvalidPathException: if a path string cannot be converted to a Path. Since 22 See Also `resolve(Path, Path...)`, `resolve(String)`

public default Path resolve(String first, String... more)

Converts a path string to a path, resolves that path against this path, and then iteratively performs the same procedure for any additional path strings.

This method converts first to a Path and resolves that Path against this Path as if by calling resolve(String). If more has one or more elements then it converts the first element to a path, resolves that path against the result, then iteratively converts and resolves all subsequent elements. This method returns the result from the final resolve.

Implementation Specification

The default implementation is equivalent to the result obtained with:

Path result = resolve(first);
for (String s : more) {
    result = result.resolve(s);
}

Parameters

first:String: the first path string to convert to a path and resolve against this path
more:String[]: additional path strings to be iteratively converted to paths and resolved

Returns:Path

the resulting path

Exceptions

InvalidPathException:: if a path string cannot be converted to a Path.

Since

resolveSibling back to summary

resolveSibling	back to summary
public default Path resolveSibling(Path other) Resolves the given path against this path's `parent` path. This is useful where a file name needs to be replaced with another file name. For example, suppose that the name separator is "`/`" and a path represents "`dir1/dir2/foo`", then invoking this method with the `Path` "`bar`" will result in the `Path` "`dir1/dir2/bar`". If this path does not have a parent path, or `other` is `absolute`, then this method returns `other`. If `other` is an empty path then this method returns this path's parent, or where this path doesn't have a parent, the empty path. Implementation Specification The default implementation is equivalent for this path to: `(getParent() == null) ? other : getParent().resolve(other);` (getParent() == null) ? other : getParent().resolve(other); unless `other == null`, in which case a `NullPointerException` is thrown. Parameters other:Path the path to resolve against this path's parent Returns:Path the resulting path See Also `resolve(Path)`

public default Path resolveSibling(Path other)

Resolves the given path against this path's parent path. This is useful where a file name needs to be replaced with another file name. For example, suppose that the name separator is "/" and a path represents "dir1/dir2/foo", then invoking this method with the Path "bar" will result in the Path "dir1/dir2/bar". If this path does not have a parent path, or other is absolute, then this method returns other. If other is an empty path then this method returns this path's parent, or where this path doesn't have a parent, the empty path.

Implementation Specification

The default implementation is equivalent for this path to:

(getParent() == null) ? other : getParent().resolve(other);

unless other == null, in which case a NullPointerException is thrown.

Parameters

other:Path: the path to resolve against this path's parent

Returns:Path

the resulting path

See Also

resolve(Path)

resolveSibling back to summary

resolveSibling	back to summary
public default Path resolveSibling(String other) Converts a given path string to a `Path` and resolves it against this path's `parent` path in exactly the manner specified by the `resolveSibling` method. Implementation Specification The default implementation is equivalent for this path to: `resolveSibling(getFileSystem().getPath(other));` resolveSibling(getFileSystem().getPath(other)); Parameters other:String the path string to resolve against this path's parent Returns:Path the resulting path Exceptions InvalidPathException: if the path string cannot be converted to a Path. See Also `FileSystem#getPath`

public default Path resolveSibling(String other)

Converts a given path string to a Path and resolves it against this path's parent path in exactly the manner specified by the resolveSibling method.

Implementation Specification

The default implementation is equivalent for this path to:

resolveSibling(getFileSystem().getPath(other));

Parameters

other:String: the path string to resolve against this path's parent

Returns:Path

the resulting path

Exceptions

InvalidPathException:: if the path string cannot be converted to a Path.

See Also

FileSystem#getPath

startsWith back to summary

startsWith	back to summary
public boolean startsWith(Path other) Tests if this path starts with the given path. This path starts with the given path if this path's root component starts with the root component of the given path, and this path starts with the same name elements as the given path. If the given path has more name elements than this path then `false` is returned. Whether or not the root component of this path starts with the root component of the given path is file system specific. If this path does not have a root component and the given path has a root component then this path does not start with the given path. If the given path is associated with a different `FileSystem` to this path then `false` is returned. Parameters other:Path the given path Returns:boolean `true` if this path starts with the given path; otherwise `false`

public boolean startsWith(Path other)

Tests if this path starts with the given path.

This path starts with the given path if this path's root component starts with the root component of the given path, and this path starts with the same name elements as the given path. If the given path has more name elements than this path then false is returned.

Whether or not the root component of this path starts with the root component of the given path is file system specific. If this path does not have a root component and the given path has a root component then this path does not start with the given path.

If the given path is associated with a different FileSystem to this path then false is returned.

Parameters

other:Path: the given path

Returns:boolean

true if this path starts with the given path; otherwise false

startsWith back to summary

startsWith	back to summary
public default boolean startsWith(String other) Tests if this path starts with a `Path`, constructed by converting the given path string, in exactly the manner specified by the `startsWith(Path)` method. On UNIX for example, the path "`foo/bar`" starts with "`foo`" and "`foo/bar`". It does not start with "`f`" or "`fo`". Implementation Specification The default implementation is equivalent for this path to: `startsWith(getFileSystem().getPath(other));` startsWith(getFileSystem().getPath(other)); Parameters other:String the given path string Returns:boolean `true` if this path starts with the given path; otherwise `false` Exceptions InvalidPathException: If the path string cannot be converted to a Path.

public default boolean startsWith(String other)

Tests if this path starts with a Path, constructed by converting the given path string, in exactly the manner specified by the startsWith(Path) method. On UNIX for example, the path "foo/bar" starts with "foo" and "foo/bar". It does not start with "f" or "fo".

Implementation Specification

The default implementation is equivalent for this path to:

startsWith(getFileSystem().getPath(other));

Parameters

other:String: the given path string

Returns:boolean

true if this path starts with the given path; otherwise false

Exceptions

InvalidPathException:: If the path string cannot be converted to a Path.

subpath back to summary

subpath	back to summary
public Path subpath(int beginIndex, int endIndex) Returns a relative `Path` that is a subsequence of the name elements of this path. The `beginIndex` and `endIndex` parameters specify the subsequence of name elements. The name that is closest to the root in the directory hierarchy has index `0`. The name that is farthest from the root has index `count-1`. The returned `Path` object has the name elements that begin at `beginIndex` and extend to the element at index `endIndex-1`. Parameters beginIndex:int the index of the first element, inclusive endIndex:int the index of the last element, exclusive Returns:Path a new `Path` object that is a subsequence of the name elements in this `Path` Exceptions IllegalArgumentException: if `beginIndex` is negative, or greater than or equal to the number of elements. If `endIndex` is less than or equal to `beginIndex`, or larger than the number of elements.

public Path subpath(int beginIndex, int endIndex)

Returns a relative Path that is a subsequence of the name elements of this path.

The beginIndex and endIndex parameters specify the subsequence of name elements. The name that is closest to the root in the directory hierarchy has index 0. The name that is farthest from the root has index count-1. The returned Path object has the name elements that begin at beginIndex and extend to the element at index endIndex-1.

Parameters

beginIndex:int: the index of the first element, inclusive
endIndex:int: the index of the last element, exclusive

Returns:Path

a new Path object that is a subsequence of the name elements in this Path

Exceptions

IllegalArgumentException:: if beginIndex is negative, or greater than or equal to the number of elements. If endIndex is less than or equal to beginIndex, or larger than the number of elements.

toAbsolutePath back to summary

toAbsolutePath	back to summary
public Path toAbsolutePath() Returns a `Path` object representing the absolute path of this path. Where this `Path` is associated with the default provider, then the returned absolute path will have a non-`null` root component. If this path is already `absolute` then this method simply returns this path. Otherwise, this method resolves the path in an implementation dependent manner, typically by resolving the path against a file system default directory. Depending on the implementation, this method may throw an I/O error if the file system is not accessible. Returns:Path a `Path` object representing the absolute path Exceptions IOError: if an I/O error occurs

public Path toAbsolutePath()

Returns a Path object representing the absolute path of this path. Where this Path is associated with the default provider, then the returned absolute path will have a non-null root component.

If this path is already absolute then this method simply returns this path. Otherwise, this method resolves the path in an implementation dependent manner, typically by resolving the path against a file system default directory. Depending on the implementation, this method may throw an I/O error if the file system is not accessible.

Returns:Path

a Path object representing the absolute path

Exceptions

IOError:: if an I/O error occurs

toFile back to summary

toFile	back to summary
public default File toFile() Returns a `File` object representing this path. Where this `Path` is associated with the default provider, then this method is equivalent to returning a `File` object constructed with the `String` representation of this path. If this path was created by invoking the `File` `toPath` method then there is no guarantee that the `File` object returned by this method is `equal` to the original `File`. Implementation Specification The default implementation is equivalent for this path to: `new File(toString());` new File(toString()); if the `FileSystem` which created this `Path` is the default file system; otherwise an `UnsupportedOperationException` is thrown. Returns:File a `File` object representing this path Exceptions UnsupportedOperationException: if this `Path` is not associated with the default provider

public default File toFile()

Returns a File object representing this path. Where this Path is associated with the default provider, then this method is equivalent to returning a File object constructed with the String representation of this path.

If this path was created by invoking the File toPath method then there is no guarantee that the File object returned by this method is equal to the original File.

Implementation Specification

The default implementation is equivalent for this path to:

new File(toString());

if the FileSystem which created this Path is the default file system; otherwise an UnsupportedOperationException is thrown.

Returns:File

a File object representing this path

Exceptions

UnsupportedOperationException:: if this Path is not associated with the default provider

toRealPath back to summary

toRealPath	back to summary
public Path toRealPath(LinkOption... options) throws IOException Returns the real path of an existing file. The precise definition of this method is implementation dependent but in general it derives from this path, an `absolute` path that locates the `same` file as this path, but with name elements that represent the actual name of the directories and the file. For example, where filename comparisons on a file system are case insensitive then the name elements represent the names in their actual case. Additionally, the resulting path has redundant name elements removed. If this path is relative then its absolute path is first obtained, as if by invoking the `toAbsolutePath` method. The `options` array may be used to indicate how symbolic links are handled. By default, symbolic links are resolved to their final target. If the option `NOFOLLOW_LINKS` is present then this method does not resolve symbolic links. Some implementations allow special names such as "`..`" to refer to the parent directory. When deriving the real path, and a "`..`" (or equivalent) is preceded by a non-"`..`" name then an implementation will typically cause both names to be removed. When not resolving symbolic links and the preceding name is a symbolic link then the names are only removed if it is guaranteed that the resulting path will locate the same file as this path. Parameters options:LinkOption[] options indicating how symbolic links are handled Returns:Path an absolute path represent the real path of the file located by this object Exceptions IOException: if the file does not exist or an I/O error occurs

public Path toRealPath(LinkOption... options) throws IOException

Returns the real path of an existing file.

The precise definition of this method is implementation dependent but in general it derives from this path, an absolute path that locates the same file as this path, but with name elements that represent the actual name of the directories and the file. For example, where filename comparisons on a file system are case insensitive then the name elements represent the names in their actual case. Additionally, the resulting path has redundant name elements removed.

If this path is relative then its absolute path is first obtained, as if by invoking the toAbsolutePath method.

The options array may be used to indicate how symbolic links are handled. By default, symbolic links are resolved to their final target. If the option NOFOLLOW_LINKS is present then this method does not resolve symbolic links. Some implementations allow special names such as ".." to refer to the parent directory. When deriving the real path, and a ".." (or equivalent) is preceded by a non-".." name then an implementation will typically cause both names to be removed. When not resolving symbolic links and the preceding name is a symbolic link then the names are only removed if it is guaranteed that the resulting path will locate the same file as this path.

Parameters

options:LinkOption[]: options indicating how symbolic links are handled

Returns:Path

an absolute path represent the real path of the file located by this object

Exceptions

IOException:: if the file does not exist or an I/O error occurs

toString back to summary

toString	back to summary
public String toString() Returns the string representation of this path. If this path was created by converting a path string using the `getPath` method then the path string returned by this method may differ from the original String used to create the path. The returned path string uses the default name `separator` to separate names in the path. Returns:String the string representation of this path Annotations @Override

public String toString()

Returns the string representation of this path.

If this path was created by converting a path string using the getPath method then the path string returned by this method may differ from the original String used to create the path.

The returned path string uses the default name separator to separate names in the path.

Returns:String

the string representation of this path

Annotations

@Override

toUri back to summary

toUri	back to summary
public URI toUri() Returns a URI to represent this path. This method constructs an absolute `URI` with a `scheme` equal to the URI scheme that identifies the provider. The exact form of the scheme specific part is highly provider dependent. In the case of the default provider, the URI is hierarchical with a `path` component that is absolute. The query and fragment components are undefined. Whether the authority component is defined or not is implementation dependent. There is no guarantee that the `URI` may be used to construct a `java.io.File`. In particular, if this path represents a Universal Naming Convention (UNC) path, then the UNC server name may be encoded in the authority component of the resulting URI. In the case of the default provider, and the file exists, and it can be determined that the file is a directory, then the resulting `URI` will end with a slash. The default provider provides a similar round-trip guarantee to the `java.io.File` class. For a given `Path` p it is guaranteed that `Path.of(`p`.toUri()).equals(`p `.toAbsolutePath())` so long as the original `Path`, the `URI`, and the new `Path` are all created in (possibly different invocations of) the same Java virtual machine. Whether other providers make any guarantees is provider specific and therefore unspecified. When a file system is constructed to access the contents of a file as a file system then it is highly implementation specific if the returned URI represents the given path in the file system or it represents a compound URI that encodes the URI of the enclosing file system. A format for compound URIs is not defined in this release; such a scheme may be added in a future release. Returns:URI the URI representing this path Exceptions IOError: if an I/O error occurs obtaining the absolute path, or where a file system is constructed to access the contents of a file as a file system, and the URI of the enclosing file system cannot be obtained

public URI toUri()

Returns a URI to represent this path.

This method constructs an absolute URI with a scheme equal to the URI scheme that identifies the provider. The exact form of the scheme specific part is highly provider dependent.

In the case of the default provider, the URI is hierarchical with a path component that is absolute. The query and fragment components are undefined. Whether the authority component is defined or not is implementation dependent. There is no guarantee that the URI may be used to construct a java.io.File. In particular, if this path represents a Universal Naming Convention (UNC) path, then the UNC server name may be encoded in the authority component of the resulting URI. In the case of the default provider, and the file exists, and it can be determined that the file is a directory, then the resulting URI will end with a slash.

The default provider provides a similar round-trip guarantee to the java.io.File class. For a given Path p it is guaranteed that

Path.of(p.toUri()).equals(p .toAbsolutePath())

When a file system is constructed to access the contents of a file as a file system then it is highly implementation specific if the returned URI represents the given path in the file system or it represents a compound URI that encodes the URI of the enclosing file system. A format for compound URIs is not defined in this release; such a scheme may be added in a future release.

Returns:URI

the URI representing this path

Exceptions

IOError:: if an I/O error occurs obtaining the absolute path, or where a file system is constructed to access the contents of a file as a file system, and the URI of the enclosing file system cannot be obtained

public Interface Path

Accessing Files

Interoperability

Concurrency

Method Summary

Method Detail