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 622647891 Javadoc
622647891 is described below
commit 62264789165f19ef27e05cbcacee1cb98b9663ea
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:09:22 2026 -0400
Javadoc
---
.../commons/vfs2/provider/hdfs/HdfsFileContentInfoFactory.java | 2 +-
.../main/java/org/apache/commons/vfs2/FileContentInfoFactory.java | 2 +-
.../java/org/apache/commons/vfs2/FileSystemConfigBuilder.java | 2 +-
.../main/java/org/apache/commons/vfs2/UserAuthenticationData.java | 2 +-
.../java/org/apache/commons/vfs2/cache/DefaultFilesCache.java | 2 +-
.../main/java/org/apache/commons/vfs2/cache/LRUFilesCache.java | 2 +-
.../java/org/apache/commons/vfs2/cache/SoftRefFilesCache.java | 4 ++--
.../main/java/org/apache/commons/vfs2/filter/AgeFileFilter.java | 2 +-
.../main/java/org/apache/commons/vfs2/filter/AndFileFilter.java | 2 +-
.../src/main/java/org/apache/commons/vfs2/filter/IOCase.java | 2 +-
.../main/java/org/apache/commons/vfs2/filter/NameFileFilter.java | 2 +-
.../main/java/org/apache/commons/vfs2/filter/NotFileFilter.java | 2 +-
.../main/java/org/apache/commons/vfs2/filter/OrFileFilter.java | 2 +-
.../java/org/apache/commons/vfs2/filter/PrefixFileFilter.java | 2 +-
.../main/java/org/apache/commons/vfs2/filter/SizeFileFilter.java | 2 +-
.../java/org/apache/commons/vfs2/filter/SuffixFileFilter.java | 2 +-
.../java/org/apache/commons/vfs2/filter/WildcardFileFilter.java | 2 +-
.../main/java/org/apache/commons/vfs2/function/VfsConsumer.java | 2 +-
.../java/org/apache/commons/vfs2/impl/DefaultFileReplicator.java | 2 +-
.../org/apache/commons/vfs2/impl/StandardFileSystemManager.java | 2 +-
.../commons/vfs2/operations/AbstractFileOperationProvider.java | 2 +-
.../java/org/apache/commons/vfs2/operations/FileOperations.java | 2 +-
.../java/org/apache/commons/vfs2/provider/AbstractFileName.java | 2 +-
.../java/org/apache/commons/vfs2/provider/AbstractFileObject.java | 8 ++++----
.../commons/vfs2/provider/AbstractRandomAccessStreamContent.java | 2 +-
.../java/org/apache/commons/vfs2/provider/DefaultFileContent.java | 2 +-
.../main/java/org/apache/commons/vfs2/provider/FileProvider.java | 4 ++--
.../org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.java | 2 +-
.../vfs2/provider/compressed/CompressedFileFileProvider.java | 2 +-
.../org/apache/commons/vfs2/provider/ftp/FTPClientWrapper.java | 4 ++--
.../main/java/org/apache/commons/vfs2/provider/ftp/FtpClient.java | 2 +-
.../org/apache/commons/vfs2/provider/ftp/FtpClientFactory.java | 2 +-
.../org/apache/commons/vfs2/provider/ftp/FtpFileProvider.java | 2 +-
.../org/apache/commons/vfs2/provider/ftps/FtpsFileProvider.java | 2 +-
.../org/apache/commons/vfs2/provider/http/HttpClientFactory.java | 4 ++--
.../org/apache/commons/vfs2/provider/http/HttpFileObject.java | 4 ++--
.../org/apache/commons/vfs2/provider/http/HttpFileProvider.java | 2 +-
.../org/apache/commons/vfs2/provider/http4/Http4FileProvider.java | 8 ++++----
.../org/apache/commons/vfs2/provider/http5/Http5FileProvider.java | 8 ++++----
.../commons/vfs2/provider/local/DefaultLocalFileProvider.java | 2 +-
.../apache/commons/vfs2/provider/local/LocalFileNameParser.java | 2 +-
.../commons/vfs2/provider/sftp/IdentityRepositoryFactory.java | 2 +-
.../commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java | 2 +-
.../java/org/apache/commons/vfs2/provider/tar/TarFileSystem.java | 4 ++--
.../java/org/apache/commons/vfs2/provider/url/UrlFileObject.java | 2 +-
.../java/org/apache/commons/vfs2/provider/zip/ZipFileSystem.java | 4 ++--
.../main/java/org/apache/commons/vfs2/util/FileObjectUtils.java | 4 ++--
.../src/main/java/org/apache/commons/vfs2/util/OsFamily.java | 2 +-
.../main/java/org/apache/commons/vfs2/util/RandomAccessMode.java | 2 +-
.../java/org/apache/commons/vfs2/util/FreeSocketPortUtil.java | 2 +-
50 files changed, 67 insertions(+), 67 deletions(-)
diff --git
a/commons-vfs2-hdfs/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileContentInfoFactory.java
b/commons-vfs2-hdfs/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileContentInfoFactory.java
index 917513117..cce22e6d0 100644
---
a/commons-vfs2-hdfs/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileContentInfoFactory.java
+++
b/commons-vfs2-hdfs/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileContentInfoFactory.java
@@ -45,7 +45,7 @@ public class HdfsFileContentInfoFactory implements
FileContentInfoFactory {
* Creates a FileContentInfo for the given FileContent.
*
* @param fileContent Use this FileContent to create a matching
FileContentInfo
- * @return a FileContentInfo for the given FileContent with content set to
"text/plain" and encoding set to "UTF-8"
+ * @return A FileContentInfo for the given FileContent with content set to
"text/plain" and encoding set to "UTF-8"
* @throws FileSystemException when a problem occurs creating the
FileContentInfo.
*/
@Override
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContentInfoFactory.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContentInfoFactory.java
index 61a83cab6..babb3f682 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContentInfoFactory.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContentInfoFactory.java
@@ -25,7 +25,7 @@ public interface FileContentInfoFactory {
* Creates a FileContentInfo for the given FileContent.
*
* @param fileContent Use this FileContent to create a matching
FileContentInfo
- * @return a FileContentInfo for the given FileContent.
+ * @return A FileContentInfo for the given FileContent.
* @throws FileSystemException when a problem occurs creating the
FileContentInfo.
*/
FileContentInfo create(FileContent fileContent) throws FileSystemException;
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 ff81c05a9..fbe2dca83 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
@@ -548,7 +548,7 @@ public abstract class FileSystemConfigBuilder {
* Gets the system property for the given name.
*
* @param name The name to lookup combined with the prefix.
- * @return a system property or null.
+ * @return A system property or null.
* @since 2.1
*/
private String getProperty(final String name) {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/UserAuthenticationData.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/UserAuthenticationData.java
index 827e90f43..b711856ee 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/UserAuthenticationData.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/UserAuthenticationData.java
@@ -118,7 +118,7 @@ public class UserAuthenticationData {
* Gets a data from the collection.
*
* @param type The Type to retrieve.
- * @return a character array containing the data associated with the type.
+ * @return A character array containing the data associated with the type.
*/
public char[] getData(final Type type) {
return authenticationData.get(type);
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/DefaultFilesCache.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/DefaultFilesCache.java
index 86533a80f..59b7a79e8 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/DefaultFilesCache.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/DefaultFilesCache.java
@@ -87,7 +87,7 @@ public class DefaultFilesCache extends AbstractFilesCache {
* Gets or creates a Map.
*
* @param fileSystem the key
- * @return an existing or new Map.
+ * @return An existing or new Map.
*/
protected ConcurrentMap<FileName, FileObject>
getOrCreateFilesystemCache(final FileSystem fileSystem) {
ConcurrentMap<FileName, FileObject> files =
fileSystemCache.get(fileSystem);
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/LRUFilesCache.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/LRUFilesCache.java
index 0bf1744d0..c837685a3 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/LRUFilesCache.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/LRUFilesCache.java
@@ -149,7 +149,7 @@ public class LRUFilesCache extends AbstractFilesCache {
* Gets or creates a new Map.
*
* @param fileSystem the key.
- * @return an existing or new Map.
+ * @return An existing or new Map.
*/
protected Map<FileName, FileObject> getOrCreateFilesystemCache(final
FileSystem fileSystem) {
return fileSystemCache.computeIfAbsent(fileSystem, k -> new
MyLRUMap(k, lruSize));
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/SoftRefFilesCache.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/SoftRefFilesCache.java
index 30a41dbf9..46130f1f6 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/SoftRefFilesCache.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/SoftRefFilesCache.java
@@ -116,7 +116,7 @@ public class SoftRefFilesCache extends AbstractFilesCache {
*
* @param file a file object.
* @param referenceQueue a ReferenceQueue.
- * @return a new Reference on the given input.
+ * @return A new Reference on the given input.
*/
protected Reference<FileObject> createReference(final FileObject file,
final ReferenceQueue<FileObject> referenceQueue) {
return new SoftReference<>(file, referenceQueue);
@@ -148,7 +148,7 @@ public class SoftRefFilesCache extends AbstractFilesCache {
* Gets or creates a new Map.
*
* @param fileSystem the key.
- * @return an existing or new Map.
+ * @return An existing or new Map.
*/
protected synchronized Map<FileName, Reference<FileObject>>
getOrCreateFilesystemCache(final FileSystem fileSystem) {
if (fileSystemCache.isEmpty()) {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AgeFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AgeFileFilter.java
index 7848d53d8..9e6cf3b75 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AgeFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AgeFileFilter.java
@@ -178,7 +178,7 @@ public class AgeFileFilter implements FileFilter,
Serializable {
/**
* Provide a String representation of this file filter.
*
- * @return a String representation
+ * @return A String representation
*/
@Override
public String toString() {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AndFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AndFileFilter.java
index 1a4cdbb54..4b9de1199 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AndFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AndFileFilter.java
@@ -120,7 +120,7 @@ public class AndFileFilter implements FileFilter,
ConditionalFileFilter, Seriali
/**
* Provide a String representation of this file filter.
*
- * @return a String representation
+ * @return A String representation
*/
@Override
public String toString() {
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 02af9bbce..588828da2 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
@@ -242,7 +242,7 @@ public enum IOCase {
/**
* Gets a string describing the sensitivity.
*
- * @return a string describing the sensitivity
+ * @return A string describing the sensitivity
*/
@Override
public String toString() {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NameFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NameFileFilter.java
index 2d0d46819..bc051be2a 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NameFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NameFileFilter.java
@@ -123,7 +123,7 @@ public class NameFileFilter implements FileFilter,
Serializable {
/**
* Provide a String representation of this file filter.
*
- * @return a String representation
+ * @return A String representation
*/
@Override
public String toString() {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NotFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NotFileFilter.java
index 55861869a..280644b53 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NotFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NotFileFilter.java
@@ -64,7 +64,7 @@ public class NotFileFilter implements FileFilter,
Serializable {
/**
* Provide a String representation of this file filter.
*
- * @return a String representation
+ * @return A String representation
*/
@Override
public String toString() {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/OrFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/OrFileFilter.java
index f365df2f2..859361a66 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/OrFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/OrFileFilter.java
@@ -116,7 +116,7 @@ public class OrFileFilter implements FileFilter,
ConditionalFileFilter, Serializ
/**
* Provide a String representation of this file filter.
*
- * @return a String representation
+ * @return A String representation
*/
@Override
public String toString() {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/PrefixFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/PrefixFileFilter.java
index f58268531..957cd30f7 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/PrefixFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/PrefixFileFilter.java
@@ -122,7 +122,7 @@ public class PrefixFileFilter implements FileFilter,
Serializable {
/**
* Provide a String representation of this file filter.
*
- * @return a String representation
+ * @return A String representation
*/
@Override
public String toString() {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SizeFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SizeFileFilter.java
index a94856a27..6b35ec4ff 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SizeFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SizeFileFilter.java
@@ -114,7 +114,7 @@ public class SizeFileFilter implements FileFilter,
Serializable {
/**
* Provide a String representation of this file filter.
*
- * @return a String representation
+ * @return A String representation
*/
@Override
public String toString() {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SuffixFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SuffixFileFilter.java
index b0cd9f364..d31efd1b0 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SuffixFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SuffixFileFilter.java
@@ -120,7 +120,7 @@ public class SuffixFileFilter implements FileFilter,
Serializable {
/**
* Provides a String representation of this file filter.
*
- * @return a String representation
+ * @return A String representation
*/
@Override
public String toString() {
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 8ade9f885..0c11ffc79 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
@@ -277,7 +277,7 @@ public class WildcardFileFilter implements FileFilter,
Serializable {
/**
* Provide a String representation of this file filter.
*
- * @return a String representation
+ * @return A String representation
*/
@Override
public String toString() {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/function/VfsConsumer.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/function/VfsConsumer.java
index e930f0402..7155d7aa6 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/function/VfsConsumer.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/function/VfsConsumer.java
@@ -44,7 +44,7 @@ public interface VfsConsumer<T> {
* operation. If performing this operation throws an exception, the {@code
after} operation will not be performed.
*
* @param after the operation to perform after this operation
- * @return a composed {@code Consumer} that performs in sequence this
operation followed by the {@code after}
+ * @return A composed {@code Consumer} that performs in sequence this
operation followed by the {@code after}
* operation
* @throws NullPointerException if {@code after} is null
*/
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 9eabc07b6..ccf6a5739 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
@@ -121,7 +121,7 @@ public class DefaultFileReplicator extends
AbstractVfsComponent implements FileR
*
* @param parent ignored.
* @param baseName the base file name.
- * @return a File.
+ * @return A File.
* @throws FileSystemException if a file system error occurs.
*/
protected File createAndAddFile(final File parent, final String baseName)
throws FileSystemException {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/StandardFileSystemManager.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/StandardFileSystemManager.java
index 5075c4900..b13f240f9 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/StandardFileSystemManager.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/StandardFileSystemManager.java
@@ -236,7 +236,7 @@ public class StandardFileSystemManager extends
DefaultFileSystemManager {
/**
* Gets a new DefaultFileReplicator.
*
- * @return a new DefaultFileReplicator.
+ * @return A new DefaultFileReplicator.
*/
protected DefaultFileReplicator createDefaultFileReplicator() {
return new DefaultFileReplicator();
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 01a2e0d41..1799f5db4 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
@@ -102,7 +102,7 @@ public abstract class AbstractFileOperationProvider
implements FileOperationProv
*
* @param file the file this operation should act on.
* @param operationClass the class of a file operation interface to
instantiate.
- * @return a new file operation
+ * @return A new file operation
* @throws FileSystemException if operation cannot be instantiated.
*/
protected abstract FileOperation instantiateOperation(FileObject file,
Class<? extends FileOperation> operationClass) throws FileSystemException;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperations.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperations.java
index ae18ee157..d5cc7fdd6 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperations.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperations.java
@@ -30,7 +30,7 @@ public interface FileOperations {
* Gets the file operation for the given class.
*
* @param operationClass the operation Class.
- * @return an operation implementing the given {@code operationClass}.
+ * @return An operation implementing the given {@code operationClass}.
* @throws FileSystemException if an error occurs.
*/
FileOperation getOperation(Class<? extends FileOperation> operationClass)
throws FileSystemException;
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 79ce83d10..59f4ea28b 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
@@ -143,7 +143,7 @@ public abstract class AbstractFileName implements FileName {
/**
* Creates a URI.
*
- * @return a URI.
+ * @return A URI.
*/
protected String createURI() {
return createURI(false, true);
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 d4f32327c..84d3b6be5 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
@@ -245,7 +245,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* Compares two FileObjects (ignores case).
*
* @param file the object to compare.
- * @return a negative integer, zero, or a positive integer when this
object is less than, equal to, or greater than
+ * @return A negative integer, zero, or a positive integer when this
object is less than, equal to, or greater than
* the given object.
*/
@Override
@@ -785,7 +785,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* Lists the children of this file. Is only called if {@link #doGetType}
returns {@link FileType#FOLDER}. The return
* value of this method is cached, so the implementation can be expensive.
*
- * @return a possible empty String array if the file is a directory or
null or an exception if the file is not a
+ * @return A possible empty String array if the file is a directory or
null or an exception if the file is not a
* directory or can't be read.
* @throws Exception if an error occurs.
*/
@@ -1050,7 +1050,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
/**
* Returns the children of the file.
*
- * @return an array of FileObjects, one per child.
+ * @return An array of FileObjects, one per child.
* @throws FileSystemException if an error occurs.
*/
@Override
@@ -1644,7 +1644,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
/**
* Returns an iterator over a set of all FileObject in this file object.
*
- * @return an Iterator.
+ * @return An Iterator.
*/
@Override
public Iterator<FileObject> iterator() {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractRandomAccessStreamContent.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractRandomAccessStreamContent.java
index dbebb12a2..1d058d25b 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractRandomAccessStreamContent.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractRandomAccessStreamContent.java
@@ -39,7 +39,7 @@ public abstract class AbstractRandomAccessStreamContent
extends AbstractRandomAc
/**
* Gets a DataInputStream.
*
- * @return a DataInputStream.
+ * @return A DataInputStream.
* @throws IOException if an IO error occurs.
*/
protected abstract DataInputStream getDataInputStream() throws IOException;
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 6cbc6c79b..5a4ab4507 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
@@ -439,7 +439,7 @@ public final class DefaultFileContent implements
FileContent {
/**
* Returns a read-only map of this file's attributes.
*
- * @return a Map of the file's attributes.
+ * @return A Map of the file's attributes.
* @throws FileSystemException if an error occurs.
*/
@Override
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/FileProvider.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/FileProvider.java
index 7e5eea331..9ac0c0ad4 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/FileProvider.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/FileProvider.java
@@ -61,14 +61,14 @@ public interface FileProvider {
* These are the same as on the file system, but available before the
first file system was instantiated.
* </p>
*
- * @return a Collection of the file systems Capabilities.
+ * @return A Collection of the file systems Capabilities.
*/
Collection<Capability> getCapabilities();
/**
* Gets the configbuilder usable to collect the needed fileSystemOptions.
*
- * @return a FileSystemConfigBuilder for the particular file system.
+ * @return A FileSystemConfigBuilder for the particular file system.
*/
FileSystemConfigBuilder getConfigBuilder();
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.java
index 5128791ad..99ff31f2b 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.java
@@ -44,7 +44,7 @@ public class Bzip2FileObject extends
CompressedFileFileObject<Bzip2FileSystem> {
*
* @param name Unused.
* @param inputStream The input stream to wrap.
- * @return a new compressor input stream.
+ * @return A new compressor input stream.
* @throws IOException if the stream content is malformed or an I/O error
occurs.
*/
public static InputStream wrapInputStream(final String name, final
InputStream inputStream) throws IOException {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/compressed/CompressedFileFileProvider.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/compressed/CompressedFileFileProvider.java
index fd923d92e..4c7bbb26c 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/compressed/CompressedFileFileProvider.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/compressed/CompressedFileFileProvider.java
@@ -45,7 +45,7 @@ public abstract class CompressedFileFileProvider extends
AbstractLayeredFileProv
* @param name a file name.
* @param file a file object.
* @param fileSystemOptions the file system options.
- * @return a FileSystem.
+ * @return A FileSystem.
* @throws FileSystemException if a file system error occurs.
*/
protected abstract FileSystem createFileSystem(FileName name, FileObject
file, FileSystemOptions fileSystemOptions) throws FileSystemException;
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 63644cb86..b3e12d445 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
@@ -111,7 +111,7 @@ public class FTPClientWrapper implements FtpClient {
/**
* Creates an FTP client.
*
- * @return a new FTP client.
+ * @return A new FTP client.
* @throws FileSystemException if an error occurs while establishing a
connection.
*/
private FTPClient createClient() throws FileSystemException {
@@ -130,7 +130,7 @@ public class FTPClientWrapper implements FtpClient {
*
* @param rootName the root file name.
* @param authData authentication data.
- * @return an FTPClient.
+ * @return An FTPClient.
* @throws FileSystemException if an error occurs while establishing a
connection.
*/
protected FTPClient createClient(final GenericFileName rootName, final
UserAuthenticationData authData)
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClient.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClient.java
index a74dc535f..9fd5df0e6 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClient.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClient.java
@@ -134,7 +134,7 @@ public interface FtpClient {
* </p>
*
* @param relPath The file or directory to list.
- * @return an array of FTPFile.
+ * @return An array of FTPFile.
* @throws IOException If an I/O error occurs.
*/
FTPFile[] listFiles(String relPath) throws IOException;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClientFactory.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClientFactory.java
index f6415bc75..7b5a2fddc 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClientFactory.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClientFactory.java
@@ -108,7 +108,7 @@ public final class FtpClientFactory {
* Creates a new client.
*
* @param fileSystemOptions the file system options.
- * @return a new client.
+ * @return A new client.
* @throws FileSystemException if a file system error occurs.
*/
protected abstract C createClient(FileSystemOptions fileSystemOptions)
throws FileSystemException;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileProvider.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileProvider.java
index 3a681822f..3dd20c451 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileProvider.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileProvider.java
@@ -61,7 +61,7 @@ public class FtpFileProvider extends
AbstractOriginatingFileProvider {
/**
* Creates the file system.
*
- * @return a new FileSystem, never null.
+ * @return A new FileSystem, never null.
*/
@Override
protected FileSystem doCreateFileSystem(final FileName name, final
FileSystemOptions fileSystemOptions)
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileProvider.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileProvider.java
index a06a3b6b6..c67415f78 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileProvider.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileProvider.java
@@ -43,7 +43,7 @@ public class FtpsFileProvider extends FtpFileProvider {
/**
* Creates the file system.
*
- * @return a new FileSystem, never null.
+ * @return A new FileSystem, never null.
*/
@Override
protected FileSystem doCreateFileSystem(final FileName name, final
FileSystemOptions fileSystemOptions)
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpClientFactory.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpClientFactory.java
index bdf563ffa..b6e96bffb 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpClientFactory.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpClientFactory.java
@@ -51,7 +51,7 @@ public final class HttpClientFactory {
* @param username The username.
* @param password The password
* @param fileSystemOptions The file system options.
- * @return a new HttpClient connection.
+ * @return A new HttpClient connection.
* @throws FileSystemException if an error occurs.
* @since 2.0
*/
@@ -138,7 +138,7 @@ public final class HttpClientFactory {
* @param username The user name.
* @param password The user password.
* @param fileSystemOptions The file system options.
- * @return a new HttpClient connection.
+ * @return A new HttpClient connection.
* @throws FileSystemException if an error occurs.
*/
public static HttpClient createConnection(final String scheme, final
String hostname, final int port, final String username, final String password,
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 e21504fae..561e3e27c 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
@@ -221,7 +221,7 @@ public class HttpFileObject<FS extends HttpFileSystem>
extends AbstractFileObjec
/**
* Gets a new FileContentInfoFactory.
*
- * @return a new FileContentInfoFactory.
+ * @return A new FileContentInfoFactory.
*/
@Override
protected FileContentInfoFactory getFileContentInfoFactory() {
@@ -240,7 +240,7 @@ public class HttpFileObject<FS extends HttpFileSystem>
extends AbstractFileObjec
/**
* Gets a new HeadMethod.
*
- * @return a new HeadMethod.
+ * @return A new HeadMethod.
* @throws IOException if an IO error occurs.
*/
HeadMethod getHeadMethod() throws IOException {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileProvider.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileProvider.java
index acdf8406d..fc660dcce 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileProvider.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileProvider.java
@@ -58,7 +58,7 @@ public class HttpFileProvider extends
AbstractOriginatingFileProvider {
/**
* Creates a {@link FileSystem}.
*
- * @return a new FileSystem, never null.
+ * @return A new FileSystem, never null.
*/
@Override
protected FileSystem doCreateFileSystem(final FileName name, final
FileSystemOptions fileSystemOptions)
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileProvider.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileProvider.java
index 9b60ffffa..e851e470f 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileProvider.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileProvider.java
@@ -178,7 +178,7 @@ public class Http4FileProvider extends
AbstractOriginatingFileProvider {
* @param builder Configuration options builder for http4 provider
* @param rootName The root path
* @param fileSystemOptions The file system options
- * @return an {@link HttpClient} object
+ * @return An {@link HttpClient} object
* @throws FileSystemException if an error occurs.
*/
protected HttpClient createHttpClient(final Http4FileSystemConfigBuilder
builder, final GenericFileName rootName,
@@ -192,7 +192,7 @@ public class Http4FileProvider extends
AbstractOriginatingFileProvider {
* @param builder Configuration options builder for HTTP4 provider
* @param rootName The root path
* @param fileSystemOptions The FileSystem options
- * @return an {@link HttpClientBuilder} object
+ * @return An {@link HttpClientBuilder} object
* @throws FileSystemException if an error occurs
*/
protected HttpClientBuilder createHttpClientBuilder(final
Http4FileSystemConfigBuilder builder, final GenericFileName rootName,
@@ -230,7 +230,7 @@ public class Http4FileProvider extends
AbstractOriginatingFileProvider {
* @param rootName The root path
* @param fileSystemOptions The FileSystem options
* @param authData The {@code UserAuthenticationData} object
- * @return an {@link HttpClientContext} object
+ * @return An {@link HttpClientContext} object
*/
protected HttpClientContext createHttpClientContext(final
Http4FileSystemConfigBuilder builder,
final GenericFileName rootName, final FileSystemOptions
fileSystemOptions,
@@ -282,7 +282,7 @@ public class Http4FileProvider extends
AbstractOriginatingFileProvider {
*
* @param builder Configuration options builder for HTTP4 provider
* @param fileSystemOptions The FileSystem options
- * @return a {@link SSLContext} for HttpClient
+ * @return A {@link SSLContext} for HttpClient
* @throws FileSystemException if an error occurs
*/
protected SSLContext createSSLContext(final Http4FileSystemConfigBuilder
builder,
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileProvider.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileProvider.java
index 8465bf02c..52f21c092 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileProvider.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileProvider.java
@@ -173,7 +173,7 @@ public class Http5FileProvider extends
AbstractOriginatingFileProvider {
* @param builder Configuration options builder for http4 provider.
* @param rootName The root path.
* @param fileSystemOptions The file system options.
- * @return an {@link HttpClient} object.
+ * @return An {@link HttpClient} object.
* @throws FileSystemException if an error occurs.
*/
protected HttpClient createHttpClient(final Http5FileSystemConfigBuilder
builder, final GenericFileName rootName,
@@ -187,7 +187,7 @@ public class Http5FileProvider extends
AbstractOriginatingFileProvider {
* @param builder Configuration options builder for HTTP4 provider.
* @param rootName The root path.
* @param fileSystemOptions The FileSystem options.
- * @return an {@link HttpClientBuilder} object.
+ * @return An {@link HttpClientBuilder} object.
* @throws FileSystemException if an error occurs.
*/
protected HttpClientBuilder createHttpClientBuilder(final
Http5FileSystemConfigBuilder builder, final GenericFileName rootName,
@@ -221,7 +221,7 @@ public class Http5FileProvider extends
AbstractOriginatingFileProvider {
* @param rootName The root path.
* @param fileSystemOptions The FileSystem options.
* @param authData The {@code UserAuthenticationData} object.
- * @return an {@link HttpClientContext} object.
+ * @return An {@link HttpClientContext} object.
*/
protected HttpClientContext createHttpClientContext(final
Http5FileSystemConfigBuilder builder,
final GenericFileName rootName, final FileSystemOptions
fileSystemOptions,
@@ -273,7 +273,7 @@ public class Http5FileProvider extends
AbstractOriginatingFileProvider {
*
* @param builder Configuration options builder for HTTP4 provider.
* @param fileSystemOptions The FileSystem options.
- * @return a {@link SSLContext} for HttpClient.
+ * @return A {@link SSLContext} for HttpClient.
* @throws FileSystemException if an error occurs.
*/
protected SSLContext createSSLContext(final Http5FileSystemConfigBuilder
builder,
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 73aa16360..984a94a06 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
@@ -59,7 +59,7 @@ public class DefaultLocalFileProvider extends
AbstractOriginatingFileProvider im
/**
* Creates the file system.
*
- * @return a new FileSystem, never null.
+ * @return A new FileSystem, never null.
*/
@Override
protected FileSystem doCreateFileSystem(final FileName name, final
FileSystemOptions fileSystemOptions)
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 3e4b99754..280f2cc98 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
@@ -44,7 +44,7 @@ public abstract class LocalFileNameParser extends
AbstractFileNameParser {
* @param rootFile the root file.
* @param path the path.
* @param fileType the file type.
- * @return a FileName.
+ * @return A FileName.
*/
protected abstract FileName createFileName(String scheme, String rootFile,
String path, FileType fileType);
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/IdentityRepositoryFactory.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/IdentityRepositoryFactory.java
index 368f56daa..05336f0fe 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/IdentityRepositoryFactory.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/IdentityRepositoryFactory.java
@@ -28,7 +28,7 @@ public interface IdentityRepositoryFactory {
* Creates an Identity repository for a given JSch instance.
*
* @param jsch JSch context
- * @return a new IdentityRepository
+ * @return A new IdentityRepository
*/
IdentityRepository create(JSch jsch);
}
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 3d2a8d358..ce1130c15 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
@@ -71,7 +71,7 @@ public final class SftpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
}
/**
- * @return a hash code value for this object.
+ * @return A hash code value for this object.
* @since 2.0
*/
@Override
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 6a2f9e887..9bce7878e 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
@@ -106,7 +106,7 @@ public class TarFileSystem extends AbstractFileSystem {
* Creates a new TarArchiveInputStream.
*
* @param file the file.
- * @return a new TarArchiveInputStream.
+ * @return A new TarArchiveInputStream.
* @throws FileSystemException if a file system error occurs.
*/
protected TarArchiveInputStream createTarFile(final File file) throws
FileSystemException {
@@ -129,7 +129,7 @@ public class TarFileSystem extends AbstractFileSystem {
*
* @param fileName the file name.
* @param entry the archive entry.
- * @return a new TarFileObject.
+ * @return A new TarFileObject.
*/
protected TarFileObject createTarFileObject(final AbstractFileName
fileName, final TarArchiveEntry entry) {
return new TarFileObject(fileName, entry, this, true);
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileObject.java
index 1c24281cb..1261cee98 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileObject.java
@@ -56,7 +56,7 @@ public class UrlFileObject extends
AbstractFileObject<UrlFileSystem> {
* Creates a URL from the given file name.
*
* @param name the file name.
- * @return a new URL.
+ * @return A new URL.
* @throws IOException if an I/O error occurs.
*/
protected URL createURL(final FileName name) throws IOException {
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 311ee9044..77bef5940 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
@@ -103,7 +103,7 @@ public class ZipFileSystem extends AbstractFileSystem {
* Creates a Zip file.
*
* @param file the underlying file.
- * @return a Zip file.
+ * @return A Zip file.
* @throws FileSystemException if a file system error occurs.
*/
protected ZipFile createZipFile(final File file) throws
FileSystemException {
@@ -119,7 +119,7 @@ public class ZipFileSystem extends AbstractFileSystem {
*
* @param fileName the underlying file.
* @param entry the Zip entry.
- * @return a new ZipFileObject.
+ * @return A new ZipFileObject.
* @throws FileSystemException if a file system error occurs.
*/
protected ZipFileObject createZipFileObject(final AbstractFileName
fileName, final ZipEntry entry) throws FileSystemException {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/FileObjectUtils.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/FileObjectUtils.java
index 6228916e3..a66d4fcde 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/FileObjectUtils.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/FileObjectUtils.java
@@ -144,7 +144,7 @@ public final class FileObjectUtils {
* Reads the given file into a new {@link Properties}.
*
* @param fileObject the file to read
- * @return a new {@link Properties}.
+ * @return A new {@link Properties}.
* @throws IOException On error getting this file's content.
* @throws FileSystemException On error getting this file's content.
* @throws IOException On error getting this file's content.
@@ -159,7 +159,7 @@ public final class FileObjectUtils {
*
* @param fileObject the file to read
* @param properties the destination
- * @return a new {@link Properties}.
+ * @return A new {@link Properties}.
* @throws FileSystemException On error getting this file's content.
* @throws IOException On error getting this file's content.
* @since 2.4
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/OsFamily.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/OsFamily.java
index d39a429aa..59dc886b0 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/OsFamily.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/OsFamily.java
@@ -43,7 +43,7 @@ public final class OsFamily {
/**
* Returns the OS families that this family belongs to.
*
- * @return an array of OSFamily objects that this family belongs to.
+ * @return An array of OSFamily objects that this family belongs to.
*/
public OsFamily[] getFamilies() {
return families;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/RandomAccessMode.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/RandomAccessMode.java
index c5c5f6189..dbd1b3a01 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/RandomAccessMode.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/RandomAccessMode.java
@@ -133,7 +133,7 @@ public enum RandomAccessMode {
/**
* Converts this instance to an array of {@link AccessMode}.
*
- * @return an array of {@link AccessMode}.
+ * @return An array of {@link AccessMode}.
* @since 2.10.0
*/
public AccessMode[] toAccessModes() {
diff --git
a/commons-vfs2/src/test/java/org/apache/commons/vfs2/util/FreeSocketPortUtil.java
b/commons-vfs2/src/test/java/org/apache/commons/vfs2/util/FreeSocketPortUtil.java
index ee87c8a16..dedfbefeb 100644
---
a/commons-vfs2/src/test/java/org/apache/commons/vfs2/util/FreeSocketPortUtil.java
+++
b/commons-vfs2/src/test/java/org/apache/commons/vfs2/util/FreeSocketPortUtil.java
@@ -24,7 +24,7 @@ public class FreeSocketPortUtil {
/**
* Finds a free local socket port.
*
- * @return a free local socket port.
+ * @return A free local socket port.
* @throws IOException
*/
public static int findFreeLocalPort() throws IOException {
