This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-vfs.git
The following commit(s) were added to refs/heads/master by this push:
new a1097262d Javadoc
a1097262d is described below
commit a1097262d45705b2701256f733fb0ef642090b6a
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:47:08 2026 -0400
Javadoc
---
.../org/apache/commons/vfs2/tasks/CopyTask.java | 4 +-
.../vfs2/provider/webdav/WebdavFileNameParser.java | 2 +-
.../webdav/WebdavFileSystemConfigBuilder.java | 2 +-
.../provider/webdav/WebdavMethodRetryHandler.java | 2 +-
.../vfs2/provider/webdav/test/JcrUtils.java | 8 +--
.../provider/webdav4/Webdav4FileNameParser.java | 2 +-
.../webdav4/Webdav4FileSystemConfigBuilder.java | 2 +-
.../provider/webdav4s/Webdav4sFileNameParser.java | 2 +-
.../vfs2/provider/webdav4/test/JcrUtils.java | 8 +--
.../vfs2/provider/smb/SmbFileNameParser.java | 2 +-
.../org/apache/commons/vfs2/CacheStrategy.java | 4 +-
.../java/org/apache/commons/vfs2/FileContent.java | 12 ++--
.../java/org/apache/commons/vfs2/FileName.java | 8 +--
.../java/org/apache/commons/vfs2/FileObject.java | 12 ++--
.../java/org/apache/commons/vfs2/FileSystem.java | 4 +-
.../commons/vfs2/FileSystemConfigBuilder.java | 78 +++++++++++-----------
.../apache/commons/vfs2/FileSystemException.java | 4 +-
.../org/apache/commons/vfs2/FileSystemManager.java | 12 ++--
.../java/org/apache/commons/vfs2/FilesCache.java | 2 +-
.../apache/commons/vfs2/RandomAccessContent.java | 6 +-
.../src/main/java/org/apache/commons/vfs2/VFS.java | 2 +-
.../commons/vfs2/filter/ConditionalFileFilter.java | 2 +-
.../org/apache/commons/vfs2/filter/IOCase.java | 8 +--
.../commons/vfs2/filter/WildcardFileFilter.java | 2 +-
.../commons/vfs2/impl/DecoratedFileObject.java | 2 +-
.../commons/vfs2/impl/DefaultFileReplicator.java | 8 +--
.../vfs2/impl/DefaultFileSystemConfigBuilder.java | 2 +-
.../vfs2/impl/DefaultFileSystemManager.java | 6 +-
.../vfs2/impl/DefaultVfsComponentContext.java | 2 +-
.../commons/vfs2/impl/ProviderConfiguration.java | 6 +-
.../commons/vfs2/impl/VirtualFileSystem.java | 2 +-
.../vfs2/operations/AbstractFileOperation.java | 2 +-
.../operations/AbstractFileOperationProvider.java | 2 +-
.../vfs2/operations/FileOperationProvider.java | 2 +-
.../commons/vfs2/operations/vcs/VcsStatus.java | 2 +-
.../commons/vfs2/provider/AbstractFileName.java | 8 +--
.../commons/vfs2/provider/AbstractFileObject.java | 12 ++--
.../vfs2/provider/AbstractFileProvider.java | 4 +-
.../commons/vfs2/provider/AbstractFileSystem.java | 10 +--
.../commons/vfs2/provider/DefaultFileContent.java | 10 +--
.../commons/vfs2/provider/DelegateFileObject.java | 2 +-
.../commons/vfs2/provider/GenericURLFileName.java | 6 +-
.../commons/vfs2/provider/HostFileNameParser.java | 16 ++---
.../vfs2/provider/LayeredFileNameParser.java | 4 +-
.../apache/commons/vfs2/provider/URLFileName.java | 6 +-
.../commons/vfs2/provider/VfsComponentContext.java | 4 +-
.../compressed/CompressedFileFileObject.java | 2 +-
.../vfs2/provider/ftp/FTPClientWrapper.java | 4 +-
.../vfs2/provider/ftp/FtpFileNameParser.java | 2 +-
.../provider/ftp/FtpFileSystemConfigBuilder.java | 8 +--
.../provider/ftps/FtpsFileSystemConfigBuilder.java | 6 +-
.../vfs2/provider/http/HttpFileNameParser.java | 2 +-
.../commons/vfs2/provider/http/HttpFileObject.java | 6 +-
.../commons/vfs2/provider/http/HttpFileSystem.java | 2 +-
.../provider/http/HttpFileSystemConfigBuilder.java | 6 +-
.../vfs2/provider/http4/Http4FileNameParser.java | 2 +-
.../vfs2/provider/http4/Http4FileObject.java | 4 +-
.../vfs2/provider/http4/Http4FileSystem.java | 6 +-
.../http4/Http4FileSystemConfigBuilder.java | 6 +-
.../vfs2/provider/http4s/Http4sFileNameParser.java | 2 +-
.../vfs2/provider/http5/Http5FileNameParser.java | 2 +-
.../vfs2/provider/http5/Http5FileObject.java | 4 +-
.../vfs2/provider/http5/Http5FileSystem.java | 6 +-
.../http5/Http5FileSystemConfigBuilder.java | 6 +-
.../vfs2/provider/http5s/Http5sFileNameParser.java | 2 +-
.../vfs2/provider/https/HttpsFileNameParser.java | 2 +-
.../provider/local/DefaultLocalFileProvider.java | 4 +-
.../vfs2/provider/local/GenericFileNameParser.java | 2 +-
.../commons/vfs2/provider/local/LocalFile.java | 2 +-
.../commons/vfs2/provider/local/LocalFileName.java | 2 +-
.../vfs2/provider/local/LocalFileNameParser.java | 2 +-
.../commons/vfs2/provider/ram/RamFileData.java | 12 ++--
.../commons/vfs2/provider/ram/RamFileObject.java | 4 +-
.../commons/vfs2/provider/ram/RamFileSystem.java | 2 +-
.../provider/ram/RamFileSystemConfigBuilder.java | 2 +-
.../vfs2/provider/res/ResourceFileName.java | 2 +-
.../vfs2/provider/res/ResourceFileNameParser.java | 2 +-
.../vfs2/provider/res/ResourceFileProvider.java | 2 +-
.../res/ResourceFileSystemConfigBuilder.java | 4 +-
.../vfs2/provider/sftp/BytesIdentityInfo.java | 8 +--
.../commons/vfs2/provider/sftp/IdentityInfo.java | 8 +--
.../vfs2/provider/sftp/SftpFileNameParser.java | 2 +-
.../commons/vfs2/provider/sftp/SftpFileSystem.java | 4 +-
.../provider/sftp/SftpFileSystemConfigBuilder.java | 20 +++---
.../commons/vfs2/provider/tar/TarFileSystem.java | 4 +-
.../commons/vfs2/provider/zip/ZipFileSystem.java | 4 +-
.../provider/zip/ZipFileSystemConfigBuilder.java | 4 +-
.../commons/vfs2/util/CombinedResources.java | 2 +-
.../util/DelegatingFileSystemOptionsBuilder.java | 2 +-
.../main/java/org/apache/commons/vfs2/util/Os.java | 2 +-
.../apache/commons/vfs2/util/PosixPermissions.java | 8 +--
.../org/apache/commons/vfs2/util/URIUtils.java | 4 +-
.../java/org/apache/commons/vfs2/FileInfo.java | 6 +-
.../org/apache/commons/vfs2/ProviderReadTests.java | 2 +-
.../java/org/apache/commons/vfs2/VfsTestUtils.java | 2 +-
.../vfs2/provider/sftp/SftpTestServerHelper.java | 2 +-
96 files changed, 257 insertions(+), 257 deletions(-)
diff --git
a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/CopyTask.java
b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/CopyTask.java
index 2b04d7606..f55d3545b 100644
--- a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/CopyTask.java
+++ b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/CopyTask.java
@@ -73,7 +73,7 @@ public class CopyTask extends AbstractSyncTask {
/**
* Tests whether overwrite is enabled.
*
- * @return the current value of overwrite
+ * @return The current value of overwrite
*/
public boolean isOverwrite() {
return overwrite;
@@ -82,7 +82,7 @@ public class CopyTask extends AbstractSyncTask {
/**
* Tests whether preserve last modified is enabled.
*
- * @return the current value of preserveLastModified
+ * @return The current value of preserveLastModified
*/
public boolean isPreserveLastModified() {
return preserveLastModified;
diff --git
a/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileNameParser.java
b/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileNameParser.java
index 86b4b6bbc..9e47910eb 100644
---
a/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileNameParser.java
+++
b/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileNameParser.java
@@ -31,7 +31,7 @@ public class WebdavFileNameParser extends HttpFileNameParser {
/**
* Gets the singleton instance.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static FileNameParser getInstance() {
return INSTANCE;
diff --git
a/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileSystemConfigBuilder.java
b/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileSystemConfigBuilder.java
index f4ecfa586..eff857679 100644
---
a/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileSystemConfigBuilder.java
+++
b/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileSystemConfigBuilder.java
@@ -34,7 +34,7 @@ public final class WebdavFileSystemConfigBuilder extends
HttpFileSystemConfigBui
/**
* Gets the singleton builder.
*
- * @return the singleton builder.
+ * @return The singleton builder.
*/
public static HttpFileSystemConfigBuilder getInstance() {
return BUILDER;
diff --git
a/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavMethodRetryHandler.java
b/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavMethodRetryHandler.java
index 20540dbe0..3797ee0c2 100644
---
a/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavMethodRetryHandler.java
+++
b/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavMethodRetryHandler.java
@@ -36,7 +36,7 @@ public final class WebdavMethodRetryHandler implements
HttpMethodRetryHandler {
/**
* Gets the singleton instance.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static WebdavMethodRetryHandler getInstance() {
return INSTANCE;
diff --git
a/commons-vfs2-jackrabbit1/src/test/java/org/apache/commons/vfs2/provider/webdav/test/JcrUtils.java
b/commons-vfs2-jackrabbit1/src/test/java/org/apache/commons/vfs2/provider/webdav/test/JcrUtils.java
index b08d97a63..45dc648e1 100644
---
a/commons-vfs2-jackrabbit1/src/test/java/org/apache/commons/vfs2/provider/webdav/test/JcrUtils.java
+++
b/commons-vfs2-jackrabbit1/src/test/java/org/apache/commons/vfs2/provider/webdav/test/JcrUtils.java
@@ -61,7 +61,7 @@ final class JcrUtils {
*
* @param parent parent node
* @param name name of the child node
- * @return the child node
+ * @return The child node
* @throws RepositoryException if the child node cannot be accessed or
created
*/
public static Node getOrAddFolder(final Node parent, final String name)
throws RepositoryException {
@@ -79,7 +79,7 @@ final class JcrUtils {
* @param parent parent node
* @param name name of the child node
* @param type type of the child node, ignored if the child already exists
- * @return the child node
+ * @return The child node
* @throws RepositoryException if the child node cannot be accessed or
created
*/
public static Node getOrAddNode(final Node parent, final String name,
final String type)
@@ -118,7 +118,7 @@ final class JcrUtils {
* @param name name of the file
* @param mime media type of the file
* @param data binary content of the file
- * @return the child node
+ * @return The child node
* @throws RepositoryException if the child node cannot be created or
updated
*/
public static Node putFile(final Node parent, final String name, final
String mime, final InputStream data)
@@ -155,7 +155,7 @@ final class JcrUtils {
* @param mime media type of the file
* @param data binary content of the file
* @param date date of last modification
- * @return the child node
+ * @return The child node
* @throws RepositoryException if the child node cannot be created or
updated
*/
public static Node putFile(final Node parent, final String name, final
String mime, final InputStream data,
diff --git
a/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileNameParser.java
b/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileNameParser.java
index 06afea17f..b2eeed035 100644
---
a/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileNameParser.java
+++
b/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileNameParser.java
@@ -30,7 +30,7 @@ public class Webdav4FileNameParser extends
Http4FileNameParser {
/**
* Gets the singleton instance.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static FileNameParser getInstance() {
return INSTANCE;
diff --git
a/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileSystemConfigBuilder.java
b/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileSystemConfigBuilder.java
index 85a937d02..35b57a6a9 100644
---
a/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileSystemConfigBuilder.java
+++
b/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileSystemConfigBuilder.java
@@ -46,7 +46,7 @@ public final class Webdav4FileSystemConfigBuilder extends
Http4FileSystemConfigB
/**
* Gets the singleton builder.
*
- * @return the singleton builder.
+ * @return The singleton builder.
*/
public static Webdav4FileSystemConfigBuilder getInstance() {
return BUILDER;
diff --git
a/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4s/Webdav4sFileNameParser.java
b/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4s/Webdav4sFileNameParser.java
index 3031eeb80..0049e9853 100644
---
a/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4s/Webdav4sFileNameParser.java
+++
b/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4s/Webdav4sFileNameParser.java
@@ -31,7 +31,7 @@ public class Webdav4sFileNameParser extends
Http4sFileNameParser {
/**
* Gets the singleton instance.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static FileNameParser getInstance() {
return INSTANCE;
diff --git
a/commons-vfs2-jackrabbit2/src/test/java/org/apache/commons/vfs2/provider/webdav4/test/JcrUtils.java
b/commons-vfs2-jackrabbit2/src/test/java/org/apache/commons/vfs2/provider/webdav4/test/JcrUtils.java
index 2a00fd595..34cfd02aa 100644
---
a/commons-vfs2-jackrabbit2/src/test/java/org/apache/commons/vfs2/provider/webdav4/test/JcrUtils.java
+++
b/commons-vfs2-jackrabbit2/src/test/java/org/apache/commons/vfs2/provider/webdav4/test/JcrUtils.java
@@ -61,7 +61,7 @@ final class JcrUtils {
*
* @param parent parent node
* @param name name of the child node
- * @return the child node
+ * @return The child node
* @throws RepositoryException if the child node cannot be accessed or
created
*/
public static Node getOrAddFolder(final Node parent, final String name)
throws RepositoryException {
@@ -79,7 +79,7 @@ final class JcrUtils {
* @param parent parent node
* @param name name of the child node
* @param type type of the child node, ignored if the child already exists
- * @return the child node
+ * @return The child node
* @throws RepositoryException if the child node cannot be accessed or
created
*/
public static Node getOrAddNode(final Node parent, final String name,
final String type)
@@ -118,7 +118,7 @@ final class JcrUtils {
* @param name name of the file
* @param mime media type of the file
* @param data binary content of the file
- * @return the child node
+ * @return The child node
* @throws RepositoryException if the child node cannot be created or
updated
*/
public static Node putFile(final Node parent, final String name, final
String mime, final InputStream data)
@@ -155,7 +155,7 @@ final class JcrUtils {
* @param mime media type of the file
* @param data binary content of the file
* @param date date of last modification
- * @return the child node
+ * @return The child node
* @throws RepositoryException if the child node cannot be created or
updated
*/
public static Node putFile(final Node parent, final String name, final
String mime, final InputStream data,
diff --git
a/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileNameParser.java
b/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileNameParser.java
index f6c03a49c..85dcac5ca 100644
---
a/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileNameParser.java
+++
b/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileNameParser.java
@@ -35,7 +35,7 @@ public class SmbFileNameParser extends URLFileNameParser {
/**
* Gets the singleton instance.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static FileNameParser getInstance() {
return INSTANCE;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/CacheStrategy.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/CacheStrategy.java
index 1ad05c426..f109ae48f 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/CacheStrategy.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/CacheStrategy.java
@@ -49,7 +49,7 @@ public enum CacheStrategy {
/**
* Returns the name of the scope.
*
- * @return the name of the scope.
+ * @return The name of the scope.
*/
public String getName() {
return realName;
@@ -58,7 +58,7 @@ public enum CacheStrategy {
/**
* Returns the name of the scope.
*
- * @return the name of the scope.
+ * @return The name of the scope.
*/
@Override
public String toString() {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContent.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContent.java
index dcc7eec77..4df6f5672 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContent.java
@@ -118,7 +118,7 @@ public interface FileContent extends Closeable {
/**
* Gets the content info. e.g. type, encoding, ...
*
- * @return the FileContentInfo
+ * @return The FileContentInfo
* @throws FileSystemException if an error occurs.
*/
FileContentInfo getContentInfo() throws FileSystemException;
@@ -259,7 +259,7 @@ public interface FileContent extends Closeable {
* </p>
*
* @param mode The mode to use to access the file.
- * @return the stream for reading and writing the file's content.
+ * @return The stream for reading and writing the file's content.
* @throws FileSystemException If the file is read-only, or is being read,
or is being written, or on error opening
* the stream.
*/
@@ -357,7 +357,7 @@ public interface FileContent extends Closeable {
*
* @param output The target OutputStream.
* @throws IOException if an error occurs writing the content.
- * @return the total number of bytes written
+ * @return The total number of bytes written
* @since 2.1
*/
long write(FileContent output) throws IOException;
@@ -367,7 +367,7 @@ public interface FileContent extends Closeable {
*
* @param file The target FileObject.
* @throws IOException if an error occurs writing the content.
- * @return the total number of bytes written
+ * @return The total number of bytes written
* @since 2.1
*/
long write(FileObject file) throws IOException;
@@ -376,7 +376,7 @@ public interface FileContent extends Closeable {
* Writes this content to an OutputStream.
*
* @param output The target OutputStream.
- * @return the total number of bytes written
+ * @return The total number of bytes written
* @throws IOException if an error occurs writing the content.
* @since 2.1
*/
@@ -387,7 +387,7 @@ public interface FileContent extends Closeable {
*
* @param output The target OutputStream.
* @param bufferSize The buffer size to write data chunks.
- * @return the total number of bytes written
+ * @return The total number of bytes written
* @throws IOException if an error occurs writing the file.
* @since 2.1
*/
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 a0f45dc54..6ae42405c 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
@@ -77,7 +77,7 @@ public interface FileName extends Comparable<FileName> {
* This path cannot be used to resolve the path again.
* </p>
*
- * @return the friendly URI as a String.
+ * @return The friendly URI as a String.
*/
String getFriendlyURI();
@@ -129,14 +129,14 @@ public interface FileName extends Comparable<FileName> {
/**
* Gets the root of the file system.
*
- * @return the file system root.
+ * @return The file system root.
*/
FileName getRoot();
/**
* Gets the root URI string of the file system this file belongs to.
*
- * @return the root URI string.
+ * @return The root URI string.
*/
String getRootURI();
@@ -164,7 +164,7 @@ public interface FileName extends Comparable<FileName> {
/**
* Gets the absolute URI string of this file.
*
- * @return the absolute URI string of this file.
+ * @return The absolute URI string of this file.
*/
String getURI();
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileObject.java
index eb4437059..4f366ad8f 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileObject.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileObject.java
@@ -192,7 +192,7 @@ public interface FileObject extends Comparable<FileObject>,
Iterable<FileObject>
* </p>
*
* @param selector The selector to use to select which files to delete.
- * @return the number of deleted objects
+ * @return The number of deleted objects
* @throws FileSystemException If this file or one of its descendants is
read-only, or on error deleting this file
* or one of its descendants.
*/
@@ -201,7 +201,7 @@ public interface FileObject extends Comparable<FileObject>,
Iterable<FileObject>
/**
* Deletes this file and all children.
*
- * @return the number of deleted files.
+ * @return The number of deleted files.
* @throws FileSystemException if an error occurs.
* @see #delete(FileSelector)
* @see Selectors#SELECT_ALL
@@ -289,7 +289,7 @@ public interface FileObject extends Comparable<FileObject>,
Iterable<FileObject>
/**
* Gets the name of this file.
*
- * @return the FileName, not {@code null}.
+ * @return The FileName, not {@code null}.
*/
FileName getName();
@@ -304,7 +304,7 @@ public interface FileObject extends Comparable<FileObject>,
Iterable<FileObject>
/**
* Gets a Path representing this file.
*
- * @return the Path for the file.
+ * @return The Path for the file.
* @since 2.7.0
*/
default Path getPath() {
@@ -329,7 +329,7 @@ public interface FileObject extends Comparable<FileObject>,
Iterable<FileObject>
/**
* Gets a URI representing this file.
*
- * @return the URI for the file, not {@code null}.
+ * @return The URI for the file, not {@code null}.
* @since 2.7.0
*/
default URI getURI() {
@@ -339,7 +339,7 @@ public interface FileObject extends Comparable<FileObject>,
Iterable<FileObject>
/**
* Gets a URL representing this file.
*
- * @return the URL for the file.
+ * @return The URL for the file.
* @throws FileSystemException if an error occurs.
*/
URL getURL() throws FileSystemException;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystem.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystem.java
index d807ba3a5..7963a8c9d 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystem.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystem.java
@@ -80,7 +80,7 @@ public interface FileSystem {
* typically don't know the value of the underlying real file system.
* </p>
*
- * @return the accuracy of the last modification time in milliseconds. A
value of 0 means perfectly accurate,
+ * @return The accuracy of the last modification time in milliseconds. A
value of 0 means perfectly accurate,
* anything {@literal > 0} might be off by this value. For
example, sftp has an accuracy of 1000
* milliseconds.
*/
@@ -105,7 +105,7 @@ public interface FileSystem {
/**
* Returns the name of the root file of this file system. The root name
always contains a path String of "/".
*
- * @return the root FileName.
+ * @return The root FileName.
*/
FileName getRootName();
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemConfigBuilder.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemConfigBuilder.java
index 3b0224fa6..ff81c05a9 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemConfigBuilder.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemConfigBuilder.java
@@ -62,7 +62,7 @@ public abstract class FileSystemConfigBuilder {
*
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
- * @return the option in {@code opts} or system properties, otherwise null.
+ * @return The option in {@code opts} or system properties, otherwise null.
* @see #getBoolean(FileSystemOptions, String, Boolean)
* @since 2.0
*/
@@ -76,7 +76,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @see #getBoolean(FileSystemOptions, String, Boolean)
* @since 2.0
*/
@@ -91,7 +91,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @see #getBoolean(FileSystemOptions, String, Boolean)
* @since 2.0
*/
@@ -105,7 +105,7 @@ public abstract class FileSystemConfigBuilder {
*
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
- * @return the option in {@code opts} or system properties, otherwise null.
+ * @return The option in {@code opts} or system properties, otherwise null.
* @see #getByte(FileSystemOptions, String, Byte)
* @since 2.0
*/
@@ -119,7 +119,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @see #getByte(FileSystemOptions, String, Byte)
* @since 2.0
*/
@@ -133,7 +133,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @since 2.0
*/
protected Byte getByte(final FileSystemOptions fileSystemOptions, final
String name, final Byte defaultValue) {
@@ -145,7 +145,7 @@ public abstract class FileSystemConfigBuilder {
*
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
- * @return the option in {@code opts} or system properties, otherwise null.
+ * @return The option in {@code opts} or system properties, otherwise null.
* @see #getCharacter(FileSystemOptions, String, Character)
* @since 2.0
*/
@@ -159,7 +159,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @see #getCharacter(FileSystemOptions, String, Character)
* @since 2.0
*/
@@ -173,7 +173,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @since 2.0
*/
protected Character getCharacter(final FileSystemOptions
fileSystemOptions, final String name,
@@ -194,7 +194,7 @@ public abstract class FileSystemConfigBuilder {
*
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
- * @return the option in {@code opts} or system properties, otherwise null.
+ * @return The option in {@code opts} or system properties, otherwise null.
* @see #getCharset(FileSystemOptions, String, Charset)
* @since 2.11.0
*/
@@ -208,7 +208,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @since 2.11.0
*/
protected Charset getCharset(final FileSystemOptions fileSystemOptions,
final String name, final Charset defaultValue) {
@@ -218,7 +218,7 @@ public abstract class FileSystemConfigBuilder {
/**
* Gets the target of this configuration.
*
- * @return the specific file system class.
+ * @return The specific file system class.
* @since 1.0
*/
protected abstract Class<? extends FileSystem> getConfigClass();
@@ -228,7 +228,7 @@ public abstract class FileSystemConfigBuilder {
*
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
- * @return the option in {@code opts} or system properties, otherwise null.
+ * @return The option in {@code opts} or system properties, otherwise null.
* @see #getDouble(FileSystemOptions, String, Double)
* @since 2.0
*/
@@ -242,7 +242,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @see #getDouble(FileSystemOptions, String, Double)
* @since 2.0
*/
@@ -257,7 +257,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @since 2.0
*/
protected Double getDouble(final FileSystemOptions fileSystemOptions,
final String name,
@@ -270,7 +270,7 @@ public abstract class FileSystemConfigBuilder {
*
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
- * @return the option in {@code opts} or system properties, otherwise null.
+ * @return The option in {@code opts} or system properties, otherwise null.
* @see #getLong(FileSystemOptions, String, Long)
* @since 2.8.0
*/
@@ -284,7 +284,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @since 2.8.0
*/
protected Duration getDuration(final FileSystemOptions fileSystemOptions,
final String name,
@@ -297,7 +297,7 @@ public abstract class FileSystemConfigBuilder {
*
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
- * @return the option in {@code opts} or system properties, otherwise null.
+ * @return The option in {@code opts} or system properties, otherwise null.
* @see #getLong(FileSystemOptions, String, Long)
* @since 2.8.0
*/
@@ -311,7 +311,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @since 2.8.0
*/
protected Integer getDurationInteger(final FileSystemOptions
fileSystemOptions, final String name,
@@ -326,7 +326,7 @@ public abstract class FileSystemConfigBuilder {
* @param enumClass class of enumeration type.
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
- * @return the option in {@code opts} or system properties, otherwise null.
+ * @return The option in {@code opts} or system properties, otherwise null.
* @see #getEnum(Class, FileSystemOptions, String, Enum)
* @throws IllegalArgumentException if option value is not a known
enumeration.
* @since 2.1
@@ -344,7 +344,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @see #getEnum(Class, FileSystemOptions, String, Enum)
* @throws IllegalArgumentException if option value is not a known
enumeration.
* @since 2.1
@@ -367,7 +367,7 @@ public abstract class FileSystemConfigBuilder {
*
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
- * @return the option in {@code opts} or system properties, otherwise null.
+ * @return The option in {@code opts} or system properties, otherwise null.
* @see #getFloat(FileSystemOptions, String, Float)
* @throws NumberFormatException if option value is not a valid float.
* @since 2.0
@@ -382,7 +382,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @see #getFloat(FileSystemOptions, String, Float)
* @throws NumberFormatException if option value is not a valid float.
* @since 2.0
@@ -397,7 +397,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @throws NumberFormatException if option value is not a valid float.
* @since 2.0
*/
@@ -410,7 +410,7 @@ public abstract class FileSystemConfigBuilder {
*
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
- * @return the option in {@code opts} or system properties, otherwise null.
+ * @return The option in {@code opts} or system properties, otherwise null.
* @see #getInteger(FileSystemOptions, String, Integer)
* @throws NumberFormatException if option value is not a valid integer.
* @since 2.0
@@ -425,7 +425,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @see #getInteger(FileSystemOptions, String, Integer)
* @throws NumberFormatException if option value is not a valid integer.
* @since 2.0
@@ -440,7 +440,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @throws NumberFormatException if option value is not a valid integer.
* @since 2.0
*/
@@ -454,7 +454,7 @@ public abstract class FileSystemConfigBuilder {
*
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
- * @return the option in {@code opts} or system properties, otherwise null.
+ * @return The option in {@code opts} or system properties, otherwise null.
* @see #getLong(FileSystemOptions, String, Long)
* @throws NumberFormatException if option value is not a valid long.
* @since 2.0
@@ -469,7 +469,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @see #getLong(FileSystemOptions, String, Long)
* @throws NumberFormatException if option value is not a valid long.
* @since 2.0
@@ -484,7 +484,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @throws NumberFormatException if option value is not a valid long.
* @since 2.0
*/
@@ -498,7 +498,7 @@ public abstract class FileSystemConfigBuilder {
* @param <T> The expected return type.
* @param fileSystemOptions file system options to query, may be null.
* @param name get option with this name.
- * @return the named option or null.
+ * @return The named option or null.
* @since 1.0
*/
protected <T> T getParam(final FileSystemOptions fileSystemOptions, final
String name) {
@@ -514,7 +514,7 @@ public abstract class FileSystemConfigBuilder {
* @param defaultValue value to use if the system property value is null.
* @param function Builds an instance of T from a system property String
value.
* @param returnType The return type.
- * @return the named option or null.
+ * @return The named option or null.
* @since 2.8.0
*/
private <T> T getParam(final FileSystemOptions fileSystemOptions, final
String name, final T defaultValue, final Function<String, T> function,
@@ -537,7 +537,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name get option with this name.
* @param defaultValue The default value if absent.
- * @return the named option or {@code defaultValue}.
+ * @return The named option or {@code defaultValue}.
* @since 2.10.0
*/
protected <T> T getParamOrDefault(final FileSystemOptions
fileSystemOptions, final String name, final T defaultValue) {
@@ -571,7 +571,7 @@ public abstract class FileSystemConfigBuilder {
*
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
- * @return the option in {@code opts} or system properties, otherwise null
+ * @return The option in {@code opts} or system properties, otherwise null
* @see #getShort(FileSystemOptions, String, Short)
* @throws NumberFormatException if option value is not a valid short.
* @since 2.0
@@ -586,7 +586,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @see #getShort(FileSystemOptions, String, Short)
* @throws NumberFormatException if option value is not a valid short.
* @since 2.0
@@ -601,7 +601,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @throws NumberFormatException if option value is not a valid short.
* @since 2.0
*/
@@ -614,7 +614,7 @@ public abstract class FileSystemConfigBuilder {
*
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
- * @return the option in {@code opts} or system properties, otherwise null.
+ * @return The option in {@code opts} or system properties, otherwise null.
* @see #getString(FileSystemOptions, String, String)
* @since 2.0
*/
@@ -628,7 +628,7 @@ public abstract class FileSystemConfigBuilder {
* @param fileSystemOptions file system options to query, may be null.
* @param name the option name.
* @param defaultValue value to return if option is not present.
- * @return the option in {@code opts} or system properties, otherwise
{@code defaultValue}.
+ * @return The option in {@code opts} or system properties, otherwise
{@code defaultValue}.
* @since 2.0
*/
protected String getString(final FileSystemOptions fileSystemOptions,
final String name,
@@ -699,7 +699,7 @@ public abstract class FileSystemConfigBuilder {
* Converts the given primitive boolean to a Boolean object.
*
* @param value a primitive boolean.
- * @return the given primitive boolean as Boolean object.
+ * @return The given primitive boolean as Boolean object.
* @since 2.7.0
*/
protected Boolean toBooleanObject(final boolean value) {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemException.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemException.java
index 1d33c00f3..fb21d4e56 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemException.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemException.java
@@ -191,7 +191,7 @@ public class FileSystemException extends IOException {
/**
* Gets error code of the exception. Could be used as key for
internationalization.
*
- * @return the code.
+ * @return The code.
*/
public String getCode() {
return super.getMessage();
@@ -200,7 +200,7 @@ public class FileSystemException extends IOException {
/**
* Gets array of complementary info (context). Could be used as parameter
for internationalization.
*
- * @return the context info.
+ * @return The context info.
*/
public String[] getInfo() {
return info;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemManager.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemManager.java
index bc6feba57..e82f9234c 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemManager.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemManager.java
@@ -156,28 +156,28 @@ public interface FileSystemManager extends AutoCloseable {
/**
* Gets the cache strategy used.
*
- * @return the CacheStrategy.
+ * @return The CacheStrategy.
*/
CacheStrategy getCacheStrategy();
/**
* Gets the class to use to determine the content-type (mime-type).
*
- * @return the FileContentInfoFactory.
+ * @return The FileContentInfoFactory.
*/
FileContentInfoFactory getFileContentInfoFactory();
/**
* Gets the file object decorator used.
*
- * @return the file object decorator Class.
+ * @return The file object decorator Class.
*/
Class<?> getFileObjectDecorator();
/**
* Gets the constructor associated to the fileObjectDecorator. We cache it
here for performance reasons.
*
- * @return the Constructor associated with the FileObjectDecorator.
+ * @return The Constructor associated with the FileObjectDecorator.
*/
Constructor<?> getFileObjectDecoratorConst();
@@ -201,7 +201,7 @@ public interface FileSystemManager extends AutoCloseable {
* Gets Providers for file operations.
*
* @param scheme the scheme for which we want to get the list af
registered providers.
- * @return the registered FileOperationProviders for the specified scheme.
If there were no providers registered for
+ * @return The registered FileOperationProviders for the specified scheme.
If there were no providers registered for
* the scheme, it returns null.
*
* @throws FileSystemException if an error occurs.
@@ -227,7 +227,7 @@ public interface FileSystemManager extends AutoCloseable {
/**
* Returns a stream handler factory to enable URL lookup using this
FileSystemManager.
*
- * @return the URLStreamHandlerFactory.
+ * @return The URLStreamHandlerFactory.
*/
URLStreamHandlerFactory getURLStreamHandlerFactory();
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FilesCache.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FilesCache.java
index ded545889..6bff2fb39 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FilesCache.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FilesCache.java
@@ -38,7 +38,7 @@ public interface FilesCache {
*
* @param fileSystem The FileSystem.
* @param fileName the name
- * @return the file object or null if file is not cached
+ * @return The file object or null if file is not cached
*/
FileObject getFile(FileSystem fileSystem, FileName fileName);
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java
index 8ad1d8353..6bd43b2f9 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java
@@ -44,7 +44,7 @@ public interface RandomAccessContent extends DataOutput,
DataInput, Closeable {
/**
* Returns the current offset in this file.
*
- * @return the offset from the beginning of the file, in bytes, at which
the next read or write occurs.
+ * @return The offset from the beginning of the file, in bytes, at which
the next read or write occurs.
* @throws IOException if an I/O error occurs.
*/
long getFilePointer() throws IOException;
@@ -55,7 +55,7 @@ public interface RandomAccessContent extends DataOutput,
DataInput, Closeable {
* <strong>Notice: If you use {@link #seek(long)} you have to re-get the
InputStream</strong>
* </p>
*
- * @return the InputStream.
+ * @return The InputStream.
* @throws IOException if an I/O error occurs.
*/
InputStream getInputStream() throws IOException;
@@ -63,7 +63,7 @@ public interface RandomAccessContent extends DataOutput,
DataInput, Closeable {
/**
* Returns the length of this file.
*
- * @return the length of this file, measured in bytes.
+ * @return The length of this file, measured in bytes.
* @throws IOException if an I/O error occurs.
*/
long length() throws IOException;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/VFS.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/VFS.java
index 1171a96f2..b3373fc42 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/VFS.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/VFS.java
@@ -108,7 +108,7 @@ public final class VFS {
/**
* Resets the FileSystemManager to the default.
*
- * @return the new FileSystemManager.
+ * @return The new FileSystemManager.
* @throws FileSystemException if an error occurs creating the manager.
* @since 2.5.0
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/ConditionalFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/ConditionalFileFilter.java
index f23d90278..620140d23 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/ConditionalFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/ConditionalFileFilter.java
@@ -40,7 +40,7 @@ public interface ConditionalFileFilter {
/**
* Gets this conditional file filter's list of file filters.
*
- * @return the file filter list
+ * @return The file filter list
*/
List<FileFilter> getFileFilters();
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/IOCase.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/IOCase.java
index 057b8c97c..02af9bbce 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/IOCase.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/IOCase.java
@@ -72,7 +72,7 @@ public enum IOCase {
* Factory method to create an IOCase from a name.
*
* @param name the name to find
- * @return the IOCase object
+ * @return The IOCase object
* @throws IllegalArgumentException if the name is invalid
*/
public static IOCase forName(final String name) {
@@ -161,7 +161,7 @@ public enum IOCase {
* @param str the string to check, not null
* @param strStartIndex the index to start at in str
* @param search the start to search for, not null
- * @return the first index of the search String, -1 if no match or {@code
null}
+ * @return The first index of the search String, -1 if no match or {@code
null}
* string input
* @throws NullPointerException if either string is null
* @since 2.0
@@ -214,7 +214,7 @@ public enum IOCase {
/**
* Gets the name of the constant.
*
- * @return the name of the constant
+ * @return The name of the constant
*/
public String getName() {
return name;
@@ -233,7 +233,7 @@ public enum IOCase {
* Replaces the enumeration from the stream with a real one. This ensures
that
* the correct flag is set for SYSTEM.
*
- * @return the resolved object
+ * @return The resolved object
*/
private Object readResolve() {
return forName(name);
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/WildcardFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/WildcardFileFilter.java
index 3bef87338..8ade9f885 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/WildcardFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/WildcardFileFilter.java
@@ -66,7 +66,7 @@ public class WildcardFileFilter implements FileFilter,
Serializable {
* Where multiple '*' occur consecutively they are collapsed into a single
'*'.
*
* @param text the text to split
- * @return the array of tokens, never null
+ * @return The array of tokens, never null
*/
// CHECKSTYLE:OFF Cyclomatic complexity of 12 is OK here
static String[] splitOnTokens(final String text) {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DecoratedFileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DecoratedFileObject.java
index 615446a86..80e3827dc 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DecoratedFileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DecoratedFileObject.java
@@ -125,7 +125,7 @@ public class DecoratedFileObject implements FileObject {
/**
* Gets the decorated fileObject.
*
- * @return the decorated fileObject.
+ * @return The decorated fileObject.
*/
public FileObject getDecoratedFileObject() {
return fileObject;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileReplicator.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileReplicator.java
index a14473513..9eabc07b6 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileReplicator.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileReplicator.java
@@ -147,7 +147,7 @@ public class DefaultFileReplicator extends
AbstractVfsComponent implements FileR
* Create the temporary file name.
*
* @param baseName The base to prepend to the file name being created.
- * @return the name of the File.
+ * @return The name of the File.
*/
protected String createFilename(final String baseName) {
// BUG29007
@@ -177,7 +177,7 @@ public class DefaultFileReplicator extends
AbstractVfsComponent implements FileR
/**
* Gets the file count.
*
- * @return the file count.
+ * @return The file count.
*/
protected long getFilecount() {
return fileCount;
@@ -209,7 +209,7 @@ public class DefaultFileReplicator extends
AbstractVfsComponent implements FileR
* <p>
* Notice: The system awaits that the returning object can be cast to a
{@link File}.
*
- * @return the File that was removed.
+ * @return The File that was removed.
*/
protected Object removeFile() {
synchronized (copies) {
@@ -233,7 +233,7 @@ public class DefaultFileReplicator extends
AbstractVfsComponent implements FileR
*
* @param srcFile The file to copy.
* @param selector The FileSelector.
- * @return the created File.
+ * @return The created File.
* @throws FileSystemException if an error occurs copying the file.
*/
@Override
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemConfigBuilder.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemConfigBuilder.java
index ac275abad..386c99ed5 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemConfigBuilder.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemConfigBuilder.java
@@ -38,7 +38,7 @@ public class DefaultFileSystemConfigBuilder extends
FileSystemConfigBuilder {
/**
* Gets the singleton builder.
*
- * @return the singleton builder.
+ * @return The singleton builder.
*/
public static DefaultFileSystemConfigBuilder getInstance() {
return BUILDER;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java
index a18e04834..c7427e3fe 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java
@@ -596,7 +596,7 @@ public class DefaultFileSystemManager implements
FileSystemManager {
/**
* Gets the logger used by this manager.
*
- * @return the Logger.
+ * @return The Logger.
*/
protected Log getLogger() {
return log;
@@ -604,7 +604,7 @@ public class DefaultFileSystemManager implements
FileSystemManager {
/**
* @param scheme the scheme for which we want to get the list af
registered providers.
- * @return the registered FileOperationProviders for the specified scheme.
If there were no providers registered for
+ * @return The registered FileOperationProviders for the specified scheme.
If there were no providers registered for
* the scheme, it returns null.
*
* @throws FileSystemException if an error occurs.
@@ -1190,7 +1190,7 @@ public class DefaultFileSystemManager implements
FileSystemManager {
* Converts a local file into a {@link FileObject}.
*
* @param file The input File.
- * @return the created FileObject
+ * @return The created FileObject
* @throws FileSystemException if an error occurs creating the file.
*/
@Override
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultVfsComponentContext.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultVfsComponentContext.java
index b35259438..fbe068f7d 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultVfsComponentContext.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultVfsComponentContext.java
@@ -40,7 +40,7 @@ final class DefaultVfsComponentContext implements
VfsComponentContext {
/**
* Returns the file system manager for the current context
*
- * @return the file system manager
+ * @return The file system manager
*/
@Override
public FileSystemManager getFileSystemManager() {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/ProviderConfiguration.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/ProviderConfiguration.java
index 8b2388e07..ca46996bf 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/ProviderConfiguration.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/ProviderConfiguration.java
@@ -40,7 +40,7 @@ public class ProviderConfiguration {
/**
* Gets the class name.
*
- * @return the class name.
+ * @return The class name.
*/
public String getClassName() {
return className;
@@ -49,7 +49,7 @@ public class ProviderConfiguration {
/**
* Gets the dependency.
*
- * @return the dependency.
+ * @return The dependency.
*/
public List<String> getDependencies() {
return dependencies;
@@ -58,7 +58,7 @@ public class ProviderConfiguration {
/**
* Gets the schema.
*
- * @return the scheme.
+ * @return The scheme.
*/
public List<String> getSchemes() {
return schemes;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/VirtualFileSystem.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/VirtualFileSystem.java
index 57fe8d44a..12fe5fb54 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/VirtualFileSystem.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/VirtualFileSystem.java
@@ -153,7 +153,7 @@ public class VirtualFileSystem extends AbstractFileSystem {
* Locates the junction point for the junction containing the given file.
*
* @param name The FileName.
- * @return the FileName where the junction occurs.
+ * @return The FileName where the junction occurs.
*/
private FileName getJunctionForFile(final FileName name) {
if (junctions.containsKey(name)) {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperation.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperation.java
index 62e4b1bb1..54fde1813 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperation.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperation.java
@@ -42,7 +42,7 @@ public abstract class AbstractFileOperation implements
FileOperation {
/**
* Gets the instance of FileObject for this FileOperation.
*
- * @return the instance of FileObject for this FileOperation.
+ * @return The instance of FileObject for this FileOperation.
*/
protected FileObject getFileObject() {
return fileObject;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperationProvider.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperationProvider.java
index 0513597bc..01a2e0d41 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperationProvider.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperationProvider.java
@@ -88,7 +88,7 @@ public abstract class AbstractFileOperationProvider
implements FileOperationProv
/**
* @param file the FileObject for which we need an operation.
* @param operationClass the Class which instance we are needed.
- * @return the required operation instance.
+ * @return The required operation instance.
* @throws FileSystemException if operation cannot be retrieved.
*/
@Override
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperationProvider.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperationProvider.java
index f0d6cf62e..4c0fdac12 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperationProvider.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperationProvider.java
@@ -50,7 +50,7 @@ public interface FileOperationProvider {
*
* @param file the FileObject for which we need an operation.
* @param operationClass the Class which instance we are needed.
- * @return the required operation instance.
+ * @return The required operation instance.
* @throws FileSystemException if operation cannot be retrieved.
*/
FileOperation getOperation(FileObject file, Class<? extends FileOperation>
operationClass) throws FileSystemException;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsStatus.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsStatus.java
index e3b4ba879..ded1c0a42 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsStatus.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsStatus.java
@@ -137,7 +137,7 @@ public enum VcsStatus {
/**
* Gets the status.
*
- * @return the status of FileObject
+ * @return The status of FileObject
*/
public int getStatus() {
return status;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileName.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileName.java
index dec58c261..79ce83d10 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileName.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileName.java
@@ -235,7 +235,7 @@ public abstract class AbstractFileName implements FileName {
/**
* Gets the URI without a password.
*
- * @return the URI without a password.
+ * @return The URI without a password.
*/
@Override
public String getFriendlyURI() {
@@ -257,7 +257,7 @@ public abstract class AbstractFileName implements FileName {
/**
* Gets the name of the parent of the file.
*
- * @return the FileName of the parent.
+ * @return The FileName of the parent.
*/
@Override
public FileName getParent() {
@@ -436,7 +436,7 @@ public abstract class AbstractFileName implements FileName {
/**
* Gets the string to end a URI.
*
- * @return the string to end a URI
+ * @return The string to end a URI
*/
protected String getUriTrailer() {
return getType().hasChildren() ? "/" : "";
@@ -533,7 +533,7 @@ public abstract class AbstractFileName implements FileName {
/**
* Returns the URI of the file.
*
- * @return the FileName as a URI.
+ * @return The FileName as a URI.
*/
@Override
public String toString() {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java
index c4f7f4f3c..d4f32327c 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java
@@ -392,7 +392,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* Deletes this file, and all children matching the {@code selector}.
*
* @param selector The FileSelector.
- * @return the number of deleted files.
+ * @return The number of deleted files.
* @throws FileSystemException if an error occurs.
*/
@Override
@@ -429,7 +429,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
/**
* Deletes this file and all children. Shorthand for {@code
delete(Selectors.SELECT_ALL)}
*
- * @return the number of deleted files.
+ * @return The number of deleted files.
* @throws FileSystemException if an error occurs.
* @see #delete(FileSelector)
* @see Selectors#SELECT_ALL
@@ -693,7 +693,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* Determines the type of this file. Must not return null. The return
value of this method is cached, so the
* implementation can be expensive.
*
- * @return the type of the file.
+ * @return The type of the file.
* @throws Exception if an error occurs.
*/
protected abstract FileType doGetType() throws Exception;
@@ -1127,7 +1127,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
/**
* Returns the file's content.
*
- * @return the FileContent for this FileObject.
+ * @return The FileContent for this FileObject.
* @throws FileSystemException if an error occurs.
*/
@Override
@@ -1284,7 +1284,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
/**
* Returns the parent of the file.
*
- * @return the parent FileObject.
+ * @return The parent FileObject.
* @throws FileSystemException if an error occurs.
*/
@Override
@@ -1905,7 +1905,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
/**
* Returns the URI as a String.
*
- * @return the URI as a String.
+ * @return The URI as a String.
*/
@Override
public String toString() {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileProvider.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileProvider.java
index 78bf7266d..f54b4f3a3 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileProvider.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileProvider.java
@@ -149,7 +149,7 @@ public abstract class AbstractFileProvider extends
AbstractVfsContainer implemen
/**
* Gets the FileSystemConfigBuilder.
*
- * @return the FileSystemConfigBuilder.
+ * @return The FileSystemConfigBuilder.
*/
@Override
public FileSystemConfigBuilder getConfigBuilder() {
@@ -159,7 +159,7 @@ public abstract class AbstractFileProvider extends
AbstractVfsContainer implemen
/**
* Gets the file name parser.
*
- * @return the file name parser.
+ * @return The file name parser.
*/
protected FileNameParser getFileNameParser() {
return fileNameParser;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileSystem.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileSystem.java
index 4f3602bb0..8592ff3b3 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileSystem.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileSystem.java
@@ -189,7 +189,7 @@ public abstract class AbstractFileSystem extends
AbstractVfsComponent implements
* Decorates the given file object.
*
* @param file the file object.
- * @return the decorated file object.
+ * @return The decorated file object.
* @throws FileSystemException if a file system error occurs.
*/
protected FileObject decorateFileObject(FileObject file) throws
FileSystemException {
@@ -301,7 +301,7 @@ public abstract class AbstractFileSystem extends
AbstractVfsComponent implements
* Gets the attribute with the specified name. The default implementation
simply throws an exception.
*
* @param attrName The name of the attribute.
- * @return the Object associated with the attribute or null if no object
is.
+ * @return The Object associated with the attribute or null if no object
is.
* @throws FileSystemException if an error occurs.
*/
@Override
@@ -331,7 +331,7 @@ public abstract class AbstractFileSystem extends
AbstractVfsComponent implements
/**
* Gets the FileSystemManager used to instantiate this file system.
*
- * @return the FileSystemManager.
+ * @return The FileSystemManager.
*/
@Override
public FileSystemManager getFileSystemManager() {
@@ -341,7 +341,7 @@ public abstract class AbstractFileSystem extends
AbstractVfsComponent implements
/**
* Gets the FileSystemOptions used to instantiate this file system.
*
- * @return the FileSystemOptions.
+ * @return The FileSystemOptions.
*/
@Override
public FileSystemOptions getFileSystemOptions() {
@@ -383,7 +383,7 @@ public abstract class AbstractFileSystem extends
AbstractVfsComponent implements
/**
* Gets the name of the root of this file system.
*
- * @return the root FileName.
+ * @return The root FileName.
*/
@Override
public FileName getRootName() {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DefaultFileContent.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DefaultFileContent.java
index cc17a3a5c..6cbc6c79b 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DefaultFileContent.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DefaultFileContent.java
@@ -506,7 +506,7 @@ public final class DefaultFileContent implements
FileContent {
/**
* Returns the file that this is the content of.
*
- * @return the FileObject.
+ * @return The FileObject.
*/
@Override
public FileObject getFile() {
@@ -813,7 +813,7 @@ public final class DefaultFileContent implements
FileContent {
* Writes this content to another FileContent.
*
* @param fileContent The target FileContent.
- * @return the total number of bytes written
+ * @return The total number of bytes written
* @throws IOException if an error occurs writing the content.
* @since 2.1
*/
@@ -828,7 +828,7 @@ public final class DefaultFileContent implements
FileContent {
* Writes this content to another FileObject.
*
* @param file The target FileObject.
- * @return the total number of bytes written
+ * @return The total number of bytes written
* @throws IOException if an error occurs writing the content.
* @since 2.1
*/
@@ -841,7 +841,7 @@ public final class DefaultFileContent implements
FileContent {
* Writes this content to an OutputStream.
*
* @param output The target OutputStream.
- * @return the total number of bytes written
+ * @return The total number of bytes written
* @throws IOException if an error occurs writing the content.
* @since 2.1
*/
@@ -855,7 +855,7 @@ public final class DefaultFileContent implements
FileContent {
*
* @param output The target OutputStream.
* @param bufferSize The buffer size to write data chunks.
- * @return the total number of bytes written.
+ * @return The total number of bytes written.
* @throws IOException if an error occurs writing the file.
* @since 2.1
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java
index e58c3ffec..ec74f9fc8 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java
@@ -140,7 +140,7 @@ public class DelegateFileObject<AFS extends
AbstractFileSystem> extends Abstract
/**
* Gets file content info.
*
- * @return the file content info of the delegee.
+ * @return The file content info of the delegee.
* @throws Exception Any thrown Exception is wrapped in
FileSystemException.
* @since 2.0
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericURLFileName.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericURLFileName.java
index 6296dee95..8e6e60f65 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericURLFileName.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericURLFileName.java
@@ -66,7 +66,7 @@ public class GenericURLFileName extends GenericFileName {
/**
* Appends query string to the uri.
*
- * @return the uri
+ * @return The uri
*/
@Override
protected String createURI() {
@@ -85,7 +85,7 @@ public class GenericURLFileName extends GenericFileName {
/**
* Gets the path and query string e.g. /path/servlet?param1=true.
*
- * @return the path and its query string
+ * @return The path and its query string
*/
public String getPathQuery() {
final StringBuilder sb = new StringBuilder(BUFFER_SIZE);
@@ -125,7 +125,7 @@ public class GenericURLFileName extends GenericFileName {
/**
* Gets the query string.
*
- * @return the query string part of the file name
+ * @return The query string part of the file name
*/
public String getQueryString() {
return queryString;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/HostFileNameParser.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/HostFileNameParser.java
index 0cdad0f90..c09400873 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/HostFileNameParser.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/HostFileNameParser.java
@@ -55,7 +55,7 @@ public class HostFileNameParser extends
AbstractFileNameParser {
/**
* Gets the host name.
*
- * @return the host name.
+ * @return The host name.
* @since 2.0
*/
public String getHostName() {
@@ -65,7 +65,7 @@ public class HostFileNameParser extends
AbstractFileNameParser {
/**
* Gets the user password.
*
- * @return the password or null.
+ * @return The password or null.
* @since 2.0
*/
public String getPassword() {
@@ -75,7 +75,7 @@ public class HostFileNameParser extends
AbstractFileNameParser {
/**
* Gets the port.
*
- * @return the port or -1.
+ * @return The port or -1.
* @since 2.0
*/
public int getPort() {
@@ -85,7 +85,7 @@ public class HostFileNameParser extends
AbstractFileNameParser {
/**
* Gets the connection schema.
*
- * @return the connection scheme.
+ * @return The connection scheme.
* @since 2.0
*/
public String getScheme() {
@@ -95,7 +95,7 @@ public class HostFileNameParser extends
AbstractFileNameParser {
/**
* Gets the user name.
*
- * @return the user name or null.
+ * @return The user name or null.
* @since 2.0
*/
public String getUserName() {
@@ -185,7 +185,7 @@ public class HostFileNameParser extends
AbstractFileNameParser {
* Extracts the hostname from a URI.
*
* @param name string buffer with the "scheme://[userinfo@]" part has been
removed already. Will be modified.
- * @return the host name or null.
+ * @return The host name or null.
*/
protected String extractHostName(final StringBuilder name) {
final int maxlen = name.length();
@@ -344,7 +344,7 @@ public class HostFileNameParser extends
AbstractFileNameParser {
* Extracts the user info from a URI.
*
* @param name string buffer with the "scheme://" part has been removed
already. Will be modified.
- * @return the user information up to the '@' or null.
+ * @return The user information up to the '@' or null.
*/
protected String extractUserInfo(final StringBuilder name) {
final int maxlen = name.length();
@@ -369,7 +369,7 @@ public class HostFileNameParser extends
AbstractFileNameParser {
/**
* Gets the default port.
*
- * @return the default port.
+ * @return The default port.
*/
public int getDefaultPort() {
return defaultPort;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/LayeredFileNameParser.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/LayeredFileNameParser.java
index ed71ba15d..439f7d20f 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/LayeredFileNameParser.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/LayeredFileNameParser.java
@@ -33,7 +33,7 @@ public class LayeredFileNameParser extends
AbstractFileNameParser {
/**
* Gets the singleton instance.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static LayeredFileNameParser getInstance() {
return INSTANCE;
@@ -61,7 +61,7 @@ public class LayeredFileNameParser extends
AbstractFileNameParser {
* Pops the root prefix off a URI, which has had the scheme removed.
*
* @param uri string builder which gets modified.
- * @return the extracted root name.
+ * @return The extracted root name.
*/
protected String extractRootName(final StringBuilder uri) {
// Looking for <name>!<abspath> (staring at the end)
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileName.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileName.java
index d01d75990..e67014ba8 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileName.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileName.java
@@ -69,7 +69,7 @@ public class URLFileName extends GenericFileName {
/**
* Appends query string to the URI.
*
- * @return the URI
+ * @return The URI
*/
@Override
protected String createURI() {
@@ -88,7 +88,7 @@ public class URLFileName extends GenericFileName {
/**
* Gets the path and query string e.g. /path/servlet?param1=true.
*
- * @return the path and its query string
+ * @return The path and its query string
*/
public String getPathQuery() {
final StringBuilder sb = new StringBuilder(BUFFER_SIZE);
@@ -129,7 +129,7 @@ public class URLFileName extends GenericFileName {
/**
* Gets the query string.
*
- * @return the query string part of the file name
+ * @return The query string part of the file name
*/
public String getQueryString() {
return queryString;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/VfsComponentContext.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/VfsComponentContext.java
index 19114b7ab..2bbcca826 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/VfsComponentContext.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/VfsComponentContext.java
@@ -35,7 +35,7 @@ public interface VfsComponentContext {
/**
* Gets the file system manager for the current context.
*
- * @return the file system manager
+ * @return The file system manager
*/
FileSystemManager getFileSystemManager();
@@ -91,7 +91,7 @@ public interface VfsComponentContext {
* Returns a {@link FileObject} for a local file.
*
* @param file The File to convert to a FileObject.
- * @return the FileObject.
+ * @return The FileObject.
* @throws FileSystemException if an error occurs.
*/
FileObject toFileObject(File file) throws FileSystemException;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/compressed/CompressedFileFileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/compressed/CompressedFileFileObject.java
index 37cb640c8..478bb47da 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/compressed/CompressedFileFileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/compressed/CompressedFileFileObject.java
@@ -108,7 +108,7 @@ public abstract class CompressedFileFileObject<FS extends
CompressedFileFileSyst
/**
* Gets the container.
*
- * @return the container.
+ * @return The container.
*/
protected FileObject getContainer() {
return container;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FTPClientWrapper.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FTPClientWrapper.java
index 6ae56b31a..63644cb86 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FTPClientWrapper.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FTPClientWrapper.java
@@ -173,7 +173,7 @@ public class FTPClientWrapper implements FtpClient {
/**
* Gets the FileSystemOptions.
*
- * @return the FileSystemOptions.
+ * @return The FileSystemOptions.
*/
public FileSystemOptions getFileSystemOptions() {
return fileSystemOptions;
@@ -182,7 +182,7 @@ public class FTPClientWrapper implements FtpClient {
/**
* Package-private for debugging only, consider private.
*
- * @return the actual FTP client.
+ * @return The actual FTP client.
* @throws FileSystemException if an error occurs while establishing a
connection.
*/
FTPClient getFtpClient() throws FileSystemException {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileNameParser.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileNameParser.java
index 5f940b452..e20813d92 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileNameParser.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileNameParser.java
@@ -31,7 +31,7 @@ public class FtpFileNameParser extends HostFileNameParser {
/**
* Gets the singleton instance.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static FileNameParser getInstance() {
return INSTANCE;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystemConfigBuilder.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystemConfigBuilder.java
index 093162aa9..97ac28c9f 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystemConfigBuilder.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystemConfigBuilder.java
@@ -65,7 +65,7 @@ public class FtpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
/**
* Gets the singleton instance.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static FtpFileSystemConfigBuilder getInstance() {
return BUILDER;
@@ -101,7 +101,7 @@ public class FtpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
* Gets the active port range.
*
* @param options The FileSystemOptions.
- * @return the Range of active ports
+ * @return The Range of active ports
* @since 2.10.0
*/
public Range<Integer> getActivePortRange(final FileSystemOptions options) {
@@ -235,7 +235,7 @@ public class FtpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
*
* @param options The FileSystemOptions.
* @see #setEntryParser
- * @return the key to the EntryParser.
+ * @return The key to the EntryParser.
*/
public String getEntryParser(final FileSystemOptions options) {
return getString(options, FACTORY_KEY);
@@ -289,7 +289,7 @@ public class FtpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
* Gets the Proxy.
*
* @param options The FileSystemOptions.
- * @return the Proxy
+ * @return The Proxy
* @since 2.1
*/
public Proxy getProxy(final FileSystemOptions options) {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileSystemConfigBuilder.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileSystemConfigBuilder.java
index 4bacff89a..f41817e2a 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileSystemConfigBuilder.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileSystemConfigBuilder.java
@@ -42,7 +42,7 @@ public final class FtpsFileSystemConfigBuilder extends
FtpFileSystemConfigBuilde
/**
* Gets the singleton builder.
*
- * @return the singleton builder.
+ * @return The singleton builder.
*/
public static FtpsFileSystemConfigBuilder getInstance() {
return BUILDER;
@@ -92,7 +92,7 @@ public final class FtpsFileSystemConfigBuilder extends
FtpFileSystemConfigBuilde
* Gets the KeyManager used to provide a client-side certificate if the
FTPS server requests it.
*
* @param opts The FileSystemOptions.
- * @return the key manager instance or {@code null}
+ * @return The key manager instance or {@code null}
* @see org.apache.commons.net.ftp.FTPSClient#setKeyManager(KeyManager)
* @since 2.1
*/
@@ -108,7 +108,7 @@ public final class FtpsFileSystemConfigBuilder extends
FtpFileSystemConfigBuilde
* </p>
*
* @param opts The FileSystemOptions.
- * @return the trust manager instance or {@code null}
+ * @return The trust manager instance or {@code null}
* @see org.apache.commons.net.ftp.FTPSClient#setTrustManager(TrustManager)
* @since 2.1
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileNameParser.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileNameParser.java
index 4f3888b5c..88875c629 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileNameParser.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileNameParser.java
@@ -34,7 +34,7 @@ public class HttpFileNameParser extends URLFileNameParser {
/**
* Gets the singleton instance.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static FileNameParser getInstance() {
return INSTANCE;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileObject.java
index 2a64b7b93..e21504fae 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileObject.java
@@ -211,7 +211,7 @@ public class HttpFileObject<FS extends HttpFileSystem>
extends AbstractFileObjec
* Encodes the given path.
*
* @param unescaped An unescaped path.
- * @return the encoded path.
+ * @return The encoded path.
* @throws URIException if the default protocol charset is not supported
*/
protected String encodePath(final String unescaped) throws URIException {
@@ -264,7 +264,7 @@ public class HttpFileObject<FS extends HttpFileSystem>
extends AbstractFileObjec
/**
* Gets the URL charset name.
*
- * @return the URL charset name.
+ * @return The URL charset name.
*/
protected String getUrlCharset() {
return urlCharset;
@@ -273,7 +273,7 @@ public class HttpFileObject<FS extends HttpFileSystem>
extends AbstractFileObjec
/**
* Gets the user agent.
*
- * @return the user agent.
+ * @return The user agent.
*/
protected String getUserAgent() {
return userAgent;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystem.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystem.java
index 2714b495f..b8d9bb5bb 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystem.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystem.java
@@ -81,7 +81,7 @@ public class HttpFileSystem extends AbstractFileSystem {
/**
* Gets the HTTP client.
*
- * @return the HttpClient.
+ * @return The HttpClient.
*/
protected HttpClient getClient() {
return httpClient;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystemConfigBuilder.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystemConfigBuilder.java
index b9bbdeca2..b925d8af6 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystemConfigBuilder.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystemConfigBuilder.java
@@ -63,7 +63,7 @@ public class HttpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
/**
* Gets the singleton builder.
*
- * @return the singleton builder.
+ * @return The singleton builder.
*/
public static HttpFileSystemConfigBuilder getInstance() {
return BUILDER;
@@ -116,7 +116,7 @@ public class HttpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
* Gets the cookies to add to the request.
*
* @param opts The FileSystem options.
- * @return the Cookie array.
+ * @return The Cookie array.
*/
public Cookie[] getCookies(final FileSystemOptions opts) {
return getParam(opts, "cookies");
@@ -218,7 +218,7 @@ public class HttpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
* Gets the charset used for url encoding.
*
* @param opts The FileSystem options.
- * @return the charset name.
+ * @return The charset name.
*/
public String getUrlCharset(final FileSystemOptions opts) {
return getString(opts, "urlCharset");
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileNameParser.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileNameParser.java
index 106953f75..ee092f53f 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileNameParser.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileNameParser.java
@@ -35,7 +35,7 @@ public class Http4FileNameParser extends
GenericURLFileNameParser {
/**
* Gets the singleton instance.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static FileNameParser getInstance() {
return INSTANCE;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileObject.java
index ebe45b83d..5ead51f04 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileObject.java
@@ -188,7 +188,7 @@ public class Http4FileObject<FS extends Http4FileSystem>
extends AbstractFileObj
/**
* Gets the internal {@code URI} object mapped to this file object.
*
- * @return the internal {@code URI} object mapped to this file object.
+ * @return The internal {@code URI} object mapped to this file object.
*/
protected URI getInternalURI() {
return internalURI;
@@ -197,7 +197,7 @@ public class Http4FileObject<FS extends Http4FileSystem>
extends AbstractFileObj
/**
* Gets the last executed HEAD {@code HttpResponse} object.
*
- * @return the last executed HEAD {@code HttpResponse} object.
+ * @return The last executed HEAD {@code HttpResponse} object.
* @throws IOException in case of a problem or the connection was aborted.
* @throws ClientProtocolException in case of an HTTP protocol error.
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileSystem.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileSystem.java
index 4aa37e385..df4d5c486 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileSystem.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileSystem.java
@@ -97,7 +97,7 @@ public class Http4FileSystem extends AbstractFileSystem {
/**
* Gets the internal {@link HttpClient} instance.
*
- * @return the internal {@link HttpClient} instance
+ * @return The internal {@link HttpClient} instance
*/
protected HttpClient getHttpClient() {
return httpClient;
@@ -106,7 +106,7 @@ public class Http4FileSystem extends AbstractFileSystem {
/**
* Gets the internal {@link HttpClientContext} instance.
*
- * @return the internal {@link HttpClientContext} instance
+ * @return The internal {@link HttpClientContext} instance
*/
protected HttpClientContext getHttpClientContext() {
return httpClientContext;
@@ -115,7 +115,7 @@ public class Http4FileSystem extends AbstractFileSystem {
/**
* Gets the internal base {@code URI} instance.
*
- * @return the internal base {@code URI} instance
+ * @return The internal base {@code URI} instance
*/
protected URI getInternalBaseURI() {
return internalBaseURI;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileSystemConfigBuilder.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileSystemConfigBuilder.java
index e0f576871..aee4eb652 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileSystemConfigBuilder.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileSystemConfigBuilder.java
@@ -181,7 +181,7 @@ public class Http4FileSystemConfigBuilder extends
FileSystemConfigBuilder {
/**
* Gets the singleton builder.
*
- * @return the singleton builder.
+ * @return The singleton builder.
*/
public static Http4FileSystemConfigBuilder getInstance() {
return BUILDER;
@@ -232,7 +232,7 @@ public class Http4FileSystemConfigBuilder extends
FileSystemConfigBuilder {
* Gets the cookies to add to the request.
*
* @param opts The FileSystem options.
- * @return the Cookie array.
+ * @return The Cookie array.
*/
public Cookie[] getCookies(final FileSystemOptions opts) {
return getParam(opts, "cookies");
@@ -371,7 +371,7 @@ public class Http4FileSystemConfigBuilder extends
FileSystemConfigBuilder {
* Sets the charset used for url encoding.
*
* @param opts The FileSystem options.
- * @return the charset name.
+ * @return The charset name.
*/
public String getUrlCharset(final FileSystemOptions opts) {
return getString(opts, "urlCharset");
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4s/Http4sFileNameParser.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4s/Http4sFileNameParser.java
index facbd9afa..00e1482f9 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4s/Http4sFileNameParser.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4s/Http4sFileNameParser.java
@@ -35,7 +35,7 @@ public class Http4sFileNameParser extends
GenericURLFileNameParser {
/**
* Gets the singleton instance.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static FileNameParser getInstance() {
return INSTANCE;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileNameParser.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileNameParser.java
index 86f8c0485..3ca94b671 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileNameParser.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileNameParser.java
@@ -33,7 +33,7 @@ public class Http5FileNameParser extends
GenericURLFileNameParser {
/**
* Gets the singleton instance.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static FileNameParser getInstance() {
return INSTANCE;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java
index ac7100eec..d925a29e6 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java
@@ -188,7 +188,7 @@ public class Http5FileObject<FS extends Http5FileSystem>
extends AbstractFileObj
/**
* Gets the internal {@code URI} object mapped to this file object.
*
- * @return the internal {@code URI} object mapped to this file object
+ * @return The internal {@code URI} object mapped to this file object
*/
protected URI getInternalURI() {
return internalURI;
@@ -197,7 +197,7 @@ public class Http5FileObject<FS extends Http5FileSystem>
extends AbstractFileObj
/**
* Gets the last executed HEAD {@code HttpResponse} object.
*
- * @return the last executed HEAD {@code HttpResponse} object
+ * @return The last executed HEAD {@code HttpResponse} object
* @throws IOException if IO error occurs
*/
ClassicHttpResponse getLastHeadResponse() throws IOException {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystem.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystem.java
index abcc85bc4..a9cd81030 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystem.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystem.java
@@ -95,7 +95,7 @@ public class Http5FileSystem extends AbstractFileSystem {
/**
* Gets the internal {@link HttpClient} instance.
*
- * @return the internal {@link HttpClient} instance
+ * @return The internal {@link HttpClient} instance
*/
protected HttpClient getHttpClient() {
return httpClient;
@@ -104,7 +104,7 @@ public class Http5FileSystem extends AbstractFileSystem {
/**
* Gets the internal {@link HttpClientContext} instance.
*
- * @return the internal {@link HttpClientContext} instance
+ * @return The internal {@link HttpClientContext} instance
*/
protected HttpClientContext getHttpClientContext() {
return httpClientContext;
@@ -113,7 +113,7 @@ public class Http5FileSystem extends AbstractFileSystem {
/**
* Gets the internal base {@code URI} instance.
*
- * @return the internal base {@code URI} instance
+ * @return The internal base {@code URI} instance
*/
protected URI getInternalBaseURI() {
return internalBaseURI;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystemConfigBuilder.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystemConfigBuilder.java
index 49d5538b4..c33b1e21d 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystemConfigBuilder.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystemConfigBuilder.java
@@ -199,7 +199,7 @@ public class Http5FileSystemConfigBuilder extends
FileSystemConfigBuilder {
/**
* Gets the singleton builder.
*
- * @return the singleton builder.
+ * @return The singleton builder.
*/
public static Http5FileSystemConfigBuilder getInstance() {
return BUILDER;
@@ -250,7 +250,7 @@ public class Http5FileSystemConfigBuilder extends
FileSystemConfigBuilder {
* Gets the cookies to add to the request.
*
* @param opts The FileSystem options.
- * @return the Cookie array.
+ * @return The Cookie array.
*/
public Cookie[] getCookies(final FileSystemOptions opts) {
return getParam(opts, "cookies");
@@ -401,7 +401,7 @@ public class Http5FileSystemConfigBuilder extends
FileSystemConfigBuilder {
* Gets the charset used for url encoding.
*
* @param opts The FileSystem options.
- * @return the charset name
+ * @return The charset name
*/
public String getUrlCharset(final FileSystemOptions opts) {
return getString(opts, KEY_URL_CHARSET);
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5s/Http5sFileNameParser.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5s/Http5sFileNameParser.java
index d6ab8652d..689313c28 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5s/Http5sFileNameParser.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5s/Http5sFileNameParser.java
@@ -33,7 +33,7 @@ public class Http5sFileNameParser extends
GenericURLFileNameParser {
/**
* Gets the singleton instance.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static FileNameParser getInstance() {
return INSTANCE;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/https/HttpsFileNameParser.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/https/HttpsFileNameParser.java
index 2257804cc..984c00863 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/https/HttpsFileNameParser.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/https/HttpsFileNameParser.java
@@ -34,7 +34,7 @@ public class HttpsFileNameParser extends URLFileNameParser {
/**
* Gets the singleton instance.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static FileNameParser getInstance() {
return INSTANCE;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/DefaultLocalFileProvider.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/DefaultLocalFileProvider.java
index cfe3e4bfc..73aa16360 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/DefaultLocalFileProvider.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/DefaultLocalFileProvider.java
@@ -73,7 +73,7 @@ public class DefaultLocalFileProvider extends
AbstractOriginatingFileProvider im
* Finds a local file.
*
* @param file The File to locate.
- * @return the located FileObject.
+ * @return The located FileObject.
* @throws FileSystemException if an error occurs.
*/
@Override
@@ -85,7 +85,7 @@ public class DefaultLocalFileProvider extends
AbstractOriginatingFileProvider im
* Finds a local file, from its local name.
*
* @param name The name of the file to locate.
- * @return the located FileObject.
+ * @return The located FileObject.
* @throws FileSystemException if an error occurs.
*/
@Override
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/GenericFileNameParser.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/GenericFileNameParser.java
index a8d46e631..597d4129c 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/GenericFileNameParser.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/GenericFileNameParser.java
@@ -31,7 +31,7 @@ public class GenericFileNameParser extends
LocalFileNameParser {
/**
* Gets the singleton instance, never null.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static GenericFileNameParser getInstance() {
return INSTANCE;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFile.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFile.java
index 46484a0dd..8b036f990 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFile.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFile.java
@@ -254,7 +254,7 @@ public class LocalFile extends
AbstractFileObject<LocalFileSystem> {
/**
* Gets the local file that this file object represents.
*
- * @return the local file that this file object represents.
+ * @return The local file that this file object represents.
*/
protected File getLocalFile() {
return file;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileName.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileName.java
index 50e6d3748..281d8cba3 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileName.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileName.java
@@ -76,7 +76,7 @@ public class LocalFileName extends AbstractFileName {
/**
* Returns the decoded URI of the file.
*
- * @return the FileName as a URI.
+ * @return The FileName as a URI.
*/
@Override
public String toString() {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileNameParser.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileNameParser.java
index 7a2a97e11..3e4b99754 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileNameParser.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileNameParser.java
@@ -53,7 +53,7 @@ public abstract class LocalFileNameParser extends
AbstractFileNameParser {
*
* @param name the URI to modify.
* @param uri the whole URI for error reporting.
- * @return the root prefix extracted.
+ * @return The root prefix extracted.
* @throws FileSystemException if an error occurs.
*/
protected abstract String extractRootPrefix(String uri, StringBuilder
name) throws FileSystemException;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileData.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileData.java
index 4ffede7ed..80a037010 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileData.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileData.java
@@ -124,7 +124,7 @@ final class RamFileData implements Serializable {
}
/**
- * @return the children.
+ * @return The children.
*/
Collection<RamFileData> getChildren() {
if (name == null) {
@@ -134,28 +134,28 @@ final class RamFileData implements Serializable {
}
/**
- * @return the buffer.
+ * @return The buffer.
*/
byte[] getContent() {
return content;
}
/**
- * @return the lastModified.
+ * @return The lastModified.
*/
long getLastModified() {
return lastModifiedMillis;
}
/**
- * @return the name.
+ * @return The name.
*/
FileName getName() {
return name;
}
/**
- * @return the type.
+ * @return The type.
*/
FileType getType() {
return type;
@@ -234,7 +234,7 @@ final class RamFileData implements Serializable {
}
/**
- * @return the size of the buffer
+ * @return The size of the buffer
*/
int size() {
return content.length;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileObject.java
index d71ccc771..df99ae48a 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileObject.java
@@ -203,7 +203,7 @@ public class RamFileObject extends
AbstractFileObject<RamFileSystem> {
}
/**
- * @return the data.
+ * @return The data.
*/
RamFileData getData() {
return data;
@@ -248,7 +248,7 @@ public class RamFileObject extends
AbstractFileObject<RamFileSystem> {
}
/**
- * @return the size of the {@link RamFileData}.
+ * @return The size of the {@link RamFileData}.
*/
int size() {
return data == null ? 0 : data.size();
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileSystem.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileSystem.java
index fb6bddc82..d8f51f1a4 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileSystem.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileSystem.java
@@ -208,7 +208,7 @@ public class RamFileSystem extends AbstractFileSystem
implements Serializable {
}
/**
- * @return the size of the FileSystem
+ * @return The size of the FileSystem
*/
long size() {
synchronized (cache) {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileSystemConfigBuilder.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileSystemConfigBuilder.java
index be9612b0f..747c05721 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileSystemConfigBuilder.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileSystemConfigBuilder.java
@@ -34,7 +34,7 @@ public final class RamFileSystemConfigBuilder extends
FileSystemConfigBuilder {
/**
* Gets the singleton builder.
*
- * @return the singleton builder.
+ * @return The singleton builder.
*/
public static RamFileSystemConfigBuilder getInstance() {
return SINGLETON;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileName.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileName.java
index 447f3e0e3..e904db25b 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileName.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileName.java
@@ -68,7 +68,7 @@ public class ResourceFileName extends AbstractFileName {
/**
* Returns the decoded URI of the file.
*
- * @return the FileName as a URI.
+ * @return The FileName as a URI.
*/
@Override
public String toString() {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileNameParser.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileNameParser.java
index 7ab013c35..47a646a73 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileNameParser.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileNameParser.java
@@ -32,7 +32,7 @@ public class ResourceFileNameParser extends
GenericFileNameParser {
/**
* Gets the singleton instance.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static GenericFileNameParser getInstance() {
return INSTANCE;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileProvider.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileProvider.java
index 74d80020b..d4ba8e29f 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileProvider.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileProvider.java
@@ -57,7 +57,7 @@ public class ResourceFileProvider extends
AbstractFileProvider {
* @param baseFile The base file.
* @param uri The URI of the file to locate.
* @param fileSystemOptions The FileSystem options.
- * @return the FileObject.
+ * @return The FileObject.
* @throws FileSystemException if an error occurs.
*/
@Override
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileSystemConfigBuilder.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileSystemConfigBuilder.java
index 93edafd29..66bd9e4cf 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileSystemConfigBuilder.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileSystemConfigBuilder.java
@@ -31,7 +31,7 @@ public final class ResourceFileSystemConfigBuilder extends
FileSystemConfigBuild
/**
* Gets the singleton builder.
*
- * @return the singleton builder.
+ * @return The singleton builder.
*/
public static ResourceFileSystemConfigBuilder getInstance() {
return BUILDER;
@@ -45,7 +45,7 @@ public final class ResourceFileSystemConfigBuilder extends
FileSystemConfigBuild
* Gets the class loader from the FileSystemOptions.
*
* @param fileSystemOptions The source FileSystemOptions.
- * @return the class loader from the FileSystemOptions.
+ * @return The class loader from the FileSystemOptions.
*/
public ClassLoader getClassLoader(final FileSystemOptions
fileSystemOptions) {
return getParam(fileSystemOptions, ClassLoader.class.getName());
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/BytesIdentityInfo.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/BytesIdentityInfo.java
index e41f10210..c5eb9db41 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/BytesIdentityInfo.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/BytesIdentityInfo.java
@@ -79,7 +79,7 @@ public class BytesIdentityInfo implements IdentityProvider {
/**
* Gets the passphrase.
*
- * @return the passphrase.
+ * @return The passphrase.
* @since 2.10.0
*/
public byte[] getPassphrase() {
@@ -89,7 +89,7 @@ public class BytesIdentityInfo implements IdentityProvider {
/**
* Gets the passphrase.
*
- * @return the passphrase.
+ * @return The passphrase.
* @deprecated Use {@link #getPassphrase()}.
*/
@Deprecated
@@ -100,7 +100,7 @@ public class BytesIdentityInfo implements IdentityProvider {
/**
* Gets the private key.
*
- * @return the private key.
+ * @return The private key.
*/
public byte[] getPrivateKeyBytes() {
return Utils.clone(privateKey);
@@ -109,7 +109,7 @@ public class BytesIdentityInfo implements IdentityProvider {
/**
* Gets the public key.
*
- * @return the public key.
+ * @return The public key.
*/
public byte[] getPublicKeyBytes() {
return Utils.clone(publicKey);
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/IdentityInfo.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/IdentityInfo.java
index ec731da21..c0f3715a9 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/IdentityInfo.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/IdentityInfo.java
@@ -112,7 +112,7 @@ public class IdentityInfo implements IdentityProvider {
/**
* Gets the passphrase of the private key.
*
- * @return the passphrase
+ * @return The passphrase
* @since 2.10.0
*/
public byte[] getPassphrase() {
@@ -122,7 +122,7 @@ public class IdentityInfo implements IdentityProvider {
/**
* Gets the passphrase of the private key.
*
- * @return the passphrase
+ * @return The passphrase
* @since 2.1
* @deprecated Use {@link #getPassphrase()}.
*/
@@ -134,7 +134,7 @@ public class IdentityInfo implements IdentityProvider {
/**
* Gets the file with the private key.
*
- * @return the file
+ * @return The file
* @since 2.1
*/
public File getPrivateKey() {
@@ -144,7 +144,7 @@ public class IdentityInfo implements IdentityProvider {
/**
* Gets the file with the public key.
*
- * @return the file
+ * @return The file
* @since 2.1
*/
public File getPublicKey() {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileNameParser.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileNameParser.java
index a16f564fd..9f1d3f730 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileNameParser.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileNameParser.java
@@ -31,7 +31,7 @@ public class SftpFileNameParser extends URLFileNameParser {
/**
* Gets the singleton instance.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static FileNameParser getInstance() {
return INSTANCE;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystem.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystem.java
index 32800bed4..bc93fec25 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystem.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystem.java
@@ -251,7 +251,7 @@ public class SftpFileSystem extends AbstractFileSystem {
/**
* Gets the (numeric) group IDs.
*
- * @return the (numeric) group IDs.
+ * @return The (numeric) group IDs.
* @throws JSchException If a problem occurs while retrieving the group
IDs.
* @throws IOException if an I/O error is detected.
* @since 2.1
@@ -345,7 +345,7 @@ public class SftpFileSystem extends AbstractFileSystem {
* Parses the output of the 'id -G' command
*
* @param output The output from the command
- * @return the (numeric) group IDs.
+ * @return The (numeric) group IDs.
*/
int[] parseGroupIdOutput(final StringBuilder output) {
// Retrieve the different groups
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java
index 103aeaf14..3d2a8d358 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java
@@ -136,7 +136,7 @@ public final class SftpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
/**
* Gets the singleton builder.
*
- * @return the singleton builder.
+ * @return The singleton builder.
*/
public static SftpFileSystemConfigBuilder getInstance() {
return BUILDER;
@@ -166,7 +166,7 @@ public final class SftpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
* Gets the config repository.
*
* @param options The FileSystem options.
- * @return the ConfigRepository
+ * @return The ConfigRepository
*/
public ConfigRepository getConfigRepository(final FileSystemOptions
options) {
return getParam(options, CONFIG_REPOSITORY);
@@ -202,7 +202,7 @@ public final class SftpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
* Gets the file name encoding.
*
* @param options The FileSystem options.
- * @return the file name encoding
+ * @return The file name encoding
*/
public String getFileNameEncoding(final FileSystemOptions options) {
return this.getString(options, ENCODING);
@@ -215,7 +215,7 @@ public final class SftpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
* </p>
*
* @param options The FileSystem options.
- * @return the array of identity Files.
+ * @return The array of identity Files.
* @see #setIdentities
* @deprecated As of 2.1 use {@link #getIdentityInfo(FileSystemOptions)}
*/
@@ -232,7 +232,7 @@ public final class SftpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
* Gets the identity infos.
*
* @param options The FileSystem options.
- * @return the array of identity info.
+ * @return The array of identity info.
* @see #setIdentityInfo
*/
public IdentityInfo[] getIdentityInfo(final FileSystemOptions options) {
@@ -247,7 +247,7 @@ public final class SftpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
* Gets the identity providers.
*
* @param options The FileSystem options.
- * @return the array of identity providers.
+ * @return The array of identity providers.
* @see #setIdentityProvider
* @since 2.4
*/
@@ -259,7 +259,7 @@ public final class SftpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
* Gets the identity repository factory.
*
* @param options The FileSystem options.
- * @return the IdentityRepositoryFactory
+ * @return The IdentityRepositoryFactory
*/
public IdentityRepositoryFactory getIdentityRepositoryFactory(final
FileSystemOptions options) {
return getParam(options, IDENTITY_REPOSITORY_FACTORY);
@@ -269,7 +269,7 @@ public final class SftpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
* Gets the option value for specific key exchange algorithm.
*
* @param options The FileSystem options.
- * @return the option value for specific key exchange algorithm.
+ * @return The option value for specific key exchange algorithm.
* @see #setKeyExchangeAlgorithm(FileSystemOptions, String)
* @since 2.4
*/
@@ -281,7 +281,7 @@ public final class SftpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
* Gets the known hosts File.
*
* @param options The FileSystem options.
- * @return the known hosts File.
+ * @return The known hosts File.
* @see #setKnownHosts
*/
public File getKnownHosts(final FileSystemOptions options) {
@@ -415,7 +415,7 @@ public final class SftpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
* Gets the option value The host key checking.
*
* @param options The FileSystem options.
- * @return the option value The host key checking.
+ * @return The option value The host key checking.
* @see #setStrictHostKeyChecking(FileSystemOptions, String)
*/
public String getStrictHostKeyChecking(final FileSystemOptions options) {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileSystem.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileSystem.java
index 543ac6491..6a2f9e887 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileSystem.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileSystem.java
@@ -161,7 +161,7 @@ public class TarFileSystem extends AbstractFileSystem {
* Returns the input stream for the given entry.
*
* @param entry The entry to seek.
- * @return the input stream for the given entry.
+ * @return The input stream for the given entry.
* @throws FileSystemException If an I/O error occurs.
*/
public InputStream getInputStream(final TarArchiveEntry entry) throws
FileSystemException {
@@ -183,7 +183,7 @@ public class TarFileSystem extends AbstractFileSystem {
/**
* Gets the TarArchiveInputStream.
*
- * @return the TarArchiveInputStream.
+ * @return The TarArchiveInputStream.
* @throws FileSystemException if a file system error occurs.
*/
protected TarArchiveInputStream getTarFile() throws FileSystemException {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileSystem.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileSystem.java
index 0156957da..311ee9044 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileSystem.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileSystem.java
@@ -141,7 +141,7 @@ public class ZipFileSystem extends AbstractFileSystem {
/**
* Gets the Charset, defaults to {@link StandardCharsets#UTF_8}, the value
used in {@link ZipFile}.
*
- * @return the Charset.
+ * @return The Charset.
*/
protected Charset getCharset() {
return charset;
@@ -158,7 +158,7 @@ public class ZipFileSystem extends AbstractFileSystem {
/**
* Gets the zip file.
*
- * @return the zip file.
+ * @return The zip file.
* @throws FileSystemException if a file system error occurs.
*/
protected ZipFile getZipFile() throws FileSystemException {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileSystemConfigBuilder.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileSystemConfigBuilder.java
index 4c76c53db..ac6a3d5ea 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileSystemConfigBuilder.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileSystemConfigBuilder.java
@@ -36,7 +36,7 @@ public class ZipFileSystemConfigBuilder extends
FileSystemConfigBuilder {
/**
* Gets the singleton instance.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static final ZipFileSystemConfigBuilder getInstance() {
return INSTANCE;
@@ -53,7 +53,7 @@ public class ZipFileSystemConfigBuilder extends
FileSystemConfigBuilder {
* Gets the Charset from the FileSystemOptions or {@link
StandardCharsets#UTF_8} if absent.
*
* @param fileSystemOptions The source FileSystemOptions.
- * @return the Charset from the FileSystemOptions.
+ * @return The Charset from the FileSystemOptions.
*/
public Charset getCharset(final FileSystemOptions fileSystemOptions) {
return getParamOrDefault(fileSystemOptions, KEY_CHARSET,
StandardCharsets.UTF_8);
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/CombinedResources.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/CombinedResources.java
index 2f168e61a..1acdeaee8 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/CombinedResources.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/CombinedResources.java
@@ -69,7 +69,7 @@ public class CombinedResources extends ResourceBundle {
/**
* Gets the resource name.
*
- * @return the resource name.
+ * @return The resource name.
*/
public String getResourceName() {
return resourceName;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/DelegatingFileSystemOptionsBuilder.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/DelegatingFileSystemOptionsBuilder.java
index 1e4900295..e66bc2c18 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/DelegatingFileSystemOptionsBuilder.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/DelegatingFileSystemOptionsBuilder.java
@@ -241,7 +241,7 @@ public class DelegatingFileSystemOptionsBuilder {
/**
* Gets the FileSystemManager.
*
- * @return the FileSystemManager.
+ * @return The FileSystemManager.
*/
protected FileSystemManager getManager() {
return manager;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/Os.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/Os.java
index a2b1eae6a..304f1b0d3 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/Os.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/Os.java
@@ -161,7 +161,7 @@ public final class Os {
* Locates an OsFamily by name (case-insensitive).
*
* @param name The family name to lookup.
- * @return the OS family, or null if not found.
+ * @return The OS family, or null if not found.
*/
public static OsFamily getFamily(final String name) {
for (final OsFamily osFamily : ALL_FAMILIES) {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/PosixPermissions.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/PosixPermissions.java
index 111fb9863..347124219 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/PosixPermissions.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/PosixPermissions.java
@@ -89,7 +89,7 @@ public class PosixPermissions {
/**
* Gets the mask for this permission.
*
- * @return the mask for this permission.
+ * @return The mask for this permission.
*/
public int getMask() {
return mask;
@@ -212,7 +212,7 @@ public class PosixPermissions {
*
* @param executable Whether the new permissions should be readable.
* @param ownerOnly Whether the new permissions are only for the owner.
- * @return the new permissions.
+ * @return The new permissions.
*/
public int makeExecutable(final boolean executable, final boolean
ownerOnly) {
final EnumMap<Type, Boolean> map = new EnumMap<>(Type.class);
@@ -229,7 +229,7 @@ public class PosixPermissions {
*
* @param readable Whether the new permissions should be readable.
* @param ownerOnly Whether the new permissions are only for the owner.
- * @return the new permissions.
+ * @return The new permissions.
*/
public Integer makeReadable(final boolean readable, final boolean
ownerOnly) {
final EnumMap<Type, Boolean> map = new EnumMap<>(Type.class);
@@ -246,7 +246,7 @@ public class PosixPermissions {
*
* @param writable Whether the new permissions should be readable.
* @param ownerOnly Whether the new permissions are only for the owner.
- * @return the new permissions.
+ * @return The new permissions.
*/
public Integer makeWritable(final boolean writable, final boolean
ownerOnly) {
final EnumMap<Type, Boolean> map = new EnumMap<>(Type.class);
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/URIUtils.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/URIUtils.java
index 9b004c6b4..a63acceee 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/URIUtils.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/URIUtils.java
@@ -186,7 +186,7 @@ public class URIUtils {
* the default protocol charset.
*
* @param unescaped an unescaped string
- * @return the escaped string
+ * @return The escaped string
*/
public static String encodePath(final String unescaped) {
return encodePath(unescaped, DEFAULT_PROTOCOL_CHARSET);
@@ -198,7 +198,7 @@ public class URIUtils {
*
* @param unescaped an unescaped string
* @param charset the charset
- * @return the escaped string
+ * @return The escaped string
*/
public static String encodePath(final String unescaped, final String
charset) {
if (unescaped == null) {
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/FileInfo.java
b/commons-vfs2/src/test/java/org/apache/commons/vfs2/FileInfo.java
index ec46b602f..67973d38a 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/FileInfo.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/FileInfo.java
@@ -71,7 +71,7 @@ public class FileInfo {
/**
* Returns the base name for the file.
*
- * @return the base name
+ * @return The base name
*/
public String getBaseName() {
return baseName;
@@ -79,7 +79,7 @@ public class FileInfo {
/**
* Returns a {@code Map} of this {@code FileInfo}'s children.
- * @return the {@code FileInfo}'s children
+ * @return The {@code FileInfo}'s children
*/
public Map<String, FileInfo> getChildren() {
return children;
@@ -88,7 +88,7 @@ public class FileInfo {
/**
* Returns file's content.
*
- * @return the content as a {@code String}
+ * @return The content as a {@code String}
*/
public String getContent() {
return content;
diff --git
a/commons-vfs2/src/test/java/org/apache/commons/vfs2/ProviderReadTests.java
b/commons-vfs2/src/test/java/org/apache/commons/vfs2/ProviderReadTests.java
index 9e99e8f01..c7185d9c4 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/ProviderReadTests.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/ProviderReadTests.java
@@ -100,7 +100,7 @@ public class ProviderReadTests extends
AbstractProviderTestCase {
/**
* Returns the read folder named "dir1".
*
- * @return the read folder named "dir1".
+ * @return The read folder named "dir1".
* @throws FileSystemException
*/
protected FileObject getReadFolderDir1() throws FileSystemException {
diff --git
a/commons-vfs2/src/test/java/org/apache/commons/vfs2/VfsTestUtils.java
b/commons-vfs2/src/test/java/org/apache/commons/vfs2/VfsTestUtils.java
index e9869ad95..540f883e3 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/VfsTestUtils.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/VfsTestUtils.java
@@ -101,7 +101,7 @@ public abstract class VfsTestUtils {
*
* {@link #getTestDirectoryFile()} should be preferred.
*
- * @return the test directory as a String
+ * @return The test directory as a String
*/
public static String getTestDirectory() {
return System.getProperty(TEST_BASE_DIR,
"target/test-classes/test-data");
diff --git
a/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/sftp/SftpTestServerHelper.java
b/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/sftp/SftpTestServerHelper.java
index 0937d3110..56dcc1b88 100644
---
a/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/sftp/SftpTestServerHelper.java
+++
b/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/sftp/SftpTestServerHelper.java
@@ -239,7 +239,7 @@ public final class SftpTestServerHelper {
/**
* Gets the connection URI for the embedded server.
*
- * @return the connection URI, or null if server is not started
+ * @return The connection URI, or null if server is not started
*/
public static String getConnectionUri() {
return connectionUri;
