Apache Mina SSHD 2.15.0 · org.apache.sshd.common.file.util.BasePath

Modifier and Type	Field and Description
private final FS	fileSystem
private int	hashValue
protected final List<String>	names
protected final String	root
private String	strValue

Access	Constructor and Description
protected	BasePath(FS fileSystem, String root, List<String> names)

Method Summary

Modifier and Type	Method and Description
protected String	asString()
protected T	asT()
protected int	calculatedHashCode()
protected T	checkPath(Path paramPath)
protected int	compare(String s1, String s2)
public int	compareTo(Path the path compared to this path. paramPath) Implements java.nio.file.Path.compareTo. Compares two abstract paths lexicographically.
protected T	create(String root, String... names)
protected T	create(String root, Collection<String> names)
protected T	create(String root, List<String> names)
protected boolean	endsWith(List<?> list, List<?> other)
public boolean	endsWith(Path the given path other) Implements java.nio.file.Path.endsWith. Tests if this path ends with the given path.
public boolean	endsWith(String the given path string other) Overrides default java.nio.file.Path.endsWith. 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	equals(Object the object to which this object is to be compared obj) Overrides java.lang.Object.equals. Implements java.nio.file.Path.equals. Tests this path for equality with the given object.
public T	getFileName() Implements java.nio.file.Path.getFileName. Returns the name of the file or directory denoted by this path as a `Path` object.
public FS	getFileSystem() Implements java.nio.file.Path.getFileSystem. Returns the file system that created this object.
public T	getName(int the index of the element index) Implements java.nio.file.Path.getName. Returns a name element of this path as a `Path` object.
public int	getNameCount() Implements java.nio.file.Path.getNameCount. Returns the number of name elements in the path.
public T	getParent() Implements java.nio.file.Path.getParent. Returns the parent path, or `null` if this path does not have a parent.
public T	getRoot() Implements java.nio.file.Path.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	hashCode() Overrides java.lang.Object.hashCode. Implements java.nio.file.Path.hashCode. Computes a hash code for this path.
public boolean	isAbsolute() Implements java.nio.file.Path.isAbsolute. Tells whether or not this path is absolute.
protected boolean	isNormal()
public Iterator<Path>	iterator() Overrides default java.nio.file.Path.iterator. Returns an iterator over the name elements of this path.
public T	normalize() Implements java.nio.file.Path.normalize. Returns a path that is this path with redundant name elements eliminated.
public WatchKey	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) Overrides default java.nio.file.Path.register. Registers the file located by this path with a watch service.
public WatchKey	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) Implements java.nio.file.Path.register. Registers the file located by this path with a watch service.
public T	relativize(Path the path to relativize against this path other) Implements java.nio.file.Path.relativize. Constructs a relative path between this path and a given path.
public T	resolve(Path the path to resolve against this path other) Implements java.nio.file.Path.resolve. Resolve the given path against this path.
public T	resolve(String the path string to resolve against this path other) Overrides default java.nio.file.Path.resolve. Converts a given path string to a `Path` and resolves it against this `Path` in exactly the manner specified by the `resolve` method.
public Path	resolveSibling(Path the path to resolve against this path's parent other) Overrides default java.nio.file.Path.resolveSibling. Resolves the given path against this path's `parent` path.
public Path	resolveSibling(String the path string to resolve against this path's parent other) Overrides default java.nio.file.Path.resolveSibling. 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.
protected boolean	startsWith(List<?> list, List<?> other)
public boolean	startsWith(Path the given path other) Implements java.nio.file.Path.startsWith. Tests if this path starts with the given path.
public boolean	startsWith(String the given path string other) Overrides default java.nio.file.Path.startsWith. 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 T	subpath(int the index of the first element, inclusive beginIndex, int the index of the last element, exclusive endIndex) Implements java.nio.file.Path.subpath. Returns a relative `Path` that is a subsequence of the name elements of this path.
public T	toAbsolutePath() Implements java.nio.file.Path.toAbsolutePath. Returns a `Path` object representing the absolute path of this path.
public File	toFile() Overrides default java.nio.file.Path.toFile. Returns a `File` object representing this path.
public String	toString() Overrides java.lang.Object.toString. Implements java.nio.file.Path.toString. Returns the string representation of this path.
public URI	toUri() Implements java.nio.file.Path.toUri. Returns a URI to represent this path.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

fileSystem	back to summary
private final FS fileSystem

hashValue	back to summary
private int hashValue

names	back to summary
protected final List<String> names

root	back to summary
protected final String root

strValue	back to summary
private String strValue

BasePath	back to summary
protected BasePath(FS fileSystem, String root, List<String> names)

Method Detail

asString	back to summary
protected String asString()

asT	back to summary
protected T asT() Annotations @SuppressWarnings:unchecked

calculatedHashCode	back to summary
protected int calculatedHashCode()

checkPath	back to summary
protected T checkPath(Path paramPath) Annotations @SuppressWarnings:unchecked

compare	back to summary
protected int compare(String s1, String s2)

compareTo back to summary

compareTo	back to summary
public int compareTo(Path paramPath) Implements java.nio.file.Path.compareTo. Doc from java.nio.file.Path.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 paramPath: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

public int compareTo(Path paramPath)

Implements java.nio.file.Path.compareTo.

Doc from java.nio.file.Path.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

paramPath: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

create	back to summary
protected T create(String root, String... names)

create	back to summary
protected T create(String root, Collection<String> names)

create	back to summary
protected T create(String root, List<String> names)

endsWith	back to summary
protected boolean endsWith(List<?> list, List<?> other)

endsWith back to summary

endsWith	back to summary
public boolean endsWith(Path other) Implements java.nio.file.Path.endsWith. Doc from java.nio.file.Path.endsWith. 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` Annotations @Override

public boolean endsWith(Path other)

Implements java.nio.file.Path.endsWith.

Doc from java.nio.file.Path.endsWith.

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

Annotations

@Override

endsWith back to summary

endsWith	back to summary
public boolean endsWith(String other) Overrides default java.nio.file.Path.endsWith. Doc from java.nio.file.Path.endsWith. 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`. Parameters other:String the given path string Returns:boolean `true` if this path ends with the given path; otherwise `false` Annotations @Override

public boolean endsWith(String other)

Overrides default java.nio.file.Path.endsWith.

Doc from java.nio.file.Path.endsWith.

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.

Parameters

other:String: the given path string

Returns:boolean

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

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Implements java.nio.file.Path.equals. Doc from java.nio.file.Path.equals. 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 obj: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 obj)

Overrides java.lang.Object.equals.

Implements java.nio.file.Path.equals.

Doc from java.nio.file.Path.equals.

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

obj: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 T getFileName() Implements java.nio.file.Path.getFileName. Doc from java.nio.file.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:T a path representing the name of the file or directory, or `null` if this path has zero elements Annotations @Override

public T getFileName()

Implements java.nio.file.Path.getFileName.

Doc from java.nio.file.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:T

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

Annotations

@Override

getFileSystem	back to summary
public FS getFileSystem() Implements java.nio.file.Path.getFileSystem. Doc from java.nio.file.Path.getFileSystem. Returns the file system that created this object. Returns:FS the file system that created this object Annotations @Override

getFileSystem

back to summary

public FS getFileSystem()

Implements java.nio.file.Path.getFileSystem.

Doc from java.nio.file.Path.getFileSystem.

Returns the file system that created this object.

Returns:FS

the file system that created this object

Annotations

@Override

getName back to summary

getName	back to summary
public T getName(int index) Implements java.nio.file.Path.getName. Doc from java.nio.file.Path.getName. 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:T the name element Annotations @Override

public T getName(int index)

Implements java.nio.file.Path.getName.

Doc from java.nio.file.Path.getName.

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:T

the name element

Annotations

@Override

getNameCount back to summary

getNameCount	back to summary
public int getNameCount() Implements java.nio.file.Path.getNameCount. Doc from java.nio.file.Path.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 Annotations @Override

public int getNameCount()

Implements java.nio.file.Path.getNameCount.

Doc from java.nio.file.Path.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

Annotations

@Override

getParent back to summary

getParent	back to summary
public T getParent() Implements java.nio.file.Path.getParent. Doc from java.nio.file.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:T a path representing the path's parent Annotations @Override

public T getParent()

Implements java.nio.file.Path.getParent.

Doc from java.nio.file.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:T

a path representing the path's parent

Annotations

@Override

getRoot back to summary

getRoot	back to summary
public T getRoot() Implements java.nio.file.Path.getRoot. Doc from java.nio.file.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:T a path representing the root component of this path, or `null` Annotations @Override

public T getRoot()

Implements java.nio.file.Path.getRoot.

Doc from java.nio.file.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:T

a path representing the root component of this path, or null

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Implements java.nio.file.Path.hashCode. Doc from java.nio.file.Path.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()

Overrides java.lang.Object.hashCode.

Implements java.nio.file.Path.hashCode.

Doc from java.nio.file.Path.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() Implements java.nio.file.Path.isAbsolute. Doc from java.nio.file.Path.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 Annotations @Override

public boolean isAbsolute()

Implements java.nio.file.Path.isAbsolute.

Doc from java.nio.file.Path.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

Annotations

@Override

isNormal	back to summary
protected boolean isNormal()

iterator back to summary

iterator	back to summary
public Iterator<Path> iterator() Overrides default java.nio.file.Path.iterator. Doc from java.nio.file.Path.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. Returns:Iterator<Path> an iterator over the name elements of this path Annotations @Override

public Iterator<Path> iterator()

Overrides default java.nio.file.Path.iterator.

Doc from java.nio.file.Path.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.

Returns:Iterator<Path>

an iterator over the name elements of this path

Annotations

@Override

normalize back to summary

normalize	back to summary
public T normalize() Implements java.nio.file.Path.normalize. Doc from java.nio.file.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:T 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 Annotations @Override

public T normalize()

Implements java.nio.file.Path.normalize.

Doc from java.nio.file.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:T

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

Annotations

@Override

register	back to summary
public WatchKey register(WatchService watcher, WatchEvent.Kind<?>... events) throws IOException Overrides default java.nio.file.Path.register. Doc from java.nio.file.Path.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); 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

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

Overrides default java.nio.file.Path.register.

Doc from java.nio.file.Path.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);

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

register	back to summary
public WatchKey register(WatchService watcher, WatchEvent.Kind<?>[] events, WatchEvent.Modifier... modifiers) throws IOException Implements java.nio.file.Path.register. Doc from java.nio.file.Path.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

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

Implements java.nio.file.Path.register.

Doc from java.nio.file.Path.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

relativize back to summary

relativize	back to summary
public T relativize(Path other) Implements java.nio.file.Path.relativize. Doc from java.nio.file.Path.relativize. 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:T the resulting relative path, or an empty path if both paths are equal Annotations @Override

public T relativize(Path other)

Implements java.nio.file.Path.relativize.

Doc from java.nio.file.Path.relativize.

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:T

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

Annotations

@Override

resolve back to summary

resolve	back to summary
public T resolve(Path other) Implements java.nio.file.Path.resolve. Doc from java.nio.file.Path.resolve. 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:T the resulting path Annotations @Override

public T resolve(Path other)

Implements java.nio.file.Path.resolve.

Doc from java.nio.file.Path.resolve.

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:T

the resulting path

Annotations

@Override

resolve back to summary

resolve	back to summary
public T resolve(String other) Overrides default java.nio.file.Path.resolve. Doc from java.nio.file.Path.resolve. 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`". Parameters other:String the path string to resolve against this path Returns:T the resulting path Annotations @Override

public T resolve(String other)

Overrides default java.nio.file.Path.resolve.

Doc from java.nio.file.Path.resolve.

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".

Parameters

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

Returns:T

the resulting path

Annotations

@Override

resolveSibling back to summary

resolveSibling	back to summary
public Path resolveSibling(Path other) Overrides default java.nio.file.Path.resolveSibling. Doc from java.nio.file.Path.resolveSibling. 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. Parameters other:Path the path to resolve against this path's parent Returns:Path the resulting path Annotations @Override

public Path resolveSibling(Path other)

Overrides default java.nio.file.Path.resolveSibling.

Doc from java.nio.file.Path.resolveSibling.

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.

Parameters

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

Returns:Path

the resulting path

Annotations

@Override

resolveSibling back to summary

resolveSibling	back to summary
public Path resolveSibling(String other) Overrides default java.nio.file.Path.resolveSibling. Doc from java.nio.file.Path.resolveSibling. 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. Parameters other:String the path string to resolve against this path's parent Returns:Path the resulting path Annotations @Override

public Path resolveSibling(String other)

Overrides default java.nio.file.Path.resolveSibling.

Doc from java.nio.file.Path.resolveSibling.

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.

Parameters

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

Returns:Path

the resulting path

Annotations

@Override

startsWith	back to summary
protected boolean startsWith(List<?> list, List<?> other)

startsWith back to summary

startsWith	back to summary
public boolean startsWith(Path other) Implements java.nio.file.Path.startsWith. Doc from java.nio.file.Path.startsWith. 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` Annotations @Override

public boolean startsWith(Path other)

Implements java.nio.file.Path.startsWith.

Doc from java.nio.file.Path.startsWith.

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

Annotations

@Override

startsWith back to summary

startsWith	back to summary
public boolean startsWith(String other) Overrides default java.nio.file.Path.startsWith. Doc from java.nio.file.Path.startsWith. 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`". Parameters other:String the given path string Returns:boolean `true` if this path starts with the given path; otherwise `false` Annotations @Override

public boolean startsWith(String other)

Overrides default java.nio.file.Path.startsWith.

Doc from java.nio.file.Path.startsWith.

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".

Parameters

other:String: the given path string

Returns:boolean

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

Annotations

@Override

subpath back to summary

subpath	back to summary
public T subpath(int beginIndex, int endIndex) Implements java.nio.file.Path.subpath. Doc from java.nio.file.Path.subpath. 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:T a new `Path` object that is a subsequence of the name elements in this `Path` Annotations @Override

public T subpath(int beginIndex, int endIndex)

Implements java.nio.file.Path.subpath.

Doc from java.nio.file.Path.subpath.

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:T

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

Annotations

@Override

toAbsolutePath back to summary

toAbsolutePath	back to summary
public T toAbsolutePath() Implements java.nio.file.Path.toAbsolutePath. Doc from java.nio.file.Path.toAbsolutePath. Returns a `Path` object representing the absolute path of this path. 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:T a `Path` object representing the absolute path Annotations @Override

public T toAbsolutePath()

Implements java.nio.file.Path.toAbsolutePath.

Doc from java.nio.file.Path.toAbsolutePath.

Returns a Path object representing the absolute path of this path.

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:T

a Path object representing the absolute path

Annotations

@Override

toFile back to summary

toFile	back to summary
public File toFile() Overrides default java.nio.file.Path.toFile. Doc from java.nio.file.Path.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`. Returns:File a `File` object representing this path Annotations @Override

public File toFile()

Overrides default java.nio.file.Path.toFile.

Doc from java.nio.file.Path.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.

Returns:File

a File object representing this path

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Implements java.nio.file.Path.toString. Doc from java.nio.file.Path.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()

Overrides java.lang.Object.toString.

Implements java.nio.file.Path.toString.

Doc from java.nio.file.Path.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() Implements java.nio.file.Path.toUri. Doc from java.nio.file.Path.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 Annotations @Override

public URI toUri()

Implements java.nio.file.Path.toUri.

Doc from java.nio.file.Path.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

Annotations

@Override

public abstract Class BasePath<T extends BasePath<T, FS>, FS extends BaseFileSystem<T>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail