This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-vfs.git
commit 166a5726666fb5b18ca4146ddfcc7cfec8e5d1a1
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sat Mar 27 14:36:06 2021 -0400
Javadoc.
---
.../java/org/apache/commons/vfs2/FileName.java | 41 +++++++++++-----------
1 file changed, 21 insertions(+), 20 deletions(-)
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileName.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileName.java
index 7c65782..e0cfa55 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileName.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileName.java
@@ -46,7 +46,7 @@ public interface FileName extends Comparable<FileName> {
FileName[] EMPTY_ARRAY = new FileName[0];
/**
- * Returns the base name of this file. The base name is the last element
of the file name. For example the base name
+ * Gets the base name of this file. The base name is the last element of
the file name. For example the base name
* of {@code /somefolder/somefile} is {@code somefile}.
* <p>
* The root file of a file system has an empty base name.
@@ -57,7 +57,7 @@ public interface FileName extends Comparable<FileName> {
String getBaseName();
/**
- * Returns the depth of this file name, within its file system. The depth
of the root of a file system is 0. The
+ * Gets the depth of this file name, within its file system. The depth of
the root of a file system is 0. The
* depth of any other file is 1 + the depth of its parent.
*
* @return The depth of this file name.
@@ -65,14 +65,14 @@ public interface FileName extends Comparable<FileName> {
int getDepth();
/**
- * Returns the extension of this file name.
+ * Gets the extension of this file name.
*
* @return The extension. Returns an empty string if the name has no
extension.
*/
String getExtension();
/**
- * Returns a "friendly path", this is a path without a password.
+ * Gets a "friendly path", this is a path without a password.
* <p>
* This path can not be used to resolve the path again.
* </p>
@@ -82,15 +82,15 @@ public interface FileName extends Comparable<FileName> {
String getFriendlyURI();
/**
- * Returns the file name of the parent of this file. The root of a file
system has no parent.
+ * Gets the file name of the parent of this file. The root of a file
system has no parent.
*
* @return A {@link FileName} object representing the parent name. Returns
null for the root of a file system.
*/
FileName getParent();
/**
- * Returns the absolute path of this file, within its file system. This
path is normalized, so that {@code .} and
- * {@code ..} elements have been removed. Also, the path only contains
{@code /} as its separator character. The
+ * Gets the absolute path string of this file, within its file system.
This path is normalized, so that {@code .}
+ * and {@code ..} elements have been removed. Also, the path only contains
{@code /} as its separator character. The
* path always starts with {@code /}
* <p>
* The root of a file system has {@code /} as its absolute path.
@@ -108,10 +108,11 @@ public interface FileName extends Comparable<FileName> {
* The root of a file system has {@code /} as its absolute path.
* </p>
* <p>
- * In contrast to {@link #getPath()} the path is decoded i.e. all %nn
stuff replaced by its character.
+ * In contrast to {@link #getPath()}, this path is decoded: All %nn
escapes are replaced by their respective
+ * characters.
* </p>
*
- * @return The path. Never returns null.
+ * @return The decoded path. Never returns null.
* @throws FileSystemException if the path is not correctly encoded
*/
String getPathDecoded() throws FileSystemException;
@@ -126,28 +127,28 @@ public interface FileName extends Comparable<FileName> {
String getRelativeName(FileName name) throws FileSystemException;
/**
- * Finds the root of the file system.
+ * Gets the root of the file system.
*
* @return the file system root.
*/
FileName getRoot();
/**
- * Returns the root URI of the file system this file belongs to.
+ * Gets the root URI string of the file system this file belongs to.
*
- * @return the root URI.
+ * @return the root URI string.
*/
String getRootURI();
/**
- * Returns the URI scheme of this file.
+ * Gets the URI scheme of this file.
*
* @return The URI scheme of this file.
*/
String getScheme();
/**
- * Returns the requested or current type of this name.
+ * Gets the requested or current type of this name.
* <p>
* The "requested" type is the one determined during resolving the name.
In this case the name is a
* {@link FileType#FOLDER} if it ends with an "/" else it will be a {@link
FileType#FILE}.
@@ -161,14 +162,14 @@ public interface FileName extends Comparable<FileName> {
FileType getType();
/**
- * Returns the absolute URI of this file.
+ * Gets the absolute URI string of this file.
*
- * @return the absolute URI of this file.
+ * @return the absolute URI string of this file.
*/
String getURI();
/**
- * Determines if another file name is an ancestor of this file name.
+ * Tests if another file name is an ancestor of this file name.
*
* @param ancestor The FileName to check.
* @return true if another file name is an ancestor of this file name.
@@ -176,7 +177,7 @@ public interface FileName extends Comparable<FileName> {
boolean isAncestor(FileName ancestor);
/**
- * Determines if another file name is a descendent of this file name.
+ * Tests if another file name is a descendent of this file name.
*
* @param descendent the FileName to check.
* @return true if the other FileName is a descendent of this file name.
@@ -184,7 +185,7 @@ public interface FileName extends Comparable<FileName> {
boolean isDescendent(FileName descendent);
/**
- * Determines if another file name is a descendent of this file name.
+ * Tests if another file name is a descendent of this file name.
*
* @param descendent the FileName to check.
* @param nameScope the NameScope of the FileName.
@@ -193,7 +194,7 @@ public interface FileName extends Comparable<FileName> {
boolean isDescendent(FileName descendent, NameScope nameScope);
/**
- * Checks if this file name is a name for a regular file.
+ * Tests if this file name is a name for a regular file.
*
* @return true if this file name is a name for a regular file.
* @throws FileSystemException if an error occurs.
