Javadoc

Author: garydgregory

commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileName.java

@@ -171,7 +171,7 @@ public boolean equals(final Object o) {
     }
 
     /**
-     * Returns the base name of the file.
+     * Gets the base name of the file.
      *
      * @return The base name of the file.
      */
@@ -190,7 +190,7 @@ public String getBaseName() {
     }
 
     /**
-     * Returns the depth of this file name, within its file system.
+     * Gets the depth of this file name, within its file system.
      *
      * @return The depth of the file name.
      */
@@ -208,7 +208,7 @@ public int getDepth() {
     }
 
     /**
-     * Returns the extension of this file name.
+     * Gets the extension of this file name.
      *
      * @return The file extension.
      */
@@ -233,7 +233,7 @@ public String getExtension() {
     }
 
     /**
-     * Returns the URI without a password.
+     * Gets the URI without a password.
      *
      * @return the URI without a password.
      */
@@ -243,7 +243,7 @@ public String getFriendlyURI() {
     }
 
     /**
-     * Create a path that does not use the FileType since that field is not immutable.
+     * Gets a path that does not use the FileType since that field is not immutable.
      *
      * @return The key.
      */
@@ -255,7 +255,7 @@ private String getKey() {
     }
 
     /**
-     * Returns the name of the parent of the file.
+     * Gets the name of the parent of the file.
      *
      * @return the FileName of the parent.
      */
@@ -277,7 +277,7 @@ public FileName getParent() {
     }
 
     /**
-     * Returns the absolute path of the file, relative to the root of the file system that the file belongs to.
+     * Gets the absolute path of the file, relative to the root of the file system that the file belongs to.
      *
      * @return The path String.
      */
@@ -290,7 +290,7 @@ public String getPath() {
     }
 
     /**
-     * Returns the decoded path.
+     * Gets the decoded path.
      *
      * @return The decoded path String.
      * @throws FileSystemException If an error occurs.
@@ -305,7 +305,7 @@ public String getPathDecoded() throws FileSystemException {
     }
 
     /**
-     * Converts a file name to a relative name, relative to this file name.
+     * Gets a file name to a relative name, relative to this file name.
      *
      * @param name The FileName.
      * @return The relative path to the file.
@@ -363,7 +363,7 @@ public String getRelativeName(final FileName name) throws FileSystemException {
     }
 
     /**
-     * find the root of the file system.
+     * Gets the root of the file system.
      *
      * @return The root FileName.
      */
@@ -378,7 +378,7 @@ public FileName getRoot() {
     }
 
     /**
-     * Returns the root URI of the file system this file belongs to.
+     * Gets the root URI of the file system this file belongs to.
      *
      * @return The URI of the root.
      */
@@ -394,7 +394,7 @@ public String getRootURI() {
     }
 
     /**
-     * Returns the URI scheme of this file.
+     * Gets the URI scheme of this file.
      *
      * @return The protocol used to access the file.
      */
@@ -404,7 +404,7 @@ public 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. n this case the name is a
      * {@link FileType#FOLDER} if it ends with an "/" else it will be a {@link FileType#FILE}.
@@ -421,7 +421,7 @@ public FileType getType() {
     }
 
     /**
-     * Returns the absolute URI of the file.
+     * Gets the absolute URI of the file.
      *
      * @return The absolute URI of the file.
      */