You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2019/05/19 01:38:37 UTC
[commons-vfs] branch master updated: - Close Javadoc tags. - Minor
formating. - Remove trailing whitespace.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-vfs.git
The following commit(s) were added to refs/heads/master by this push:
new 18de140 - Close Javadoc tags. - Minor formating. - Remove trailing whitespace.
18de140 is described below
commit 18de1403ba62a42d91a12d4c7507b5d458a7f231
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat May 18 21:38:32 2019 -0400
- Close Javadoc tags.
- Minor formating.
- Remove trailing whitespace.
---
.../main/java/org/apache/commons/vfs2/VfsLog.java | 2 +-
.../commons/vfs2/auth/StaticUserAuthenticator.java | 1 +
.../commons/vfs2/cache/AbstractFilesCache.java | 1 +
.../commons/vfs2/cache/DefaultFilesCache.java | 4 ++
.../commons/vfs2/cache/FileSystemAndNameKey.java | 1 +
.../apache/commons/vfs2/cache/LRUFilesCache.java | 2 +
.../apache/commons/vfs2/cache/NullFilesCache.java | 2 +
.../vfs2/cache/OnCallRefreshFileObject.java | 1 +
.../commons/vfs2/cache/SoftRefFilesCache.java | 1 +
.../commons/vfs2/cache/WeakRefFilesCache.java | 1 +
.../vfs2/events/AbstractFileChangeEvent.java | 1 +
.../apache/commons/vfs2/events/ChangedEvent.java | 1 +
.../apache/commons/vfs2/events/CreateEvent.java | 1 +
.../apache/commons/vfs2/events/DeleteEvent.java | 1 +
.../apache/commons/vfs2/filter/AgeFileFilter.java | 2 +
.../commons/vfs2/filter/CanExecuteFileFilter.java | 2 +
.../commons/vfs2/filter/CanReadFileFilter.java | 3 +
.../commons/vfs2/filter/CanWriteFileFilter.java | 3 +
.../commons/vfs2/filter/DirectoryFileFilter.java | 1 +
.../commons/vfs2/filter/EmptyFileFilter.java | 3 +
.../apache/commons/vfs2/filter/FileFileFilter.java | 1 +
.../commons/vfs2/filter/HiddenFileFilter.java | 2 +
.../apache/commons/vfs2/filter/NameFileFilter.java | 2 +
.../commons/vfs2/filter/PrefixFileFilter.java | 1 +
.../apache/commons/vfs2/filter/SizeFileFilter.java | 3 +
.../commons/vfs2/filter/SuffixFileFilter.java | 3 +-
.../org/apache/commons/vfs2/impl/FileTypeMap.java | 2 +
.../vfs2/impl/PrivilegedFileReplicator.java | 1 +
.../commons/vfs2/impl/ProviderConfiguration.java | 1 +
.../org/apache/commons/vfs2/impl/Resource.java | 1 +
.../vfs2/impl/StandardFileSystemManager.java | 2 +
.../commons/vfs2/impl/SynchronizedFileObject.java | 1 +
.../commons/vfs2/impl/URLStreamHandlerProxy.java | 1 +
.../apache/commons/vfs2/impl/VFSClassLoader.java | 2 +
.../apache/commons/vfs2/impl/VirtualFileName.java | 3 +-
.../commons/vfs2/impl/VirtualFileProvider.java | 2 +
.../commons/vfs2/impl/VirtualFileSystem.java | 1 +
.../vfs2/operations/AbstractFileOperation.java | 1 +
.../commons/vfs2/operations/FileOperation.java | 2 +-
.../apache/commons/vfs2/operations/vcs/VcsAdd.java | 1 +
.../commons/vfs2/operations/vcs/VcsCheckout.java | 1 +
.../vfs2/operations/vcs/VcsCommitListener.java | 1 +
.../commons/vfs2/operations/vcs/VcsDelete.java | 1 +
.../apache/commons/vfs2/operations/vcs/VcsLog.java | 1 +
.../commons/vfs2/operations/vcs/VcsLogEntry.java | 1 +
.../vfs2/operations/vcs/VcsLogEntryHandler.java | 1 +
.../vfs2/operations/vcs/VcsModifyListener.java | 1 +
.../commons/vfs2/operations/vcs/VcsRevert.java | 1 +
.../commons/vfs2/operations/vcs/VcsStatus.java | 1 +
.../commons/vfs2/operations/vcs/VcsUpdate.java | 1 +
.../vfs2/operations/vcs/VcsUpdateListener.java | 1 +
.../commons/vfs2/provider/AbstractFileName.java | 3 +
.../vfs2/provider/AbstractFileNameParser.java | 1 +
.../commons/vfs2/provider/AbstractFileObject.java | 47 +++++++++++--
.../vfs2/provider/AbstractFileProvider.java | 2 +
.../commons/vfs2/provider/AbstractFileSystem.java | 1 +
.../vfs2/provider/AbstractLayeredFileProvider.java | 2 +
.../provider/AbstractOriginatingFileProvider.java | 1 +
.../vfs2/provider/AbstractRandomAccessContent.java | 1 +
.../AbstractRandomAccessStreamContent.java | 1 +
.../vfs2/provider/AbstractVfsComponent.java | 1 +
.../vfs2/provider/AbstractVfsContainer.java | 2 +
.../vfs2/provider/CompositeFileProvider.java | 1 +
.../commons/vfs2/provider/DefaultFileContent.java | 1 +
.../vfs2/provider/DefaultURLConnection.java | 1 +
.../commons/vfs2/provider/DelegateFileObject.java | 2 +
.../vfs2/provider/FileContentThreadData.java | 1 +
.../commons/vfs2/provider/FileNameParser.java | 3 +-
.../apache/commons/vfs2/provider/FileProvider.java | 8 ++-
.../commons/vfs2/provider/FileReplicator.java | 2 +
.../commons/vfs2/provider/GenericFileName.java | 1 +
.../commons/vfs2/provider/GenericURLFileName.java | 12 ++--
.../vfs2/provider/GenericURLFileNameParser.java | 1 +
.../commons/vfs2/provider/HostFileNameParser.java | 1 +
.../commons/vfs2/provider/LayeredFileName.java | 3 +-
.../vfs2/provider/LayeredFileNameParser.java | 5 +-
.../commons/vfs2/provider/LocalFileProvider.java | 2 +
.../commons/vfs2/provider/TemporaryFileStore.java | 1 +
.../apache/commons/vfs2/provider/URLFileName.java | 11 +--
.../commons/vfs2/provider/URLFileNameParser.java | 1 +
.../apache/commons/vfs2/provider/UriParser.java | 3 +-
.../apache/commons/vfs2/provider/VfsComponent.java | 1 +
.../commons/vfs2/provider/VfsComponentContext.java | 1 +
.../vfs2/provider/bzip2/Bzip2FileProvider.java | 1 +
.../vfs2/provider/bzip2/Bzip2FileSystem.java | 1 +
.../compressed/CompressedFileFileObject.java | 1 +
.../compressed/CompressedFileFileProvider.java | 1 +
.../compressed/CompressedFileFileSystem.java | 1 +
.../vfs2/provider/ftp/FtpClientFactory.java | 1 +
.../vfs2/provider/ftp/FtpFileNameParser.java | 1 +
.../commons/vfs2/provider/ftp/FtpFileProvider.java | 1 +
.../commons/vfs2/provider/ftp/FtpFileSystem.java | 1 +
.../provider/ftp/FtpFileSystemConfigBuilder.java | 1 +
.../commons/vfs2/provider/ftp/FtpFileType.java | 1 +
.../vfs2/provider/ftp/FtpRandomAccessContent.java | 1 +
.../vfs2/provider/ftps/FtpsClientWrapper.java | 2 +
.../vfs2/provider/gzip/GzipFileProvider.java | 1 +
.../commons/vfs2/provider/gzip/GzipFileSystem.java | 1 +
.../vfs2/provider/hdfs/HdfsFileAttributes.java | 1 +
.../provider/hdfs/HdfsFileContentInfoFactory.java | 1 +
.../commons/vfs2/provider/hdfs/HdfsFileObject.java | 1 +
.../vfs2/provider/hdfs/HdfsFileProvider.java | 1 +
.../commons/vfs2/provider/hdfs/HdfsFileSystem.java | 1 +
.../provider/hdfs/HdfsFileSystemConfigBuilder.java | 5 ++
.../provider/hdfs/HdfsRandomAccessContent.java | 1 +
.../vfs2/provider/http/HttpClientFactory.java | 1 +
.../provider/http/HttpFileContentInfoFactory.java | 1 +
.../vfs2/provider/http/HttpFileNameParser.java | 1 +
.../commons/vfs2/provider/http/HttpFileObject.java | 5 ++
.../vfs2/provider/http/HttpFileProvider.java | 1 +
.../commons/vfs2/provider/http/HttpFileSystem.java | 1 +
.../provider/http/HttpFileSystemConfigBuilder.java | 9 ++-
.../provider/http/HttpRandomAccessContent.java | 1 +
.../vfs2/provider/http4/Http4FileObject.java | 5 ++
.../vfs2/provider/http4/Http4FileProvider.java | 4 ++
.../vfs2/provider/http4/Http4FileSystem.java | 4 ++
.../http4/Http4FileSystemConfigBuilder.java | 8 ++-
.../vfs2/provider/https/HttpsFileProvider.java | 1 +
.../commons/vfs2/provider/jar/JarFileObject.java | 1 +
.../commons/vfs2/provider/jar/JarFileProvider.java | 1 +
.../vfs2/provider/jar/JarURLConnectionImpl.java | 1 +
.../provider/local/DefaultLocalFileProvider.java | 1 +
.../vfs2/provider/local/GenericFileNameParser.java | 1 +
.../commons/vfs2/provider/local/LocalFile.java | 1 +
.../commons/vfs2/provider/local/LocalFileName.java | 1 +
.../vfs2/provider/local/LocalFileNameParser.java | 1 +
.../local/LocalFileRandomAccessContent.java | 1 +
.../vfs2/provider/local/LocalFileSystem.java | 1 +
.../vfs2/provider/local/WindowsFileName.java | 1 +
.../vfs2/provider/local/WindowsFileNameParser.java | 1 +
.../commons/vfs2/provider/ram/RamFileData.java | 1 +
.../commons/vfs2/provider/ram/RamFileObject.java | 1 +
.../commons/vfs2/provider/ram/RamFileProvider.java | 1 +
.../provider/ram/RamFileRandomAccessContent.java | 1 +
.../commons/vfs2/provider/ram/RamFileSystem.java | 1 +
.../vfs2/provider/res/ResourceFileProvider.java | 1 +
.../res/ResourceFileSystemConfigBuilder.java | 1 +
.../commons/vfs2/provider/sftp/IdentityInfo.java | 5 ++
.../provider/sftp/IdentityRepositoryFactory.java | 1 -
.../vfs2/provider/sftp/SftpFileNameParser.java | 1 +
.../commons/vfs2/provider/sftp/SftpFileObject.java | 1 +
.../vfs2/provider/sftp/SftpFileProvider.java | 1 +
.../provider/sftp/SftpRandomAccessContent.java | 1 +
.../commons/vfs2/provider/tar/TarFileObject.java | 1 +
.../commons/vfs2/provider/tar/TarFileProvider.java | 1 +
.../commons/vfs2/provider/tar/TarFileSystem.java | 1 +
.../vfs2/provider/tar/Tbz2FileProvider.java | 1 +
.../commons/vfs2/provider/tar/TgzFileProvider.java | 1 +
.../vfs2/provider/temp/TemporaryFileProvider.java | 1 +
.../commons/vfs2/provider/url/UrlFileName.java | 1 +
.../vfs2/provider/url/UrlFileNameParser.java | 3 +
.../commons/vfs2/provider/url/UrlFileObject.java | 2 +
.../commons/vfs2/provider/url/UrlFileProvider.java | 1 +
.../commons/vfs2/provider/url/UrlFileSystem.java | 1 +
.../vfs2/provider/webdav/ExceptionConverter.java | 1 +
.../webdav/WebdavFileContentInfoFactory.java | 1 +
.../vfs2/provider/webdav/WebdavFileNameParser.java | 1 +
.../vfs2/provider/webdav/WebdavFileObject.java | 2 +
.../vfs2/provider/webdav/WebdavFileProvider.java | 1 +
.../vfs2/provider/webdav/WebdavFileSystem.java | 1 +
.../webdav/WebdavFileSystemConfigBuilder.java | 1 +
.../provider/webdav/WebdavMethodRetryHandler.java | 2 +
.../commons/vfs2/provider/zip/ZipFileObject.java | 1 +
.../commons/vfs2/provider/zip/ZipFileProvider.java | 1 +
.../commons/vfs2/provider/zip/ZipFileSystem.java | 1 +
.../commons/vfs2/tasks/AbstractSyncTask.java | 22 ++++--
.../org/apache/commons/vfs2/tasks/CopyTask.java | 2 +
.../org/apache/commons/vfs2/tasks/DeleteTask.java | 1 +
.../org/apache/commons/vfs2/tasks/MkdirTask.java | 1 +
.../org/apache/commons/vfs2/tasks/MoveTask.java | 1 +
.../apache/commons/vfs2/tasks/ShowFileTask.java | 1 +
.../org/apache/commons/vfs2/tasks/SyncTask.java | 1 +
.../org/apache/commons/vfs2/tasks/VfsTask.java | 1 +
.../commons/vfs2/util/CombinedResources.java | 1 +
.../java/org/apache/commons/vfs2/util/Cryptor.java | 1 +
.../apache/commons/vfs2/util/CryptorFactory.java | 1 +
.../apache/commons/vfs2/util/DefaultCryptor.java | 1 +
.../util/DelegatingFileSystemOptionsBuilder.java | 36 ++++++----
.../org/apache/commons/vfs2/util/EncryptUtil.java | 1 +
.../org/apache/commons/vfs2/util/Messages.java | 1 +
.../commons/vfs2/util/MonitorInputStream.java | 1 +
.../commons/vfs2/util/MonitorOutputStream.java | 3 +
.../vfs2/util/MonitorRandomAccessContent.java | 1 +
.../main/java/org/apache/commons/vfs2/util/Os.java | 1 +
.../org/apache/commons/vfs2/util/OsFamily.java | 1 +
.../apache/commons/vfs2/util/RandomAccessMode.java | 1 +
.../org/apache/commons/vfs2/util/URIBitSets.java | 79 +++++++++++-----------
.../org/apache/commons/vfs2/util/URIUtils.java | 9 ++-
.../commons/vfs2/util/UserAuthenticatorUtils.java | 1 +
.../commons/vfs2/util/WeakRefFileListener.java | 2 +
.../commons/vfs2/filter/AgeFileFilterTest.java | 4 +-
.../commons/vfs2/filter/AndFileFilterTest.java | 4 +-
.../apache/commons/vfs2/filter/BaseFilterTest.java | 50 +++++++-------
.../vfs2/filter/CanExecuteFileFilterTest.java | 4 +-
.../commons/vfs2/filter/CanReadFileFilterTest.java | 4 +-
.../vfs2/filter/CanWriteFileFilterTest.java | 4 +-
.../vfs2/filter/DirectoryAndFileFilterTest.java | 4 +-
.../commons/vfs2/filter/EmptyFileFilterTest.java | 4 +-
.../commons/vfs2/filter/HiddenFileFilterTest.java | 4 +-
.../commons/vfs2/filter/NameFileFilterTest.java | 4 +-
.../commons/vfs2/filter/NotFileFilterTest.java | 4 +-
.../commons/vfs2/filter/OrFileFilterTest.java | 4 +-
.../commons/vfs2/filter/PrefixFileFilterTest.java | 4 +-
.../vfs2/filter/RegexFileFilterTestCase.java | 4 +-
.../commons/vfs2/filter/SizeFileFilterTest.java | 4 +-
.../commons/vfs2/filter/SuffixFileFilterTest.java | 4 +-
.../vfs2/filter/WildcardFileFilterTest.java | 4 +-
.../vfs2/impl/test/DefaultFileMonitorTests.java | 1 +
.../impl/test/DefaultFileSystemManagerTest.java | 1 +
.../vfs2/impl/test/VfsClassLoaderTests.java | 3 +
.../provider/ram/test/CustomRamProviderTest.java | 2 +-
.../vfs2/test/AbstractProviderTestCase.java | 5 +-
212 files changed, 468 insertions(+), 156 deletions(-)
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/VfsLog.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/VfsLog.java
index 4695820..f64d1b8 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/VfsLog.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/VfsLog.java
@@ -19,7 +19,7 @@ package org.apache.commons.vfs2;
import org.apache.commons.logging.Log;
/**
- * This class is to keep the old logging behaviour (for ant-task) and to be able to correctly use commons-logging.<br>
+ * This class is to keep the old logging behaviour (for ant-task) and to be able to correctly use commons-logging.
* I hope i could remove it sometimes.
*/
public final class VfsLog {
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/auth/StaticUserAuthenticator.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/auth/StaticUserAuthenticator.java
index 1f97d3f..43adb33 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/auth/StaticUserAuthenticator.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/auth/StaticUserAuthenticator.java
@@ -26,6 +26,7 @@ import org.apache.commons.vfs2.util.UserAuthenticatorUtils;
* Provides always the same credentials data passed in with the constructor.
*/
public class StaticUserAuthenticator implements UserAuthenticator, Comparable<StaticUserAuthenticator> {
+
private static final Log LOG = LogFactory.getLog(StaticUserAuthenticator.class);
/** The user name */
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/AbstractFilesCache.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/AbstractFilesCache.java
index 531f4e6..18073e0 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/AbstractFilesCache.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/AbstractFilesCache.java
@@ -24,6 +24,7 @@ import org.apache.commons.vfs2.provider.AbstractVfsComponent;
* Abstract base class for FilesCache implementations.
*/
public abstract class AbstractFilesCache extends AbstractVfsComponent implements FilesCache {
+
// @Override - commented in FilesCache interface
public void touchFile(final FileObject file) {
}
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 cfcdb18..0415409 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
@@ -30,16 +30,20 @@ import org.apache.commons.vfs2.FileSystem;
* This implementation caches every file with no expire or limit. All files and filesystems are hard reachable
* references. This implementation holds a list of filesystem specific {@linkplain ConcurrentHashMap ConcurrentHashMaps}
* in the main cache map.
+ * </p>
* <p>
* Cached {@linkplain FileObject FileObjects} as well as {@linkplain FileSystem FileSystems} are only removed when
* {@link #clear(FileSystem)} is called (i.e. on filesystem close). When the used
* {@link org.apache.commons.vfs2.FileSystemManager FileSystemManager} is closed, it will also {@linkplain #close()
* close} this cache (which frees all entries).
+ * </p>
* <p>
* Despite its name, this is not the fallback implementation used by
* {@link org.apache.commons.vfs2.impl.DefaultFileSystemManager#init() DefaultFileSystemManager#init()} anymore.
+ * </p>
*/
public class DefaultFilesCache extends AbstractFilesCache {
+
/** The FileSystem cache. Keeps one Map for each FileSystem. */
private final ConcurrentMap<FileSystem, ConcurrentMap<FileName, FileObject>> filesystemCache = new ConcurrentHashMap<>(
10);
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/FileSystemAndNameKey.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/FileSystemAndNameKey.java
index 5e68d4f..99ce7d7 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/FileSystemAndNameKey.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/FileSystemAndNameKey.java
@@ -23,6 +23,7 @@ import org.apache.commons.vfs2.FileSystem;
* Key for various cache implementations.
* <p>
* It compares the fileSystem (by hashCode) and the filename.
+ * </p>
*/
class FileSystemAndNameKey implements Comparable<FileSystemAndNameKey> {
/** The 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 6c0d58c..1e1ad58 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
@@ -38,8 +38,10 @@ import org.apache.commons.vfs2.util.Messages;
* This implementation caches every file using {@link LRUMap}.
* <p>
* The default constructor uses a LRU size of 100 per filesystem.
+ * </p>
*/
public class LRUFilesCache extends AbstractFilesCache {
+
/** The default LRU size */
private static final int DEFAULT_LRU_SIZE = 100;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/NullFilesCache.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/NullFilesCache.java
index f6d9b49..717feb6 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/NullFilesCache.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/NullFilesCache.java
@@ -24,9 +24,11 @@ import org.apache.commons.vfs2.FileSystem;
* A {@link org.apache.commons.vfs2.FilesCache} implementation.
* <p>
* This implementation never ever caches a single file.
+ * </p>
* <p>
* <b>Notice</b>: if you use resolveFile(uri) multiple times with the same path, the system will always create a new
* instance. Changes on one instance of this file are not seen by the others.
+ * </p>
*/
public class NullFilesCache extends AbstractFilesCache {
@Override
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/OnCallRefreshFileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/OnCallRefreshFileObject.java
index 3570798..1a041b7 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/OnCallRefreshFileObject.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/OnCallRefreshFileObject.java
@@ -30,6 +30,7 @@ import org.apache.commons.vfs2.impl.DecoratedFileObject;
* This decorator refreshes the fileObject data on every call.
*/
public class OnCallRefreshFileObject extends DecoratedFileObject {
+
public OnCallRefreshFileObject(final FileObject fileObject) {
super(fileObject);
}
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 f8ca6c0..d96a35e 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
@@ -42,6 +42,7 @@ import org.apache.commons.vfs2.util.Messages;
* @see SoftReference
*/
public class SoftRefFilesCache extends AbstractFilesCache {
+
private static final int TIMEOUT = 1000;
private static final Log log = LogFactory.getLog(SoftRefFilesCache.class);
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/WeakRefFilesCache.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/WeakRefFilesCache.java
index 8acf7db..f8a90e5 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/WeakRefFilesCache.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/WeakRefFilesCache.java
@@ -30,6 +30,7 @@ import org.apache.commons.vfs2.FileObject;
* @see java.lang.ref.WeakReference
*/
public class WeakRefFilesCache extends SoftRefFilesCache {
+
@Override
protected Reference<FileObject> createReference(final FileObject file, final ReferenceQueue<FileObject> refqueue) {
return new WeakReference<>(file, refqueue);
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/AbstractFileChangeEvent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/AbstractFileChangeEvent.java
index 5c9605d..7db6728 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/AbstractFileChangeEvent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/AbstractFileChangeEvent.java
@@ -24,6 +24,7 @@ import org.apache.commons.vfs2.FileObject;
* A change event that knows how to notify a listener.
*/
public abstract class AbstractFileChangeEvent extends FileChangeEvent {
+
public AbstractFileChangeEvent(final FileObject file) {
super(file);
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/ChangedEvent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/ChangedEvent.java
index fada372..5445be7 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/ChangedEvent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/ChangedEvent.java
@@ -23,6 +23,7 @@ import org.apache.commons.vfs2.FileObject;
* File changed event.
*/
public class ChangedEvent extends AbstractFileChangeEvent {
+
public ChangedEvent(final FileObject file) {
super(file);
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/CreateEvent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/CreateEvent.java
index f747b87..c428785 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/CreateEvent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/CreateEvent.java
@@ -23,6 +23,7 @@ import org.apache.commons.vfs2.FileObject;
* File creation event.
*/
public class CreateEvent extends AbstractFileChangeEvent {
+
public CreateEvent(final FileObject file) {
super(file);
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/DeleteEvent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/DeleteEvent.java
index 9e82b19..ef23119 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/DeleteEvent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/events/DeleteEvent.java
@@ -23,6 +23,7 @@ import org.apache.commons.vfs2.FileObject;
* File deletion event.
*/
public class DeleteEvent extends AbstractFileChangeEvent {
+
public DeleteEvent(final FileObject file) {
super(file);
}
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 698f56f..aed9efd 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
@@ -31,6 +31,7 @@ import org.apache.commons.vfs2.FileSystemException;
* <p>
* For example, to print all files and directories in the current directory
* older than one day:
+ * </p>
*
* <pre>
* FileSystemManager fsManager = VFS.getManager();
@@ -165,6 +166,7 @@ public class AgeFileFilter implements FileFilter, Serializable {
* If last modification time equals cutoff and newer files are required, file
* <b>IS NOT</b> selected. If last modification time equals cutoff and older
* files are required, file <b>IS</b> selected.
+ * </p>
*
* @param fileInfo the File to check
*
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanExecuteFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanExecuteFileFilter.java
index 3fec2fd..101fd35 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanExecuteFileFilter.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanExecuteFileFilter.java
@@ -27,6 +27,7 @@ import org.apache.commons.vfs2.FileSystemException;
* <p>
* Example, showing how to print out a list of the current directory's
* <i>executable</i> files:
+ * </p>
*
* <pre>
* FileSystemManager fsManager = VFS.getManager();
@@ -40,6 +41,7 @@ import org.apache.commons.vfs2.FileSystemException;
* <p>
* Example, showing how to print out a list of the current directory's
* <i>un-executable</i> files:
+ * </p>
*
* <pre>
* FileSystemManager fsManager = VFS.getManager();
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanReadFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanReadFileFilter.java
index 47b11d4..c7f2c01 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanReadFileFilter.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanReadFileFilter.java
@@ -27,6 +27,7 @@ import org.apache.commons.vfs2.FileSystemException;
* <p>
* Example, showing how to print out a list of the current directory's
* <i>readable</i> files:
+ * </p>
*
* <pre>
* FileSystemManager fsManager = VFS.getManager();
@@ -40,6 +41,7 @@ import org.apache.commons.vfs2.FileSystemException;
* <p>
* Example, showing how to print out a list of the current directory's
* <i>un-readable</i> files:
+ * </p>
*
* <pre>
* FileSystemManager fsManager = VFS.getManager();
@@ -53,6 +55,7 @@ import org.apache.commons.vfs2.FileSystemException;
* <p>
* Example, showing how to print out a list of the current directory's
* <i>read-only</i> files:
+ * </p>
*
* <pre>
* FileSystemManager fsManager = VFS.getManager();
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanWriteFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanWriteFileFilter.java
index e1d2905..60c71db 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanWriteFileFilter.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanWriteFileFilter.java
@@ -29,6 +29,7 @@ import org.apache.commons.vfs2.FileSystemException;
* <p>
* Example, showing how to print out a list of the current directory's
* <i>writable</i> files:
+ * </p>
*
* <pre>
* FileSystemManager fsManager = VFS.getManager();
@@ -42,6 +43,7 @@ import org.apache.commons.vfs2.FileSystemException;
* <p>
* Example, showing how to print out a list of the current directory's
* <i>un-writable</i> files:
+ * </p>
*
* <pre>
* FileSystemManager fsManager = VFS.getManager();
@@ -55,6 +57,7 @@ import org.apache.commons.vfs2.FileSystemException;
* <p>
* <b>N.B.</b> For read-only files, use
* <code>CanReadFileFilter.READ_ONLY</code>.
+ * </p>
*
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/"
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/DirectoryFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/DirectoryFileFilter.java
index 7aed4fe..34b3acb 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/DirectoryFileFilter.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/DirectoryFileFilter.java
@@ -28,6 +28,7 @@ import org.apache.commons.vfs2.FileType;
* <p>
* For example, here is how to print out a list of the current directory's sub
* directories:
+ * </p>
*
* <pre>
* FileSystemManager fsManager = VFS.getManager();
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/EmptyFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/EmptyFileFilter.java
index 1b22360..a36a7a1 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/EmptyFileFilter.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/EmptyFileFilter.java
@@ -29,8 +29,10 @@ import org.apache.commons.vfs2.FileType;
* This filter accepts files or directories that are empty.
* <p>
* If the <code>File</code> is a directory it checks that it contains no files.
+ * </p>
* <p>
* Example, showing how to print out a list of the current directory's empty files/directories:
+ * </p>
*
* <pre>
* FileSystemManager fsManager = VFS.getManager();
@@ -43,6 +45,7 @@ import org.apache.commons.vfs2.FileType;
*
* <p>
* Example, showing how to print out a list of the current directory's non-empty files/directories:
+ * </p>
*
* <pre>
* FileSystemManager fsManager = VFS.getManager();
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FileFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FileFileFilter.java
index f3e1393..294b23c 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FileFileFilter.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FileFileFilter.java
@@ -28,6 +28,7 @@ import org.apache.commons.vfs2.FileType;
* <p>
* For example, here is how to print out a list of the real files within the
* current directory:
+ * </p>
*
* <pre>
* FileSystemManager fsManager = VFS.getManager();
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/HiddenFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/HiddenFileFilter.java
index 98ecc91..f8ff229 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/HiddenFileFilter.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/HiddenFileFilter.java
@@ -27,6 +27,7 @@ import org.apache.commons.vfs2.FileSystemException;
* <p>
* Example, showing how to print out a list of the current directory's
* <i>hidden</i> files:
+ * </p>
*
* <pre>
* FileSystemManager fsManager = VFS.getManager();
@@ -40,6 +41,7 @@ import org.apache.commons.vfs2.FileSystemException;
* <p>
* Example, showing how to print out a list of the current directory's
* <i>visible</i> (i.e. not hidden) files:
+ * </p>
*
* <pre>
* FileSystemManager fsManager = VFS.getManager();
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 0f09d88..92f7e3b 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
@@ -29,6 +29,7 @@ import org.apache.commons.vfs2.FileSelectInfo;
* <p>
* For example, to print all files and directories in the current directory
* whose name is <code>Test</code>:
+ * </p>
*
* <pre>
* FileSystemManager fsManager = VFS.getManager();
@@ -83,6 +84,7 @@ public class NameFileFilter implements FileFilter, Serializable {
* <p>
* The array is not cloned, so could be changed after constructing the instance.
* This would be inadvisable however.
+ * </p>
*
* @param names the names to allow, must not be null
*/
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 c3e2578..89bdf76 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
@@ -29,6 +29,7 @@ import org.apache.commons.vfs2.FileSelectInfo;
* <p>
* For example, to print all files and directories in the current directory
* whose name starts with a <code>.</code>:
+ * </p>
*
* <pre>
* FileSystemManager fsManager = VFS.getManager();
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 ba275b3..36da137 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
@@ -30,6 +30,7 @@ import org.apache.commons.vfs2.FileSystemException;
* <p>
* For example, to print all files and directories in the current directory
* whose size is greater than 1 MB:
+ * </p>
*
* <pre>
* FileSystemManager fsManager = VFS.getManager();
@@ -87,8 +88,10 @@ public class SizeFileFilter implements FileFilter, Serializable {
* If size equals threshold and smaller files are required, file <b>IS NOT</b>
* selected. If size equals threshold and larger files are required, file
* <b>IS</b> selected.
+ * </p>
* <p>
* Non-existing files return always false (will never be accepted).
+ * </p>
*
* @param fileInfo the File to check
*
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 fb1e3da..4b6c918 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
@@ -30,6 +30,7 @@ import org.apache.commons.vfs2.FileSelectInfo;
* <p>
* For example, to retrieve and print all <code>*.java</code> files in the
* current directory:
+ * </p>
*
* <pre>
* FileSystemManager fsManager = VFS.getManager();
@@ -123,7 +124,7 @@ public class SuffixFileFilter implements FileFilter, Serializable {
}
/**
- * Provide a String representation of this file filter.
+ * Provides a String representation of this file filter.
*
* @return a String representation
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/FileTypeMap.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/FileTypeMap.java
index 10b7665..f28aa68 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/FileTypeMap.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/FileTypeMap.java
@@ -27,6 +27,7 @@ import org.apache.commons.vfs2.FileSystemException;
* A helper class that determines the provider to use for a file.
*/
class FileTypeMap {
+
private final Map<String, String> mimeTypeMap = new HashMap<>();
private final Map<String, String> extensionMap = new HashMap<>();
@@ -48,6 +49,7 @@ class FileTypeMap {
* Find the scheme for the provider of a layered file system.
* <p>
* This will check the FileContentInfo or file extension.
+ * </p>
*
* @return Scheme supporting the file type or null (if unknonw).
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/PrivilegedFileReplicator.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/PrivilegedFileReplicator.java
index 4ad6a6c..55f7060 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/PrivilegedFileReplicator.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/PrivilegedFileReplicator.java
@@ -34,6 +34,7 @@ import org.apache.commons.vfs2.provider.VfsComponentContext;
* A file replicator that wraps another file replicator, performing the replication as a privileged action.
*/
public class PrivilegedFileReplicator implements FileReplicator, VfsComponent {
+
private final FileReplicator replicator;
private final VfsComponent replicatorComponent;
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 6170db0..6162e1b 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
@@ -23,6 +23,7 @@ import java.util.List;
* This class describes the configuration for a provider.
* <p>
* Used by digester in StandardFileSystemManager
+ * </p>
*/
public class ProviderConfiguration {
private String className;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/Resource.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/Resource.java
index 401d340..a41542b 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/Resource.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/Resource.java
@@ -30,6 +30,7 @@ import org.apache.commons.vfs2.FileUtil;
* @see VFSClassLoader
*/
class Resource {
+
private final FileObject root;
private final FileObject resource;
private final FileObject packageFolder;
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 3c63ee2..d033981 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
@@ -42,6 +42,7 @@ import org.w3c.dom.NodeList;
* <p>
* Certain providers are only loaded and available if the dependent library is in your classpath. You have to configure
* your debugging facility to log "debug" messages to see if a provider was skipped due to "unresolved externals".
+ * </p>
*/
public class StandardFileSystemManager extends DefaultFileSystemManager {
private static final String CONFIG_RESOURCE = "providers.xml";
@@ -111,6 +112,7 @@ public class StandardFileSystemManager extends DefaultFileSystemManager {
* Scans the classpath to find any droped plugin.
* <p>
* The plugin-description has to be in {@code /META-INF/vfs-providers.xml}.
+ * </p>
*
* @throws FileSystemException if an error occurs.
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/SynchronizedFileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/SynchronizedFileObject.java
index 7cb1146..7a0657f 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/SynchronizedFileObject.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/SynchronizedFileObject.java
@@ -29,6 +29,7 @@ import org.apache.commons.vfs2.NameScope;
* This decorator synchronize all access to the FileObject.
*/
public class SynchronizedFileObject extends DecoratedFileObject {
+
public SynchronizedFileObject(final FileObject fileObject) {
super(fileObject);
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/URLStreamHandlerProxy.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/URLStreamHandlerProxy.java
index 55b1ec2..c893f72 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/URLStreamHandlerProxy.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/URLStreamHandlerProxy.java
@@ -26,6 +26,7 @@ import java.net.URLStreamHandler;
* A proxy for URLs that are supported by the standard stream handler factory.
*/
class URLStreamHandlerProxy extends URLStreamHandler {
+
@Override
protected URLConnection openConnection(final URL url) throws IOException {
final URL proxyURL = new URL(url.toExternalForm());
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/VFSClassLoader.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/VFSClassLoader.java
index 613894e..5209a4d 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/VFSClassLoader.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/VFSClassLoader.java
@@ -43,8 +43,10 @@ import org.apache.commons.vfs2.util.FileObjectUtils;
* <p>
* The search path can consist of VFS FileObjects referring both to folders and JAR files. Any FileObject of type
* FileType.FILE is assumed to be a JAR and is opened by creating a layered file system with the "jar" scheme.
+ * </p>
* <p>
* TODO - Test this with signed Jars and a SecurityManager.
+ * </p>
*
* @see FileSystemManager#createFileSystem
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/VirtualFileName.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/VirtualFileName.java
index 543b5a4..da228f4 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/VirtualFileName.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/VirtualFileName.java
@@ -21,9 +21,10 @@ import org.apache.commons.vfs2.FileType;
import org.apache.commons.vfs2.provider.AbstractFileName;
/**
- * A simple Filename to hold the scheme for to be created virtual filesytsem.
+ * A simple Filename to hold the scheme for to be created virtual file system.
*/
public class VirtualFileName extends AbstractFileName {
+
public VirtualFileName(final String scheme, final String absPath, final FileType type) {
super(scheme, absPath, type);
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/VirtualFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/VirtualFileProvider.java
index 6d731f2..26853e5 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/VirtualFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/VirtualFileProvider.java
@@ -29,6 +29,7 @@ import org.apache.commons.vfs2.provider.AbstractVfsContainer;
* A virtual filesystem provider.
*/
public class VirtualFileProvider extends AbstractVfsContainer {
+
/**
* Creates a virtual file system, with the supplied file as its root.
*
@@ -63,6 +64,7 @@ public class VirtualFileProvider extends AbstractVfsContainer {
* Close a VirtualFileSystem by removing it from the {@code #components} list of this provider.
* <p>
* This gets called from DefaultFileManager#_closeFileSystem.
+ * </p>
*
* @param filesystem the file system remembered by this provider.
*/
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 37008ef..a59b7fe 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
@@ -35,6 +35,7 @@ import org.apache.commons.vfs2.provider.DelegateFileObject;
* A logical file system, made up of set of junctions, or links, to files from other file systems.
* <p>
* TODO - Handle nested junctions.
+ * <p>
*/
public class VirtualFileSystem extends AbstractFileSystem {
private final Map<FileName, FileObject> junctions = new HashMap<>();
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 672b3f8..b7b93e6 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
@@ -23,6 +23,7 @@ import org.apache.commons.vfs2.FileObject;
* @since 0.1
*/
public abstract class AbstractFileOperation implements FileOperation {
+
/**
* FileObject which the FileOperation is operate on.
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperation.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperation.java
index 1a648d0..a3cdc36 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperation.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperation.java
@@ -32,10 +32,10 @@ import org.apache.commons.vfs2.FileSystemException;
* </p>
* <p>
* FileOperation is provided by
+ * </p>
*
* @see FileOperationProvider Especially the FileOperationProvider is responsible for looking up and instantiating any
* concrete FileOperation.
- * </p>
*
* @since 0.1
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsAdd.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsAdd.java
index 74ae73c..198fdb6 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsAdd.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsAdd.java
@@ -23,6 +23,7 @@ import org.apache.commons.vfs2.operations.FileOperation;
* @since 0.1
*/
public interface VcsAdd extends FileOperation {
+
/**
*
* @param makedir true if directories should be created, false otherwise.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsCheckout.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsCheckout.java
index fc3d807..7fca97e 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsCheckout.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsCheckout.java
@@ -24,6 +24,7 @@ import org.apache.commons.vfs2.operations.FileOperation;
* @since 0.1
*/
public interface VcsCheckout extends FileOperation {
+
/**
*
* @param revision The revision number.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsCommitListener.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsCommitListener.java
index 93935f8..e5f8384 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsCommitListener.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsCommitListener.java
@@ -21,6 +21,7 @@ package org.apache.commons.vfs2.operations.vcs;
* @since 0.1
*/
public interface VcsCommitListener {
+
/**
*
* @param path The path.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsDelete.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsDelete.java
index 0750103..8bba91b 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsDelete.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsDelete.java
@@ -23,6 +23,7 @@ import org.apache.commons.vfs2.operations.FileOperation;
* @since 0.1
*/
public interface VcsDelete extends FileOperation {
+
/**
*
* @param force true if the delete should be unconditional.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsLog.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsLog.java
index 5f51b95..94c6740 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsLog.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsLog.java
@@ -23,6 +23,7 @@ import org.apache.commons.vfs2.operations.FileOperation;
* @since 0.1
*/
public interface VcsLog extends FileOperation {
+
/**
*
* @param startRev The start revision.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsLogEntry.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsLogEntry.java
index 9f59b3b..358d342 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsLogEntry.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsLogEntry.java
@@ -23,6 +23,7 @@ import java.util.Calendar;
* @since 0.1
*/
public class VcsLogEntry {
+
/**
*/
private final String author;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsLogEntryHandler.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsLogEntryHandler.java
index c96404d..acf97a3 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsLogEntryHandler.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsLogEntryHandler.java
@@ -23,6 +23,7 @@ import org.apache.commons.vfs2.FileSystemException;
* @since 0.1
*/
public interface VcsLogEntryHandler {
+
/**
*
* @param entry The log entry.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsModifyListener.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsModifyListener.java
index b1be421..6133b9d 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsModifyListener.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsModifyListener.java
@@ -21,6 +21,7 @@ package org.apache.commons.vfs2.operations.vcs;
* @since 0.1
*/
public interface VcsModifyListener {
+
/**
*
* @param path The path String.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsRevert.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsRevert.java
index d852cb6..9b52470 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsRevert.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsRevert.java
@@ -27,6 +27,7 @@ import org.apache.commons.vfs2.operations.FileOperation;
* @since 0.1
*/
public interface VcsRevert extends FileOperation {
+
/**
*
* @param recursive true if children should be processed.
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 595106f..4bf621c 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
@@ -21,6 +21,7 @@ package org.apache.commons.vfs2.operations.vcs;
* @since 0.1
*/
public enum VcsStatus {
+
UNKNOWN(-1), NOT_MODIFIED(0), ADDED(1), CONFLICTED(2), DELETED(3), MERGED(4), IGNORED(5), MODIFIED(6), REPLACED(
7), UNVERSIONED(8), MISSING(9), OBSTRUCTED(10), REVERTED(11), RESOLVED(12), COPIED(
13), MOVED(14), RESTORED(15), UPDATED(16), EXTERNAL(18), CORRUPTED(19), NOT_REVERTED(20);
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsUpdate.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsUpdate.java
index 16d45ca..7f63d0a 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsUpdate.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsUpdate.java
@@ -23,6 +23,7 @@ import org.apache.commons.vfs2.operations.FileOperation;
* @since 0.1
*/
public interface VcsUpdate extends FileOperation {
+
/**
*
* @param revision The revision number.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsUpdateListener.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsUpdateListener.java
index b70c66e..7fc830e 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsUpdateListener.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsUpdateListener.java
@@ -21,6 +21,7 @@ package org.apache.commons.vfs2.operations.vcs;
* @since 0.1
*/
public interface VcsUpdateListener {
+
/**
*
* @param path The path.
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 6114985..8b67980 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
@@ -26,6 +26,7 @@ import org.apache.commons.vfs2.VFS;
* A default file name implementation.
*/
public abstract class AbstractFileName implements FileName {
+
// URI Characters that are possible in local filenames, but must be escaped
// for proper URI handling.
//
@@ -458,8 +459,10 @@ public abstract class AbstractFileName implements FileName {
* <p>
* The "requested" type is the one determined during resolving the name. n this case the name is a
* {@link FileType#FOLDER} if it ends with an "/" else it will be a {@link FileType#FILE}.
+ * </p>
* <p>
* Once attached it will be changed to reflect the real type of this resource.
+ * </p>
*
* @return {@link FileType#FOLDER} or {@link FileType#FILE}
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileNameParser.java
index e6c4bf5..f009eca 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileNameParser.java
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2.provider;
* Provides methods to parse a filename into a {@link org.apache.commons.vfs2.FileName}.
*/
public abstract class AbstractFileNameParser implements FileNameParser {
+
@Override
public boolean encodeCharacter(final char ch) {
return ch == '%';
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 ae229b5..4001e4e 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
@@ -59,12 +59,15 @@ import org.apache.commons.vfs2.util.RandomAccessMode;
* @param <AFS> An AbstractFileSystem subclass
*/
public abstract class AbstractFileObject<AFS extends AbstractFileSystem> implements FileObject {
+
/*
* TODO - Chop this class up - move all the protected methods to several interfaces, so that structure and content
* can be separately overridden.
*
+ * <p>
* TODO - Check caps in methods like getChildren(), etc, and give better error messages (eg 'this file type does not
* support listing children', vs 'this is not a folder')
+ * </p>
*/
private static final FileName[] EMPTY_FILE_ARRAY = {};
@@ -372,6 +375,7 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* Deletes this file.
* <p>
* TODO - This will not fail if this is a non-empty folder.
+ * </p>
*
* @return true if this object has been deleted
* @throws FileSystemException if an error occurs.
@@ -496,8 +500,10 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* <p>
* This method is called before any of the doBlah() or onBlah() methods. Sub-classes can use this method to perform
* lazy initialisation.
+ * </p>
* <p>
* This implementation does nothing.
+ * </p>
*
* @throws Exception if an error occurs.
*/
@@ -549,8 +555,10 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* <p>
* Called when this file is closed. Note that the file object may be reused later, so should be able to be
* reattached.
+ * </p>
* <p>
* This implementation does nothing.
+ * </p>
*
* @throws Exception if an error occurs.
*/
@@ -562,6 +570,7 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* {@link FileType#IMAGINARY}.
* <p>
* This implementation always returns an empty map.
+ * </p>
*
* @return The attributes of the file.
* @throws Exception if an error occurs.
@@ -575,6 +584,7 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* {@link FileType#IMAGINARY}.
* <p>
* This implementation always returns null.
+ * </p>
*
* @return The certificates used to sign the file.
* @throws Exception if an error occurs.
@@ -597,8 +607,10 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* {@link FileType#FILE}.
* <p>
* It is guaranteed that there are no open output streams for this file when this method is called.
+ * </p>
* <p>
* The returned stream does not have to be buffered.
+ * </p>
*
* @return An InputStream to read the file content.
* @throws Exception if an error occurs.
@@ -610,6 +622,7 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* {@link FileType#IMAGINARY}.
* <p>
* This implementation throws an exception.
+ * </p>
*
* @return The last modification time.
* @throws Exception if an error occurs.
@@ -628,8 +641,10 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* It is guaranteed that there are no open stream (input or output) for this file when this method is called.
* <p>
* The returned stream does not have to be buffered.
+ * </p>
* <p>
* This implementation throws an exception.
+ * </p>
*
* @param bAppend true if the file should be appended to, false if it should be overwritten.
* @return An OutputStream to write to the file.
@@ -643,6 +658,7 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* Creates access to the file for random i/o. Is only called if {@link #doGetType} returns {@link FileType#FILE}.
* <p>
* It is guaranteed that there are no open output streams for this file when this method is called.
+ * </p>
*
* @param mode The mode to access the file.
* @return The RandomAccessContext.
@@ -666,6 +682,7 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* {@link FileType#IMAGINARY}.
* <p>
* This implementation always returns false.
+ * </p>
*
* @return true if the file is executable, false otherwise.
* @throws Exception if an error occurs.
@@ -679,6 +696,7 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* {@link FileType#IMAGINARY}.
* <p>
* This implementation always returns false.
+ * </p>
*
* @return true if the file is hidden, false otherwise.
* @throws Exception if an error occurs.
@@ -692,6 +710,7 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* {@link FileType#IMAGINARY}.
* <p>
* This implementation always returns true.
+ * </p>
*
* @return true if the file is readable, false otherwise.
* @throws Exception if an error occurs.
@@ -717,6 +736,7 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* {@link FileType#IMAGINARY}.
* <p>
* This implementation always returns true.
+ * </p>
*
* @return true if the file is writable.
* @throws Exception if an error occurs.
@@ -739,11 +759,14 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* Lists the children of this file.
* <p>
* Is only called if {@link #doGetType} returns {@link FileType#FOLDER}.
+ * </p>
* <p>
- * The return value of this method is cached, so the implementation can be expensive.<br>
+ * The return value of this method is cached, so the implementation can be expensive.
* Other than {@code doListChildren} you could return FileObject's to e.g. reinitialize the type of the file.
+ * </p>
* <p>
* (Introduced for Webdav: "permission denied on resource" during getType())
+ * </p>
*
* @return The children of this FileObject.
* @throws Exception if an error occurs.
@@ -756,8 +779,10 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* Removes an attribute of this file.
* <p>
* Is only called if {@link #doGetType} does not return {@link FileType#IMAGINARY}.
+ * </p>
* <p>
* This implementation throws an exception.
+ * </p>
*
* @param attrName The name of the attribute to remove.
* @throws Exception if an error occurs.
@@ -771,11 +796,13 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* Renames the file.
* <p>
* Is only called when:
+ * </p>
* <ul>
* <li>{@link #doIsWriteable} returns true.</li>
* </ul>
* <p>
* This implementation throws an exception.
+ * </p>
*
* @param newFile A FileObject with the new file name.
* @throws Exception if an error occurs.
@@ -788,8 +815,10 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* Sets an attribute of this file.
* <p>
* Is only called if {@link #doGetType} does not return {@link FileType#IMAGINARY}.
+ * </p>
* <p>
* This implementation throws an exception.
+ * </p>
*
* @param attrName The attribute name.
* @param value The value to be associated with the attribute name.
@@ -803,8 +832,10 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* Make the file executable.
* <p>
* Only called if {@link #doGetType} does not return {@link FileType#IMAGINARY}.
+ * </p>
* <p>
* This implementation returns false.
+ * </p>
*
* @param executable True to allow access, false to disallow.
* @param ownerOnly If {@code true}, the permission applies only to the owner; otherwise, it applies to everybody.
@@ -821,8 +852,10 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* Sets the last modified time of this file.
* <p>
* Is only called if {@link #doGetType} does not return {@link FileType#IMAGINARY}.
+ * </p>
* <p>
* This implementation throws an exception.
+ * </p>
*
* @param modtime The last modification time.
* @return true if the time was set.
@@ -836,8 +869,10 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* Make the file or folder readable.
* <p>
* Only called if {@link #doGetType} does not return {@link FileType#IMAGINARY}.
+ * </p>
* <p>
* This implementation returns false.
+ * </p>
*
* @param readable True to allow access, false to disallow
* @param ownerOnly If {@code true}, the permission applies only to the owner; otherwise, it applies to everybody.
@@ -854,6 +889,7 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* Make the file or folder writeable.
* <p>
* Only called if {@link #doGetType} does not return {@link FileType#IMAGINARY}.
+ * </p>
*
* @param writable True to allow access, false to disallow
* @param ownerOnly If {@code true}, the permission applies only to the owner; otherwise, it applies to everybody.
@@ -1164,12 +1200,12 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
/**
* Prepares this file for writing. Makes sure it is either a file, or its parent folder exists. Returns an output
- * stream to use to write the content of the file to.<br>
+ * stream to use to write the content of the file to.
*
- * @param bAppend true when append to the file.<br>
+ * @param bAppend true when append to the file.
* Note: If the underlying filesystem does not support appending, a FileSystemException is thrown.
* @return An OutputStream where the new contents of the file can be written.
- * @throws FileSystemException if an error occurs; for example:<br>
+ * @throws FileSystemException if an error occurs; for example:
* bAppend is true, and the underlying FileSystem does not support it
*/
public OutputStream getOutputStream(final boolean bAppend) throws FileSystemException {
@@ -1325,6 +1361,7 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* Called when this file is changed.
* <p>
* This will only happen if you monitor the file using {@link org.apache.commons.vfs2.FileMonitor}.
+ * </p>
*
* @throws Exception if an error occurs.
*/
@@ -1655,6 +1692,7 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* Called when the type or content of this file changes.
* <p>
* This implementation does nothing.
+ * </p>
*
* @throws Exception if an error occurs.
*/
@@ -1666,6 +1704,7 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
* children of this file.
* <p>
* This implementation does nothing.
+ * </p>
*
* @param child The name of the child that changed.
* @param newType The type of the file.
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 0e699db..db9c7fa 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
@@ -37,6 +37,7 @@ public abstract class AbstractFileProvider extends AbstractVfsContainer implemen
* The cached file systems.
* <p>
* This is a mapping from {@link FileSystemKey} (root URI and options) to {@link FileSystem}.
+ * </p>
*/
private final Map<FileSystemKey, FileSystem> fileSystems = new TreeMap<>(); // @GuardedBy("self")
@@ -86,6 +87,7 @@ public abstract class AbstractFileProvider extends AbstractVfsContainer implemen
* Adds a file system to those cached by this provider.
* <p>
* The file system may implement {@link VfsComponent}, in which case it is initialised.
+ * </p>
*
* @param key The root file of the file system, part of the cache key.
* @param fs the file system to add.
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 a19e97e..ec94958 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
@@ -512,6 +512,7 @@ public abstract class AbstractFileSystem extends AbstractVfsComponent implements
* Fires a file changed event.
* <p>
* This will only happen if you monitor the file using {@link org.apache.commons.vfs2.FileMonitor}.
+ * </p>
*
* @param file The FileObject that changed.
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractLayeredFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractLayeredFileProvider.java
index 65d29e4..d65c651 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractLayeredFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractLayeredFileProvider.java
@@ -26,6 +26,7 @@ import org.apache.commons.vfs2.FileSystemOptions;
* A {@link FileProvider} that is layered on top of another, such as the contents of a zip or tar file.
*/
public abstract class AbstractLayeredFileProvider extends AbstractFileProvider {
+
public AbstractLayeredFileProvider() {
super();
setFileNameParser(LayeredFileNameParser.getInstance());
@@ -86,6 +87,7 @@ public abstract class AbstractLayeredFileProvider extends AbstractFileProvider {
* Creates a layered file system.
* <p>
* This method is called if the file system is not cached.
+ * </p>
*
* @param scheme The URI scheme.
* @param file The file to create the file system on top of.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractOriginatingFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractOriginatingFileProvider.java
index 5a946b3..e4611d4 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractOriginatingFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractOriginatingFileProvider.java
@@ -27,6 +27,7 @@ import org.apache.commons.vfs2.FileSystemOptions;
* originating file system cannot be layered on top of another file system.
*/
public abstract class AbstractOriginatingFileProvider extends AbstractFileProvider {
+
public AbstractOriginatingFileProvider() {
super();
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractRandomAccessContent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractRandomAccessContent.java
index 6cd9f8e..0cc1208 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractRandomAccessContent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractRandomAccessContent.java
@@ -27,6 +27,7 @@ import org.apache.commons.vfs2.util.RandomAccessMode;
* implementations.
*/
public abstract class AbstractRandomAccessContent implements RandomAccessContent {
+
protected AbstractRandomAccessContent(final RandomAccessMode mode) {
}
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 7d24c9f..e8d7c3a 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
@@ -26,6 +26,7 @@ import org.apache.commons.vfs2.util.RandomAccessMode;
* Implements the part usable for all stream-based random access.
*/
public abstract class AbstractRandomAccessStreamContent extends AbstractRandomAccessContent {
+
protected AbstractRandomAccessStreamContent(final RandomAccessMode mode) {
super(mode);
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractVfsComponent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractVfsComponent.java
index 2d7522c..39b0cc3 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractVfsComponent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractVfsComponent.java
@@ -23,6 +23,7 @@ import org.apache.commons.vfs2.FileSystemException;
* A partial {@link VfsComponent} implementation.
*/
public abstract class AbstractVfsComponent implements VfsComponent {
+
private VfsComponentContext context;
private Log log;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractVfsContainer.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractVfsContainer.java
index 0d0305d..b10a0a8 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractVfsContainer.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractVfsContainer.java
@@ -24,6 +24,7 @@ import org.apache.commons.vfs2.FileSystemException;
* A {@link VfsComponent} that contains a set of sub-components.
*/
public abstract class AbstractVfsContainer extends AbstractVfsComponent {
+
/**
* The components contained by this component.
*/
@@ -34,6 +35,7 @@ public abstract class AbstractVfsContainer extends AbstractVfsComponent {
* <p>
* If the sub-component implements {@link VfsComponent}, it is initialised. All sub-components are closed when this
* component is closed.
+ * </p>
*
* @param component the component to add.
* @throws FileSystemException if any error occurs.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/CompositeFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/CompositeFileProvider.java
index 1f2f4f1..90c8d8e 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/CompositeFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/CompositeFileProvider.java
@@ -25,6 +25,7 @@ import org.apache.commons.vfs2.VFS;
* Description.
*/
public abstract class CompositeFileProvider extends AbstractFileProvider {
+
private static final int INITIAL_BUFSZ = 80;
public CompositeFileProvider() {
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 1a6da74..5fa6242 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
@@ -577,6 +577,7 @@ public final class DefaultFileContent implements FileContent {
* Checks if a input and/or output stream is open.
* <p>
* This checks only the scope of the current thread.
+ * </p>
*
* @return true if this is the case
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DefaultURLConnection.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DefaultURLConnection.java
index 81cc86e..5dea39b 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DefaultURLConnection.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DefaultURLConnection.java
@@ -29,6 +29,7 @@ import org.apache.commons.vfs2.FileSystemException;
* A default URL connection that will work for most file systems.
*/
public final class DefaultURLConnection extends URLConnection {
+
private final FileContent content;
public DefaultURLConnection(final URL url, final FileContent content) {
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 a937079..9d68532 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
@@ -39,6 +39,7 @@ import org.apache.commons.vfs2.util.WeakRefFileListener;
* A file backed by another file.
* <p>
* TODO - Extract subclass that overlays the children.
+ * </p>
*
* @param <AFS> A subclass of AbstractFileSystem.
*/
@@ -326,6 +327,7 @@ public class DelegateFileObject<AFS extends AbstractFileSystem> extends Abstract
* Called when a file is changed.
* <p>
* This will only happen if you monitor the file using {@link org.apache.commons.vfs2.FileMonitor}.
+ * </p>
*
* @param event The FileChangeEvent.
* @throws Exception if an error occurs.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/FileContentThreadData.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/FileContentThreadData.java
index 3663afb..d736da5 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/FileContentThreadData.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/FileContentThreadData.java
@@ -26,6 +26,7 @@ import org.apache.commons.vfs2.RandomAccessContent;
* Holds the data which needs to be local to the current thread
*/
class FileContentThreadData {
+
// private int state = DefaultFileContent.STATE_CLOSED;
private final ArrayList<InputStream> inputStreamList = new ArrayList<>();
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/FileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/FileNameParser.java
index 4bf6876..60fdb49 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/FileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/FileNameParser.java
@@ -23,6 +23,7 @@ import org.apache.commons.vfs2.FileSystemException;
* Provides methods to parse a filename into a {@link org.apache.commons.vfs2.FileName}.
*/
public interface FileNameParser {
+
/**
* Check if a character needs encoding (%nn).
*
@@ -32,7 +33,7 @@ public interface FileNameParser {
boolean encodeCharacter(char ch);
/**
- * parses a String into a filename.
+ * Parses a String into a filename.
*
* @param context The component context.
* @param base The base FileName.
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 61941b9..be62d70 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
@@ -29,8 +29,10 @@ import org.apache.commons.vfs2.FileSystemOptions;
* A file provider. Each file provider is responsible for handling files for a particular URI scheme.
* <p>
* A file provider may also implement {@link VfsComponent}.
+ * </p>
*/
public interface FileProvider {
+
/**
* Locates a file object, by absolute URI.
*
@@ -63,15 +65,17 @@ public interface FileProvider {
FileSystemConfigBuilder getConfigBuilder();
/**
- * Get the filesystem capabilities.<br>
+ * Gets the filesystem capabilities.
+ * <p>
* These are the same as on the filesystem, but available before the first filesystem was instanciated.
+ * </p>
*
* @return a Collection of the file systems Capabilities.
*/
Collection<Capability> getCapabilities();
/**
- * Parse the URI into a FileName.
+ * Parses the URI into a FileName.
*
* @param root The base FileName.
* @param uri The file to be accessed.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/FileReplicator.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/FileReplicator.java
index d5ef9c9..5c2b2bb 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/FileReplicator.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/FileReplicator.java
@@ -26,8 +26,10 @@ import org.apache.commons.vfs2.FileSystemException;
* Responsible for making local replicas of files.
* <p>
* A file replicator may also implement {@link VfsComponent}.
+ * </p>
*/
public interface FileReplicator {
+
/**
* Creates a local copy of the file, and all its descendants.
*
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericFileName.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericFileName.java
index ac82688..f7b4a0c 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericFileName.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericFileName.java
@@ -122,6 +122,7 @@ public class GenericFileName extends AbstractFileName {
* Append the user credentials.
* <p>
* If anything was added, it will be '@' terminated.
+ * </p>
*
* @param buffer the string buffer to modify.
* @param addPassword flag if password should be added or replaced with placeholder (false).
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 4a9195b..8708e1f 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
@@ -40,7 +40,7 @@ public class GenericURLFileName extends GenericFileName {
}
/**
- * Get the query string.
+ * Gets the query string.
*
* @return the query string part of the filename
*/
@@ -49,7 +49,7 @@ public class GenericURLFileName extends GenericFileName {
}
/**
- * Get the path and query string e.g. /path/servlet?param1=true.
+ * Gets the path and query string e.g. /path/servlet?param1=true.
*
* @return the path and its query string
*/
@@ -63,7 +63,7 @@ public class GenericURLFileName extends GenericFileName {
}
/**
- * Get the path encoded suitable for url like filesystem e.g. (http, webdav).
+ * Gets the path encoded suitable for url like filesystem e.g. (http, webdav).
*
* @param charset the charset used for the path encoding
* @return The encoded path.
@@ -91,7 +91,7 @@ public class GenericURLFileName extends GenericFileName {
}
/**
- * Create a FileName.
+ * Creates a FileName.
*
* @param absPath The absolute path.
* @param type The FileType.
@@ -104,7 +104,7 @@ public class GenericURLFileName extends GenericFileName {
}
/**
- * Append query string to the uri.
+ * Appends query string to the uri.
*
* @return the uri
*/
@@ -123,7 +123,7 @@ public class GenericURLFileName extends GenericFileName {
}
/**
- * Encode a URI.
+ * Encodes a URI.
*
* @param charset The character set.
* @return The encoded URI
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericURLFileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericURLFileNameParser.java
index 2edf1a5..72e7e57 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericURLFileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericURLFileNameParser.java
@@ -24,6 +24,7 @@ import org.apache.commons.vfs2.FileType;
* Generic implementation for any url based filesystem, without depending a specific library.
* <p>
* Parses the url into user/password/host/port/path/queryString.
+ * </p>
*/
public class GenericURLFileNameParser extends HostFileNameParser {
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 eabf53c..5e31530 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
@@ -27,6 +27,7 @@ import org.apache.commons.vfs2.util.CryptorFactory;
* Implementation for any url based filesystem.
* <p>
* Parses the url into user/password/host/port/path. Does not handle a query string (after ?)
+ * </p>
*
* @see URLFileNameParser URLFileNameParser for the implementation which also handles the query string too
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/LayeredFileName.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/LayeredFileName.java
index 4f043a5..4544d6d 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/LayeredFileName.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/LayeredFileName.java
@@ -23,6 +23,7 @@ import org.apache.commons.vfs2.FileType;
* A file name for layered files.
*/
public class LayeredFileName extends AbstractFileName {
+
private final FileName outerUri;
public LayeredFileName(final String scheme, final FileName outerUri, final String path, final FileType type) {
@@ -40,7 +41,7 @@ public class LayeredFileName extends AbstractFileName {
}
/**
- * Create a FileName.
+ * Creates a FileName.
*
* @param path The file URI.
* @param type The FileType.
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 4706455..8dbdc42 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
@@ -25,12 +25,13 @@ import org.apache.commons.vfs2.VFS;
* Implementation for layered filesystems.
* <p>
* Additionally encodes the '!' character.
+ * </p>
*/
public class LayeredFileNameParser extends AbstractFileNameParser {
private static final LayeredFileNameParser INSTANCE = new LayeredFileNameParser();
/**
- * Return the Parser.
+ * Returns the Parser.
*
* @return The Parser.
*/
@@ -50,7 +51,7 @@ public class LayeredFileNameParser extends AbstractFileNameParser {
}
/**
- * Parse the base and name into a FileName.
+ * Parses the base and name into a FileName.
*
* @param context The component context.
* @param base The base FileName.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/LocalFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/LocalFileProvider.java
index 473b26c..b8475ee 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/LocalFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/LocalFileProvider.java
@@ -25,10 +25,12 @@ import org.apache.commons.vfs2.FileSystemException;
* A file provider which handles local files.
*/
public interface LocalFileProvider extends FileProvider {
+
/**
* Determines if a name is an absolute file name.
* <p>
* TODO - Move this to a general file name parser interface.
+ * </p>
*
* @param name The name to test.
* @return true if the name is absolute.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/TemporaryFileStore.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/TemporaryFileStore.java
index 84526f2..6e106a7 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/TemporaryFileStore.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/TemporaryFileStore.java
@@ -24,6 +24,7 @@ import org.apache.commons.vfs2.FileSystemException;
* Manages a repository of temporary local files.
*/
public interface TemporaryFileStore {
+
/**
* Allocates a new temporary file. The file (and all its descendants) will be deleted when this store is closed.
*
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 833386f..f3e15b4 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
@@ -28,6 +28,7 @@ import org.apache.commons.vfs2.FileType;
*/
@Deprecated
public class URLFileName extends GenericFileName {
+
private static final int BUFFER_SIZE = 250;
private final String queryString;
@@ -40,7 +41,7 @@ public class URLFileName extends GenericFileName {
}
/**
- * Get the query string.
+ * Gets the query string.
*
* @return the query string part of the filename
*/
@@ -49,7 +50,7 @@ public class URLFileName extends GenericFileName {
}
/**
- * Get the path and query string e.g. /path/servlet?param1=true.
+ * Gets the path and query string e.g. /path/servlet?param1=true.
*
* @return the path and its query string
*/
@@ -63,7 +64,7 @@ public class URLFileName extends GenericFileName {
}
/**
- * Get the path encoded suitable for url like filesystem e.g. (http, webdav).
+ * Gets the path encoded suitable for url like filesystem e.g. (http, webdav).
*
* @param charset the charset used for the path encoding
* @return The encoded path.
@@ -103,7 +104,7 @@ public class URLFileName extends GenericFileName {
}
/**
- * Append query string to the uri.
+ * Appends query string to the uri.
*
* @return the uri
*/
@@ -122,7 +123,7 @@ public class URLFileName extends GenericFileName {
}
/**
- * Encode a URI.
+ * Encodes a URI.
*
* @param charset The character set.
* @return The encoded URI
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileNameParser.java
index 9d04590..f142bc1 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileNameParser.java
@@ -24,6 +24,7 @@ import org.apache.commons.vfs2.FileType;
* Implementation for any url based filesystem.
* <p>
* Parses the url into user/password/host/port/path/queryString.
+ * </p>
* @deprecated Use {@link GenericURLFileNameParser} as it doesn't depend on Http Client v3 API directly.
*/
@Deprecated
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/UriParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/UriParser.java
index 7ba22da..d2e7262 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/UriParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/UriParser.java
@@ -25,10 +25,9 @@ import org.apache.commons.vfs2.util.Os;
/**
* Utilities for dealing with URIs. See RFC 2396 for details.
- *
- * 2005) $
*/
public final class UriParser {
+
/**
* The set of valid separators. These are all converted to the normalized one. Does <i>not</i> contain the
* normalized separator
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/VfsComponent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/VfsComponent.java
index 01c205e..f1dec63 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/VfsComponent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/VfsComponent.java
@@ -30,6 +30,7 @@ import org.apache.commons.vfs2.FileSystemException;
* </ul>
*/
public interface VfsComponent {
+
/**
* Sets the Logger to use for the component.
*
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 e3a6586..6cfac77 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
@@ -31,6 +31,7 @@ import org.apache.commons.vfs2.FileSystemOptions;
* @see VfsComponent#setContext
*/
public interface VfsComponentContext {
+
/**
* Locate a file by name. See {@link FileSystemManager#resolveFile(FileObject, String)} for a description of how
* this works.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileProvider.java
index 3d814bd..e979224 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileProvider.java
@@ -32,6 +32,7 @@ import org.apache.commons.vfs2.provider.compressed.CompressedFileFileProvider;
* Provides access to the content of bzip2 compressed files.
*/
public class Bzip2FileProvider extends CompressedFileFileProvider {
+
/** The provider's capabilities */
protected static final Collection<Capability> capabilities = Collections.unmodifiableCollection(Arrays
.asList(new Capability[] { Capability.GET_LAST_MODIFIED, Capability.GET_TYPE, Capability.LIST_CHILDREN,
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileSystem.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileSystem.java
index 2c96197..a07367c 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileSystem.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileSystem.java
@@ -30,6 +30,7 @@ import org.apache.commons.vfs2.provider.compressed.CompressedFileFileSystem;
* Filesytem to handle compressed files using the bzip2 method.
*/
public class Bzip2FileSystem extends CompressedFileFileSystem {
+
protected Bzip2FileSystem(final FileName rootName, final FileObject parentLayer,
final FileSystemOptions fileSystemOptions) {
super(rootName, parentLayer, fileSystemOptions);
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 998ad8f..ee2044a 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
@@ -33,6 +33,7 @@ import org.apache.commons.vfs2.provider.AbstractFileObject;
* @param <FS> A CompressedFileFileSystem
*/
public abstract class CompressedFileFileObject<FS extends CompressedFileFileSystem> extends AbstractFileObject<FS> {
+
private final FileObject container;
private final String[] children;
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 9c204ff..c1e4602 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
@@ -32,6 +32,7 @@ import org.apache.commons.vfs2.provider.LayeredFileName;
* A file system provider for compressed files. Provides read-only file systems.
*/
public abstract class CompressedFileFileProvider extends AbstractLayeredFileProvider {
+
public CompressedFileFileProvider() {
super();
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/compressed/CompressedFileFileSystem.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/compressed/CompressedFileFileSystem.java
index 62f918a..1eff96d 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/compressed/CompressedFileFileSystem.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/compressed/CompressedFileFileSystem.java
@@ -30,6 +30,7 @@ import org.apache.commons.vfs2.provider.AbstractFileSystem;
* A read-only file system for compressed files.
*/
public abstract class CompressedFileFileSystem extends AbstractFileSystem {
+
protected CompressedFileFileSystem(final FileName rootName, final FileObject parentLayer,
final FileSystemOptions fileSystemOptions) {
super(rootName, parentLayer, fileSystemOptions);
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 dd95f21..098310b 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
@@ -37,6 +37,7 @@ import org.apache.commons.vfs2.util.UserAuthenticatorUtils;
* Create a FtpClient instance.
*/
public final class FtpClientFactory {
+
private FtpClientFactory() {
}
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 cdd15a6..74fa319 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
@@ -23,6 +23,7 @@ import org.apache.commons.vfs2.provider.HostFileNameParser;
* Implementation for ftp. set default port to 21
*/
public class FtpFileNameParser extends HostFileNameParser {
+
private static final FtpFileNameParser INSTANCE = new FtpFileNameParser();
private static final int PORT = 21;
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 44d0f6b..104b469 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
@@ -34,6 +34,7 @@ import org.apache.commons.vfs2.provider.GenericFileName;
* A provider for FTP file systems.
*/
public class FtpFileProvider extends AbstractOriginatingFileProvider {
+
/**
* File Entry Parser.
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystem.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystem.java
index d173bb5..0759d73 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystem.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystem.java
@@ -35,6 +35,7 @@ import org.apache.commons.vfs2.provider.GenericFileName;
* An FTP file system.
*/
public class FtpFileSystem extends AbstractFileSystem {
+
private static final Log LOG = LogFactory.getLog(FtpFileSystem.class);
// private final String hostname;
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 9604175..ffe44ed 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
@@ -31,6 +31,7 @@ import org.apache.commons.vfs2.FileSystemOptions;
* The config builder for various ftp configuration options.
*/
public class FtpFileSystemConfigBuilder extends FileSystemConfigBuilder {
+
private static final String _PREFIX = FtpFileSystemConfigBuilder.class.getName();
private static final FtpFileSystemConfigBuilder BUILDER = new FtpFileSystemConfigBuilder();
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileType.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileType.java
index 3f07612..c009905 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileType.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileType.java
@@ -24,6 +24,7 @@ import org.apache.commons.net.ftp.FTP;
* @since 2.1
*/
public enum FtpFileType {
+
/**
* The ASCII file type.
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpRandomAccessContent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpRandomAccessContent.java
index 7126336..a7b257d 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpRandomAccessContent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpRandomAccessContent.java
@@ -28,6 +28,7 @@ import org.apache.commons.vfs2.util.RandomAccessMode;
* Implements FTP stream-based random access.
*/
class FtpRandomAccessContent extends AbstractRandomAccessStreamContent {
+
protected long filePointer;
private final FtpFileObject fileObject;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsClientWrapper.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsClientWrapper.java
index 89d7d4c..6e30c8d 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsClientWrapper.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsClientWrapper.java
@@ -29,10 +29,12 @@ import org.apache.commons.vfs2.util.UserAuthenticatorUtils;
* <p>
* The only difference to the {@link FTPClientWrapper} is the creation of a {@link FTPSClient} instead of a
* {@link FTPClient}.
+ * </p>
*
* @since 2.0
*/
class FtpsClientWrapper extends FTPClientWrapper {
+
FtpsClientWrapper(final GenericFileName root, final FileSystemOptions fileSystemOptions)
throws FileSystemException {
super(root, fileSystemOptions);
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileProvider.java
index df6fe30..20e00c2 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileProvider.java
@@ -32,6 +32,7 @@ import org.apache.commons.vfs2.provider.compressed.CompressedFileFileProvider;
* Provides access to the content of gzip compressed files.
*/
public class GzipFileProvider extends CompressedFileFileProvider {
+
/**
* Capabilities.
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileSystem.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileSystem.java
index 655dfd1..6ac6507 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileSystem.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileSystem.java
@@ -30,6 +30,7 @@ import org.apache.commons.vfs2.provider.compressed.CompressedFileFileSystem;
* Filesytem to handle compressed files using the gzip method.
*/
public class GzipFileSystem extends CompressedFileFileSystem {
+
protected GzipFileSystem(final FileName rootName, final FileObject parentLayer,
final FileSystemOptions fileSystemOptions) {
super(rootName, parentLayer, fileSystemOptions);
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileAttributes.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileAttributes.java
index 576fa9b..fd8c819 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileAttributes.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileAttributes.java
@@ -22,6 +22,7 @@ package org.apache.commons.vfs2.provider.hdfs;
* @since 2.1
*/
public enum HdfsFileAttributes {
+
/**
* Last access time.
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileContentInfoFactory.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileContentInfoFactory.java
index b39887d..7b954da 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileContentInfoFactory.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileContentInfoFactory.java
@@ -28,6 +28,7 @@ import org.apache.commons.vfs2.impl.DefaultFileContentInfo;
* @since 2.1
*/
public class HdfsFileContentInfoFactory implements FileContentInfoFactory {
+
private static final String CONTENT = "text/plain";
private static final String ENCODING = "UTF-8";
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileObject.java
index 75f3190..3964d2d 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileObject.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileObject.java
@@ -39,6 +39,7 @@ import org.apache.hadoop.fs.Path;
* @since 2.1
*/
public class HdfsFileObject extends AbstractFileObject<HdfsFileSystem> {
+
private final HdfsFileSystem fs;
private final FileSystem hdfs;
private final Path path;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileProvider.java
index f4f9e0d..6e80898 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileProvider.java
@@ -35,6 +35,7 @@ import org.apache.commons.vfs2.provider.http.HttpFileNameParser;
* @since 2.1
*/
public class HdfsFileProvider extends AbstractOriginatingFileProvider {
+
static final Collection<Capability> CAPABILITIES = Collections
.unmodifiableCollection(Arrays.asList(new Capability[] { Capability.GET_TYPE, Capability.READ_CONTENT,
Capability.URI, Capability.GET_LAST_MODIFIED, Capability.ATTRIBUTES, Capability.RANDOM_ACCESS_READ,
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileSystem.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileSystem.java
index e2bf657..6ef164b 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileSystem.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileSystem.java
@@ -43,6 +43,7 @@ import org.apache.hadoop.fs.Path;
* @since 2.1
*/
public class HdfsFileSystem extends AbstractFileSystem {
+
private static final Log log = LogFactory.getLog(HdfsFileSystem.class);
private FileSystem fs;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileSystemConfigBuilder.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileSystemConfigBuilder.java
index 461a5ac..ec40683 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileSystemConfigBuilder.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileSystemConfigBuilder.java
@@ -31,6 +31,7 @@ import org.apache.hadoop.fs.Path;
* @since 2.1
*/
public final class HdfsFileSystemConfigBuilder extends FileSystemConfigBuilder {
+
private static final HdfsFileSystemConfigBuilder BUILDER = new HdfsFileSystemConfigBuilder();
private static final String KEY_CONFIG_NAMES = "configNames";
private static final String KEY_CONFIG_PATHS = "configPaths";
@@ -75,16 +76,20 @@ public final class HdfsFileSystemConfigBuilder extends FileSystemConfigBuilder {
* Specifies the name of a config resource to override any specific HDFS settings. The property will be passed on to
* {@code org.apache.hadoop.conf.Configuration#addResource(String)} after the URL was set as the default name with:
* {@code Configuration#set(FileSystem.FS_DEFAULT_NAME_KEY, url)}.
+ * </p>
* <p>
* One use for this is to set a different value for the {@code dfs.client.use.datanode.hostname} property in order
* to access HDFS files stored in an AWS installation (from outside their firewall). There are other possible uses
* too.
+ * </p>
* <p>
* This method may be called multiple times and all the specified resources will be loaded in the order they were
* specified.
+ * </p>
* <p>
* Note also, that if a list of names is provided, separated by commas ({@code ","}), that this will work the same
* as calling this method a number of times with just one name each.
+ * </p>
*
* @param opts The FileSystemOptions to modify.
* @param name resource name of additional configuration or {@code null} to unset all the values set so far.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsRandomAccessContent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsRandomAccessContent.java
index 47d8620..a1dbf42 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsRandomAccessContent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsRandomAccessContent.java
@@ -32,6 +32,7 @@ import org.apache.hadoop.fs.Path;
* @since 2.1
*/
public class HdfsRandomAccessContent extends AbstractRandomAccessContent {
+
private final FSDataInputStream fis;
private final FileSystem fs;
private final Path path;
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 33ff9fd..08bcf97 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
@@ -35,6 +35,7 @@ import org.apache.commons.vfs2.util.UserAuthenticatorUtils;
* Create a HttpClient instance.
*/
public final class HttpClientFactory {
+
private HttpClientFactory() {
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileContentInfoFactory.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileContentInfoFactory.java
index 3a38118..86b5478 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileContentInfoFactory.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileContentInfoFactory.java
@@ -32,6 +32,7 @@ import org.apache.commons.vfs2.util.FileObjectUtils;
* Creates FileContentInfo instances for HTTP.
*/
public class HttpFileContentInfoFactory implements FileContentInfoFactory {
+
@Override
public FileContentInfo create(final FileContent fileContent) throws FileSystemException {
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 f1ca9f1..779243b 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
@@ -23,6 +23,7 @@ import org.apache.commons.vfs2.provider.URLFileNameParser;
* Implementation for http. set default port to 80
*/
public class HttpFileNameParser extends URLFileNameParser {
+
private static final int DEFAULT_PORT = 80;
private static final HttpFileNameParser INSTANCE = new HttpFileNameParser();
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 9467dc8..1e230cb 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
@@ -44,10 +44,12 @@ import org.apache.commons.vfs2.util.RandomAccessMode;
* A file object backed by Apache Commons HttpClient.
* <p>
* TODO - status codes.
+ * </p>
*
* @param <FS> An {@link HttpFileSystem} subclass
*/
public class HttpFileObject<FS extends HttpFileSystem> extends AbstractFileObject<FS> {
+
/**
* An InputStream that cleans up the HTTP connection on close.
*/
@@ -113,8 +115,10 @@ public class HttpFileObject<FS extends HttpFileSystem> extends AbstractFileObjec
* {@link FileType#FILE}.
* <p>
* It is guaranteed that there are no open output streams for this file when this method is called.
+ * </p>
* <p>
* The returned stream does not have to be buffered.
+ * </p>
*/
@Override
protected InputStream doGetInputStream() throws Exception {
@@ -135,6 +139,7 @@ public class HttpFileObject<FS extends HttpFileSystem> extends AbstractFileObjec
* Returns the last modified time of this file.
* <p>
* This implementation throws an exception.
+ * </p>
*/
@Override
protected long doGetLastModifiedTime() throws Exception {
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 e822b6b..726e76c 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
@@ -36,6 +36,7 @@ import org.apache.commons.vfs2.util.UserAuthenticatorUtils;
* An HTTP provider that uses commons-httpclient.
*/
public class HttpFileProvider extends AbstractOriginatingFileProvider {
+
/** Authenticator information. */
public static final UserAuthenticationData.Type[] AUTHENTICATOR_TYPES = new UserAuthenticationData.Type[] {
UserAuthenticationData.USERNAME, UserAuthenticationData.PASSWORD };
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 529f70a..b053f85 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
@@ -32,6 +32,7 @@ import org.apache.commons.vfs2.provider.GenericFileName;
* An HTTP file system.
*/
public class HttpFileSystem extends AbstractFileSystem {
+
private final HttpClient client;
protected HttpFileSystem(final GenericFileName rootName, final HttpClient client,
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 c3e97d6..b7044f8 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
@@ -28,6 +28,7 @@ import org.apache.commons.vfs2.UserAuthenticator;
* Configuration options for HTTP.
*/
public class HttpFileSystemConfigBuilder extends FileSystemConfigBuilder {
+
protected static final String KEY_FOLLOW_REDIRECT = "followRedirect";
protected static final String KEY_USER_AGENT = "userAgent";
@@ -72,7 +73,7 @@ public class HttpFileSystemConfigBuilder extends FileSystemConfigBuilder {
}
/**
- * Sets the charset used for url encoding.<br>
+ * Sets the charset used for url encoding.
*
* @param opts The FileSystem options.
* @param chaset the chaset
@@ -82,7 +83,7 @@ public class HttpFileSystemConfigBuilder extends FileSystemConfigBuilder {
}
/**
- * Sets the charset used for url encoding.<br>
+ * Sets the charset used for url encoding.
*
* @param opts The FileSystem options.
* @return the chaset
@@ -92,8 +93,10 @@ public class HttpFileSystemConfigBuilder extends FileSystemConfigBuilder {
}
/**
- * Sets the proxy to use for http connection.<br>
+ * Sets the proxy to use for http connection.
+ * <p>
* You have to set the ProxyPort too if you would like to have the proxy really used.
+ * </p>
*
* @param opts The FileSystem options.
* @param proxyHost the host
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpRandomAccessContent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpRandomAccessContent.java
index 26aeb77..a5a54c7 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpRandomAccessContent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpRandomAccessContent.java
@@ -31,6 +31,7 @@ import org.apache.commons.vfs2.util.RandomAccessMode;
* RandomAccess content using HTTP.
*/
class HttpRandomAccessContent<FS extends HttpFileSystem> extends AbstractRandomAccessStreamContent {
+
protected long filePointer = 0;
private final HttpFileObject<FS> fileObject;
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 2e3bc59..697fc09 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
@@ -68,6 +68,7 @@ public class Http4FileObject<FS extends Http4FileSystem> extends AbstractFileObj
/**
* Construct <code>Http4FileObject</code>.
+ *
* @param name file name
* @param fileSystem file system
* @throws FileSystemException if any error occurs
@@ -80,6 +81,7 @@ public class Http4FileObject<FS extends Http4FileSystem> extends AbstractFileObj
/**
* Construct <code>Http4FileObject</code>.
+ *
* @param name file name
* @param fileSystem file system
* @param builder <code>Http4FileSystemConfigBuilder</code> object
@@ -190,6 +192,7 @@ public class Http4FileObject<FS extends Http4FileSystem> extends AbstractFileObj
/**
* Return the internal <code>URI</code> object mapped to this file object.
+ *
* @return the internal <code>URI</code> object mapped to this file object
* @throws FileSystemException if any error occurs
*/
@@ -199,6 +202,7 @@ public class Http4FileObject<FS extends Http4FileSystem> extends AbstractFileObj
/**
* Return the last executed HEAD <code>HttpResponse</code> object.
+ *
* @return the last executed HEAD <code>HttpResponse</code> object
* @throws IOException if IO error occurs
*/
@@ -212,6 +216,7 @@ public class Http4FileObject<FS extends Http4FileSystem> extends AbstractFileObj
/**
* Execute the request using the given {@code httpRequest} and return a <code>HttpResponse</code> from the execution.
+ *
* @param httpRequest <code>HttpUriRequest</code> object
* @return <code>HttpResponse</code> from the execution
* @throws IOException if IO error occurs
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 a0fce01..4ac7a2f 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
@@ -143,6 +143,7 @@ public class Http4FileProvider extends AbstractOriginatingFileProvider {
/**
* Create an {@link HttpClient} object for an http4 file system.
+ *
* @param builder Configuration options builder for http4 provider
* @param rootName The root path
* @param fileSystemOptions The file system options
@@ -156,6 +157,7 @@ public class Http4FileProvider extends AbstractOriginatingFileProvider {
/**
* Create an {@link HttpClientBuilder} object. Invoked by {@link #createHttpClient(Http4FileSystemConfigBuilder, GenericFileName, FileSystemOptions)}.
+ *
* @param builder Configuration options builder for HTTP4 provider
* @param rootName The root path
* @param fileSystemOptions The FileSystem options
@@ -191,6 +193,7 @@ public class Http4FileProvider extends AbstractOriginatingFileProvider {
/**
* Create {@link SSLContext} for HttpClient. Invoked by {@link #createHttpClientBuilder(Http4FileSystemConfigBuilder, GenericFileName, FileSystemOptions)}.
+ *
* @param builder Configuration options builder for HTTP4 provider
* @param fileSystemOptions The FileSystem options
* @return a {@link SSLContext} for HttpClient
@@ -232,6 +235,7 @@ public class Http4FileProvider extends AbstractOriginatingFileProvider {
/**
* Create an {@link HttpClientContext} object for an http4 file system.
+ *
* @param builder Configuration options builder for http4 provider
* @param rootName The root path
* @param fileSystemOptions The FileSystem options
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 f972c4f..2afbcc1 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
@@ -52,6 +52,7 @@ public class Http4FileSystem extends AbstractFileSystem {
/**
* Construct <code>Http4FileSystem</code>.
+ *
* @param rootName root base name
* @param fileSystemOptions file system options
* @param httpClient {@link HttpClient} instance
@@ -99,6 +100,7 @@ public class Http4FileSystem extends AbstractFileSystem {
/**
* Return the internal {@link HttpClient} instance.
+ *
* @return the internal {@link HttpClient} instance
*/
protected HttpClient getHttpClient() {
@@ -107,6 +109,7 @@ public class Http4FileSystem extends AbstractFileSystem {
/**
* Return the internal {@link HttpClientContext} instance.
+ *
* @return the internal {@link HttpClientContext} instance
*/
protected HttpClientContext getHttpClientContext() {
@@ -115,6 +118,7 @@ public class Http4FileSystem extends AbstractFileSystem {
/**
* Return the internal base <code>URI</code> instance.
+ *
* @return the internal base <code>URI</code> instance
*/
protected URI getInternalBaseURI() {
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 bfb53ec..2980089 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
@@ -180,7 +180,7 @@ public class Http4FileSystemConfigBuilder extends FileSystemConfigBuilder {
}
/**
- * Sets the charset used for url encoding.<br>
+ * Sets the charset used for url encoding.
*
* @param opts The FileSystem options.
* @param chaset the chaset
@@ -190,7 +190,7 @@ public class Http4FileSystemConfigBuilder extends FileSystemConfigBuilder {
}
/**
- * Sets the charset used for url encoding.<br>
+ * Sets the charset used for url encoding.
*
* @param opts The FileSystem options.
* @return the chaset
@@ -200,8 +200,10 @@ public class Http4FileSystemConfigBuilder extends FileSystemConfigBuilder {
}
/**
- * Sets the proxy to use for http connection.<br>
+ * Sets the proxy to use for http connection.
+ * <p>
* You have to set the ProxyPort too if you would like to have the proxy really used.
+ * </p>
*
* @param opts The FileSystem options.
* @param proxyHost the host
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/https/HttpsFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/https/HttpsFileProvider.java
index ef34a8b..bf75127 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/https/HttpsFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/https/HttpsFileProvider.java
@@ -22,6 +22,7 @@ import org.apache.commons.vfs2.provider.http.HttpFileProvider;
* An HTTPS provider that uses commons-httpclient.
*/
public class HttpsFileProvider extends HttpFileProvider {
+
public HttpsFileProvider() {
super();
setFileNameParser(HttpsFileNameParser.getInstance());
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileObject.java
index 24727df..5d03b06 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileObject.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileObject.java
@@ -35,6 +35,7 @@ import org.apache.commons.vfs2.provider.zip.ZipFileObject;
* A file in a Jar file system.
*/
public class JarFileObject extends ZipFileObject {
+
private final JarFileSystem fs;
private Attributes attributes;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileProvider.java
index f256d9c..c2def68 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileProvider.java
@@ -37,6 +37,7 @@ import org.apache.commons.vfs2.provider.zip.ZipFileProvider;
* like Signing and Manifest Attributes.
*/
public class JarFileProvider extends ZipFileProvider {
+
static final Collection<Capability> capabilities;
static {
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarURLConnectionImpl.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarURLConnectionImpl.java
index 1666f59..cd45d87 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarURLConnectionImpl.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarURLConnectionImpl.java
@@ -35,6 +35,7 @@ import org.apache.commons.vfs2.FileSystemException;
* A default URL connection that will work for most file systems.
*/
public class JarURLConnectionImpl extends JarURLConnection {
+
// This is because JarURLConnection SUCKS
private static final String HACK_URL = "jar:http://somehost/somejar.jar!/";
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 5068d2f..1c811ff 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
@@ -36,6 +36,7 @@ import org.apache.commons.vfs2.util.Os;
* A file system provider, which uses direct file access.
*/
public class DefaultLocalFileProvider extends AbstractOriginatingFileProvider implements LocalFileProvider {
+
/** The provider's capabilities. */
public static final Collection<Capability> capabilities = Collections.unmodifiableCollection(
Arrays.asList(new Capability[] { Capability.CREATE, Capability.DELETE, Capability.RENAME,
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 e2b98cc..17e4211 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
@@ -24,6 +24,7 @@ import org.apache.commons.vfs2.FileType;
* A general-purpose file name parser.
*/
public class GenericFileNameParser extends LocalFileNameParser {
+
private static final GenericFileNameParser INSTANCE = new GenericFileNameParser();
/**
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 858bf26..68e2979 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
@@ -37,6 +37,7 @@ import org.apache.commons.vfs2.util.RandomAccessMode;
* A file object implementation which uses direct file access.
*/
public class LocalFile extends AbstractFileObject<LocalFileSystem> {
+
private final String rootFile;
private File 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 8463058..fe479dd 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
@@ -26,6 +26,7 @@ import org.apache.commons.vfs2.provider.UriParser;
* A local file URI.
*/
public class LocalFileName extends AbstractFileName {
+
private final String rootFile;
protected LocalFileName(final String scheme, final String rootFile, final String path, final FileType type) {
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 cd4b679..c7053d4 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
@@ -28,6 +28,7 @@ import org.apache.commons.vfs2.provider.VfsComponentContext;
* A name parser.
*/
public abstract class LocalFileNameParser extends AbstractFileNameParser {
+
/**
* Determines if a name is an absolute file name.
*
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileRandomAccessContent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileRandomAccessContent.java
index 521e5ce..7c11203 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileRandomAccessContent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileRandomAccessContent.java
@@ -31,6 +31,7 @@ import org.apache.commons.vfs2.util.RandomAccessMode;
* Implements {@link org.apache.commons.vfs2.RandomAccessContent RandomAccessContent} for local files.
*/
class LocalFileRandomAccessContent extends AbstractRandomAccessContent {
+
// private final LocalFile localFile;
private final RandomAccessFile raf;
private final InputStream rafis;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileSystem.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileSystem.java
index 9e8520e..3d4af0b 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileSystem.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileSystem.java
@@ -34,6 +34,7 @@ import org.apache.commons.vfs2.util.FileObjectUtils;
* A local file system.
*/
public class LocalFileSystem extends AbstractFileSystem {
+
private final String rootFile;
public LocalFileSystem(final FileName rootName, final String rootFile, final FileSystemOptions opts) {
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/WindowsFileName.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/WindowsFileName.java
index ad8e089..f35fbdb 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/WindowsFileName.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/WindowsFileName.java
@@ -23,6 +23,7 @@ import org.apache.commons.vfs2.FileType;
* A local file URI.
*/
public class WindowsFileName extends LocalFileName {
+
protected WindowsFileName(final String scheme, final String rootFile, final String path, final FileType type) {
super(scheme, rootFile, path, type);
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/WindowsFileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/WindowsFileNameParser.java
index bb69063..5ab3da7 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/WindowsFileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/WindowsFileNameParser.java
@@ -24,6 +24,7 @@ import org.apache.commons.vfs2.FileType;
* A parser for Windows file names.
*/
public class WindowsFileNameParser extends LocalFileNameParser {
+
/**
* Pops the root prefix off a URI, which has had the scheme removed.
*/
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 d2b00ec..e6bcc83 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
@@ -29,6 +29,7 @@ import org.apache.commons.vfs2.FileType;
* RAM File Object Data.
*/
class RamFileData implements Serializable {
+
static final byte[] EMPTY = new byte[0];
/**
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 67f2baa..0fbadb2 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
@@ -36,6 +36,7 @@ import org.apache.commons.vfs2.util.RandomAccessMode;
* interface.
*/
public class RamFileObject extends AbstractFileObject<RamFileSystem> {
+
/**
* RAM File Object Data.
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileProvider.java
index 47b9ab1..071ca89 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileProvider.java
@@ -31,6 +31,7 @@ import org.apache.commons.vfs2.provider.AbstractOriginatingFileProvider;
* RAM File Provider.
*/
public class RamFileProvider extends AbstractOriginatingFileProvider {
+
/** The provider's capabilities. */
public static final Collection<Capability> capabilities = Collections.unmodifiableCollection(
Arrays.asList(new Capability[] { Capability.CREATE, Capability.DELETE, Capability.RENAME,
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileRandomAccessContent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileRandomAccessContent.java
index 62e851d..3615bc4 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileRandomAccessContent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileRandomAccessContent.java
@@ -30,6 +30,7 @@ import org.apache.commons.vfs2.util.RandomAccessMode;
* RAM File Random Access Content.
*/
public class RamFileRandomAccessContent implements RandomAccessContent {
+
/**
* File Pointer
*/
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 7368953..ead3b78 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
@@ -41,6 +41,7 @@ import org.apache.commons.vfs2.provider.AbstractFileSystem;
* A RAM File System.
*/
public class RamFileSystem extends AbstractFileSystem implements Serializable {
+
private static final int BUFFER_SIZE = 512;
/**
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 c7862ef..86f8cfd 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
@@ -35,6 +35,7 @@ import org.apache.commons.vfs2.provider.UriParser;
* The Resource provider.
*/
public class ResourceFileProvider extends AbstractFileProvider {
+
/** The provider's capabilities */
protected static final Collection<Capability> capabilities = Collections
.unmodifiableCollection(Arrays.asList(new Capability[] { Capability.DISPATCHER }));
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 cb0b07d..fed3ea9 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
@@ -25,6 +25,7 @@ import org.apache.commons.vfs2.provider.url.UrlFileSystem;
* The config BUILDER for various ftp configuration options.
*/
public final class ResourceFileSystemConfigBuilder extends FileSystemConfigBuilder {
+
private static final ResourceFileSystemConfigBuilder BUILDER = new ResourceFileSystemConfigBuilder();
private ResourceFileSystemConfigBuilder() {
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 7fb4331..d05fb21 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
@@ -27,6 +27,7 @@ import com.jcraft.jsch.JSchException;
* @since 2.1
*/
public class IdentityInfo implements IdentityProvider {
+
private final byte[] passPhrase;
private final File privateKey;
private final File publicKey;
@@ -35,8 +36,10 @@ public class IdentityInfo implements IdentityProvider {
* Constructs an identity info with private key.
* <p>
* The key is not passphrase protected.
+ * </p>
* <p>
* We use java.io.File because JSch cannot deal with VFS FileObjects.
+ * </p>
*
* @param privateKey The file with the private key
* @since 2.1
@@ -49,6 +52,7 @@ public class IdentityInfo implements IdentityProvider {
* Constructs an identity info with private key and its passphrase.
* <p>
* We use java.io.File because JSch cannot deal with VFS FileObjects.
+ * </p>
*
* @param privateKey The file with the private key
* @param passPhrase The passphrase to decrypt the private key (can be {@code null} if no passphrase is used)
@@ -62,6 +66,7 @@ public class IdentityInfo implements IdentityProvider {
* Constructs an identity info with private and public key and passphrase for the private key.
* <p>
* We use java.io.File because JSch cannot deal with VFS FileObjects.
+ * </p>
*
* @param privateKey The file with the private key
* @param publicKey The public key part used for connections with exchange of certificates (can be {@code null})
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 d9ecfc2..b34f6d2 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
@@ -21,7 +21,6 @@ import com.jcraft.jsch.JSch;
/**
* Creates instances of JSch {@link IdentityRepository}.
- *
*/
public interface IdentityRepositoryFactory {
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 831d843..7d07523 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
@@ -23,6 +23,7 @@ import org.apache.commons.vfs2.provider.URLFileNameParser;
* Implementation for SFTP. Sets the default port to 22.
*/
public class SftpFileNameParser extends URLFileNameParser {
+
private static final int DEFAULT_PORT = 22;
private static final SftpFileNameParser INSTANCE = new SftpFileNameParser();
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileObject.java
index 011bf73..6edfa96 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileObject.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileObject.java
@@ -48,6 +48,7 @@ import com.jcraft.jsch.SftpException;
* An SFTP file.
*/
public class SftpFileObject extends AbstractFileObject<SftpFileSystem> {
+
private static final long MOD_TIME_FACTOR = 1000L;
private SftpATTRS attrs;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileProvider.java
index 27998e7..1d2a58c 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileProvider.java
@@ -37,6 +37,7 @@ import com.jcraft.jsch.Session;
* A provider for accessing files over SFTP.
*/
public class SftpFileProvider extends AbstractOriginatingFileProvider {
+
/** User Information. */
public static final String ATTR_USER_INFO = "UI";
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpRandomAccessContent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpRandomAccessContent.java
index bfc0789..43ffe9a 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpRandomAccessContent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpRandomAccessContent.java
@@ -29,6 +29,7 @@ import org.apache.commons.vfs2.util.RandomAccessMode;
* Random access content.
*/
class SftpRandomAccessContent extends AbstractRandomAccessStreamContent {
+
/** file pointer */
protected long filePointer = 0;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileObject.java
index c7bc20d..9db9ab7 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileObject.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileObject.java
@@ -30,6 +30,7 @@ import org.apache.commons.vfs2.provider.AbstractFileObject;
* A file in a Tar file system.
*/
public class TarFileObject extends AbstractFileObject<TarFileSystem> {
+
/** The TarArchiveEntry */
private TarArchiveEntry entry;
private final HashSet<String> children = new HashSet<>();
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileProvider.java
index 84aa924..d4485aa 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileProvider.java
@@ -35,6 +35,7 @@ import org.apache.commons.vfs2.provider.LayeredFileName;
* A file system provider for Tar files. Provides read-only file systems.
*/
public class TarFileProvider extends AbstractLayeredFileProvider {
+
/** The provider's capabilities */
protected static final Collection<Capability> capabilities = Collections
.unmodifiableCollection(Arrays.asList(new Capability[] { Capability.GET_LAST_MODIFIED, Capability.GET_TYPE,
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 ce55e6b..739cc79 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
@@ -44,6 +44,7 @@ import org.apache.commons.vfs2.provider.bzip2.Bzip2FileObject;
* A read-only file system for Tar files.
*/
public class TarFileSystem extends AbstractFileSystem {
+
private static final int DEFAULT_INDEX_SIZE = 100;
private static final Log LOG = LogFactory.getLog(TarFileSystem.class);
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/Tbz2FileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/Tbz2FileProvider.java
index 81bad4b..b7c29c3 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/Tbz2FileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/Tbz2FileProvider.java
@@ -25,6 +25,7 @@ import org.apache.commons.vfs2.provider.CompositeFileProvider;
* A file system provider for Tar files. Provides read-only file systems.
*/
public class Tbz2FileProvider extends CompositeFileProvider {
+
/** The provider's capabilities */
protected static final Collection<Capability> capabilities = TarFileProvider.capabilities;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TgzFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TgzFileProvider.java
index d3ae27f..85fd7d0 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TgzFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TgzFileProvider.java
@@ -25,6 +25,7 @@ import org.apache.commons.vfs2.provider.CompositeFileProvider;
* A file system provider for Tar files. Provides read-only file systems.
*/
public class TgzFileProvider extends CompositeFileProvider {
+
/** The provider's capabilities */
protected static final Collection<Capability> capabilities = TarFileProvider.capabilities;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/temp/TemporaryFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/temp/TemporaryFileProvider.java
index a1994b7..dbdc626 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/temp/TemporaryFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/temp/TemporaryFileProvider.java
@@ -35,6 +35,7 @@ import org.apache.commons.vfs2.provider.local.LocalFileSystem;
* A provider for temporary files.
*/
public class TemporaryFileProvider extends AbstractFileProvider implements Comparable<Object> {
+
private File rootFile;
/*
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileName.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileName.java
index 1576ab2..ff35c31 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileName.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileName.java
@@ -23,6 +23,7 @@ import org.apache.commons.vfs2.provider.URLFileName;
* A URL FileName.
*/
public class UrlFileName extends URLFileName {
+
/**
* The constructor.
*
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileNameParser.java
index faff565..e1ea61a 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileNameParser.java
@@ -30,6 +30,7 @@ import org.apache.commons.vfs2.provider.local.GenericFileNameParser;
* Composite of URLFilenameParser and GenericFilenameParser
*/
public class UrlFileNameParser extends AbstractFileNameParser {
+
private final URLFileNameParser url = new URLFileNameParser(80);
private final GenericFileNameParser generic = new GenericFileNameParser();
@@ -65,9 +66,11 @@ public class UrlFileNameParser extends AbstractFileNameParser {
* Guess if the given file name is an URL with host or not.
* <p>
* VFS treats such URLs differently.
+ * </p>
* <p>
* A file name is URL-based if the base is a {@code URLFileName} or there are only 2 slashes after the scheme. e.g:
* {@code http://host/path}, {@code file:/path/to/file}, {@code file:///path/to/file}.
+ * </p>
*
* @param base The filename is relative to this base.
* @param filename The filename.
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 b065654..ac7fe93 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
@@ -35,8 +35,10 @@ import org.apache.commons.vfs2.provider.URLFileName;
* A {@link org.apache.commons.vfs2.FileObject FileObject} implementation backed by a {@link URL}.
* <p>
* TODO - Implement set lastModified and get/set attribute
+ * </p>
* <p>
* TODO - Implement getOutputStream().
+ * </p>
*/
public class UrlFileObject extends AbstractFileObject<UrlFileSystem> {
private URL url;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileProvider.java
index f2a0a0f..4e1a81d 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileProvider.java
@@ -34,6 +34,7 @@ import org.apache.commons.vfs2.provider.AbstractFileProvider;
* A file provider backed by Java's URL API.
*/
public class UrlFileProvider extends AbstractFileProvider {
+
/** The provider's capabilities */
protected static final Collection<Capability> capabilities = Collections.unmodifiableCollection(
Arrays.asList(new Capability[] { Capability.READ_CONTENT, Capability.URI, Capability.GET_LAST_MODIFIED }));
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileSystem.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileSystem.java
index 5f15fac..3151f4a 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileSystem.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileSystem.java
@@ -29,6 +29,7 @@ import org.apache.commons.vfs2.provider.AbstractFileSystem;
* A File system backed by Java's URL API.
*/
public class UrlFileSystem extends AbstractFileSystem {
+
protected UrlFileSystem(final FileName rootName, final FileSystemOptions fileSystemOptions) {
super(rootName, null, fileSystemOptions);
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/ExceptionConverter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/ExceptionConverter.java
index 528d5cc..12b81d7 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/ExceptionConverter.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/ExceptionConverter.java
@@ -31,6 +31,7 @@ import org.w3c.dom.Element;
* @since 2.0
*/
public final class ExceptionConverter {
+
// avoid instanciation
private ExceptionConverter() {
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileContentInfoFactory.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileContentInfoFactory.java
index 10747ba..9f12db0 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileContentInfoFactory.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileContentInfoFactory.java
@@ -34,6 +34,7 @@ import org.apache.jackrabbit.webdav.property.DavPropertySet;
* @since 2.0
*/
public class WebdavFileContentInfoFactory implements FileContentInfoFactory {
+
@Override
public FileContentInfo create(final FileContent fileContent) throws FileSystemException {
final WebdavFileObject file = (WebdavFileObject) FileObjectUtils.getAbstractFileObject(fileContent.getFile());
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileNameParser.java
index b615a8b..9dedc70 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileNameParser.java
@@ -25,6 +25,7 @@ import org.apache.commons.vfs2.provider.http.HttpFileNameParser;
* @since 2.0
*/
public class WebdavFileNameParser extends HttpFileNameParser {
+
private static final WebdavFileNameParser INSTANCE = new WebdavFileNameParser();
public WebdavFileNameParser() {
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileObject.java
index 0dc7706..21f12e6 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileObject.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileObject.java
@@ -78,10 +78,12 @@ import org.w3c.dom.Node;
* @since 2.0
*/
public class WebdavFileObject extends HttpFileObject<WebdavFileSystem> {
+
/**
* An OutputStream that writes to a Webdav resource.
* <p>
* TODO - Use piped stream to avoid temporary file.
+ * </p>
*/
private class WebdavOutputStream extends MonitorOutputStream {
private final WebdavFileObject file;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileProvider.java
index 52b80b0..bfc40b8 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileProvider.java
@@ -69,6 +69,7 @@ public class WebdavFileProvider extends HttpFileProvider {
* credentials configuration through to this method so it's used for resolving a
* {@link org.apache.commons.vfs2.FileObject FileObject} in the FileSystem, then be sure to use correct signature of
* the {@link org.apache.commons.vfs2.FileSystemManager FileSystemManager} resolveFile method.
+ * </p>
*
* @see org.apache.commons.vfs2.impl.DefaultFileSystemManager#resolveFile(FileObject, String, FileSystemOptions)
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileSystem.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileSystem.java
index 54095a1..538ffac 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileSystem.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileSystem.java
@@ -34,6 +34,7 @@ import org.apache.commons.vfs2.provider.http.HttpFileSystem;
* @since 2.0
*/
public class WebdavFileSystem extends HttpFileSystem {
+
protected WebdavFileSystem(final GenericFileName rootName, final HttpClient client,
final FileSystemOptions fileSystemOptions) {
super(rootName, client, fileSystemOptions);
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileSystemConfigBuilder.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileSystemConfigBuilder.java
index 773387b..a86fa45 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileSystemConfigBuilder.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileSystemConfigBuilder.java
@@ -26,6 +26,7 @@ import org.apache.commons.vfs2.provider.http.HttpFileSystemConfigBuilder;
* @since 2.0
*/
public final class WebdavFileSystemConfigBuilder extends HttpFileSystemConfigBuilder {
+
private static final WebdavFileSystemConfigBuilder BUILDER = new WebdavFileSystemConfigBuilder();
private static final boolean DEFAULT_FOLLOW_REDIRECT = false;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavMethodRetryHandler.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavMethodRetryHandler.java
index 50b5358..f3703b1 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavMethodRetryHandler.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavMethodRetryHandler.java
@@ -25,10 +25,12 @@ import org.apache.commons.httpclient.HttpMethodRetryHandler;
* A retry handler which will retry a failed webdav method one time.
* <p>
* Now that webdavlib didnt support adding a MethodRetryHandler only a few operations are restartable yet.
+ * </p>
*
* @since 2.0
*/
public final class WebdavMethodRetryHandler implements HttpMethodRetryHandler {
+
private static final WebdavMethodRetryHandler INSTANCE = new WebdavMethodRetryHandler();
private WebdavMethodRetryHandler() {
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileObject.java
index 22f4d9e..329ddbf 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileObject.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileObject.java
@@ -30,6 +30,7 @@ import org.apache.commons.vfs2.provider.AbstractFileObject;
* A file in a ZIP file system.
*/
public class ZipFileObject extends AbstractFileObject<ZipFileSystem> {
+
/** The ZipEntry. */
protected ZipEntry entry;
private final HashSet<String> children = new HashSet<>();
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileProvider.java
index 706b7bb..7fb9bc1 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileProvider.java
@@ -37,6 +37,7 @@ import org.apache.commons.vfs2.provider.hdfs.HdfsFileSystemConfigBuilder;
* A file system provider for ZIP files. Provides read-only file systems.
*/
public class ZipFileProvider extends AbstractLayeredFileProvider {
+
/** The list of capabilities this provider supports */
protected static final Collection<Capability> capabilities = Collections.unmodifiableCollection(Arrays
.asList(new Capability[] { Capability.GET_LAST_MODIFIED, Capability.GET_TYPE, Capability.LIST_CHILDREN,
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 77174ef..2f3ea74 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
@@ -45,6 +45,7 @@ import org.apache.commons.vfs2.provider.UriParser;
* A read-only file system for ZIP and JAR files.
*/
public class ZipFileSystem extends AbstractFileSystem {
+
private static final Log LOG = LogFactory.getLog(ZipFileSystem.class);
private final File file;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java
index 3f1b820..3bd95ac 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java
@@ -40,13 +40,15 @@ import org.apache.tools.ant.Project;
* <li>Up-to-date destination file.
* </ul>
*
- * TODO - Deal with case where dest file maps to a child of one of the source files.<br>
- * TODO - Deal with case where dest file already exists and is incorrect type (not file, not a folder).<br>
- * TODO - Use visitors.<br>
- * TODO - Add default excludes.<br>
- * TOOD - Allow selector, mapper, filters, etc to be specified.<br>
- * TODO - Handle source/dest directories as well.<br>
- * TODO - Allow selector to be specified for choosing which dest files to sync.
+ * <ul>
+ * <li>TODO - Deal with case where dest file maps to a child of one of the source files.</li>
+ * <li>TODO - Deal with case where dest file already exists and is incorrect type (not file, not a folder).</li>
+ * <li>TODO - Use visitors.</li>
+ * <li>TODO - Add default excludes.</li>
+ * <li>TOOD - Allow selector, mapper, filters, etc to be specified.</li>
+ * <li>TODO - Handle source/dest directories as well.</li>
+ * <li>TODO - Allow selector to be specified for choosing which dest files to sync.</li>
+ * <ul>
*/
public abstract class AbstractSyncTask extends VfsTask {
private final ArrayList<SourceInfo> srcFiles = new ArrayList<>();
@@ -355,8 +357,10 @@ public abstract class AbstractSyncTask extends VfsTask {
* Handles an out-of-date file.
* <p>
* This is a file where the destination file either doesn't exist, or is older than the source file.
+ * </p>
* <p>
* This implementation does nothing.
+ * </p>
*
* @param srcFile The source file.
* @param destFile The destination file.
@@ -370,8 +374,10 @@ public abstract class AbstractSyncTask extends VfsTask {
* Handles an up-to-date file.
* <p>
* This is where the destination file exists and is newer than the source file.
+ * </p>
* <p>
* This implementation does nothing.
+ * </p>
*
* @param srcFile The source file.
* @param destFile The destination file.
@@ -385,6 +391,7 @@ public abstract class AbstractSyncTask extends VfsTask {
* Handles a destination for which there is no corresponding source file.
* <p>
* This implementation does nothing.
+ * </p>
*
* @param destFile The existing destination file.
* @throws Exception Implementation can throw any Exception.
@@ -397,6 +404,7 @@ public abstract class AbstractSyncTask extends VfsTask {
* Check if this task cares about destination files with a missing source file.
* <p>
* This implementation returns false.
+ * </p>
*
* @return True if missing file is detected.
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/CopyTask.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/CopyTask.java
index 70d867b..3b55472 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/CopyTask.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/CopyTask.java
@@ -25,8 +25,10 @@ import org.apache.commons.vfs2.Selectors;
* An Ant task that copies matching files.
* <p>
* TODO - Copy folders that do not contain files.
+ * </p>
*/
public class CopyTask extends AbstractSyncTask {
+
private boolean overwrite;
private boolean preserveLastModified = true;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/DeleteTask.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/DeleteTask.java
index ec6aca9..2928201 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/DeleteTask.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/DeleteTask.java
@@ -26,6 +26,7 @@ import org.apache.tools.ant.BuildException;
* An Ant task that deletes matching files.
* <p>
* TOOD - Allow selector to be specified.
+ * </p>
*/
public class DeleteTask extends VfsTask {
private String file;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/MkdirTask.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/MkdirTask.java
index 8819535..88d97a2 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/MkdirTask.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/MkdirTask.java
@@ -25,6 +25,7 @@ import org.apache.tools.ant.BuildException;
* An Ant task that creates a directory.
*/
public class MkdirTask extends VfsTask {
+
private String dirName;
/**
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/MoveTask.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/MoveTask.java
index 64070b9..fcb72c6 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/MoveTask.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/MoveTask.java
@@ -25,6 +25,7 @@ import org.apache.commons.vfs2.Selectors;
* An Ant task that moves matching files.
* <p>
* TODO - Delete matching folders.
+ * </p>
*/
public class MoveTask extends CopyTask {
private boolean tryRename;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/ShowFileTask.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/ShowFileTask.java
index 809ba20..14a86bb 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/ShowFileTask.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/ShowFileTask.java
@@ -29,6 +29,7 @@ import org.apache.tools.ant.BuildException;
* An Ant task that writes the details of a file to Ant's log.
*/
public class ShowFileTask extends VfsTask {
+
private static final String INDENT = " ";
private String url;
private boolean showContent;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/SyncTask.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/SyncTask.java
index b043311..a424326 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/SyncTask.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/SyncTask.java
@@ -22,6 +22,7 @@ import org.apache.commons.vfs2.FileObject;
* A task that synchronises the destination folder to look exactly like the source folder (or folders).
*/
public class SyncTask extends CopyTask {
+
/**
* Handles a destination for which there is no corresponding source file.
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/VfsTask.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/VfsTask.java
index f30c4d2..57e9858 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/VfsTask.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/VfsTask.java
@@ -30,6 +30,7 @@ import org.apache.tools.ant.Task;
* the build. Also provides some utility methods.
*/
public class VfsTask extends Task {
+
private static StandardFileSystemManager manager;
/**
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 e65b017..550c4a5 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
@@ -27,6 +27,7 @@ import java.util.ResourceBundle;
* @since 2.0
*/
public class CombinedResources extends ResourceBundle {
+
// locale.getLanguage()
// locale.getCountry()
// locale.getVariant()
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/Cryptor.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/Cryptor.java
index 86cc4c7..da396f9 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/Cryptor.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/Cryptor.java
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2.util;
* @since 2.0
*/
public interface Cryptor {
+
/**
* Encrypt the plain text password.
*
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/CryptorFactory.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/CryptorFactory.java
index ee0d2df..3938c38 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/CryptorFactory.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/CryptorFactory.java
@@ -22,6 +22,7 @@ package org.apache.commons.vfs2.util;
* @since 2.0
*/
public final class CryptorFactory {
+
/**
* The System property name to identify the Cryptor class to be used.
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/DefaultCryptor.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/DefaultCryptor.java
index 32d5080..3d6b754 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/DefaultCryptor.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/DefaultCryptor.java
@@ -24,6 +24,7 @@ import javax.crypto.spec.SecretKeySpec;
* <p>
* Warning: This uses AES128 with a fixed encryption key. This is only an obfuscation no cryptographic secure
* protection.
+ * </p>
*
* @since 2.0
*/
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 8cf9c94..e960c57 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
@@ -35,9 +35,10 @@ import org.apache.commons.vfs2.FileSystemManager;
import org.apache.commons.vfs2.FileSystemOptions;
/**
- * This class use reflection to set a configuration value using the fileSystemConfigBuilder associated the a scheme.<br>
- * <br>
- * Example:<br>
+ * This class use reflection to set a configuration value using the fileSystemConfigBuilder associated the a scheme.
+ * <p>
+ * Example:
+ * </p>
*
* <pre>
* FileSystemOptions fso = new FileSystemOptions();
@@ -48,6 +49,7 @@ import org.apache.commons.vfs2.FileSystemOptions;
* </pre>
*/
public class DelegatingFileSystemOptionsBuilder {
+
@SuppressWarnings("unchecked") // OK, it is a String
private static final Class<String>[] STRING_PARAM = new Class[] { String.class };
private static final Map<String, Class<?>> PRIMATIVE_TO_OBJECT = new TreeMap<>();
@@ -89,8 +91,10 @@ public class DelegatingFileSystemOptionsBuilder {
}
/**
- * Constructor.<br>
+ * Constructor.
+ * <p>
* Pass in your fileSystemManager instance.
+ * </p>
*
* @param manager the manager to use to get the fileSystemConfigBuilder assocated to a scheme
*/
@@ -103,7 +107,7 @@ public class DelegatingFileSystemOptionsBuilder {
}
/**
- * Set a single string value.
+ * Sets a single string value.
*
* @param fso FileSystemOptions
* @param scheme scheme
@@ -117,7 +121,7 @@ public class DelegatingFileSystemOptionsBuilder {
}
/**
- * Set an array of string value.
+ * Sets an array of string value.
*
* @param fso FileSystemOptions
* @param scheme scheme
@@ -133,8 +137,10 @@ public class DelegatingFileSystemOptionsBuilder {
}
/**
- * Set a single class value.<br>
+ * Sets a single class value.
+ * <p>
* The class has to implement a no-args constructor, else the instantiation might fail.
+ * </p>
*
* @param fso FileSystemOptions
* @param scheme scheme
@@ -150,8 +156,10 @@ public class DelegatingFileSystemOptionsBuilder {
}
/**
- * Set an array of class values.<br>
+ * Sets an array of class values.
+ * <p>
* The class has to implement a no-args constructor, else the instantiation might fail.
+ * </p>
*
* @param fso FileSystemOptions
* @param scheme scheme
@@ -174,7 +182,7 @@ public class DelegatingFileSystemOptionsBuilder {
}
/**
- * sets the values using the informations of the given context.<br>
+ * Sets the values using the informations of the given context.
*/
private void setValues(final Context ctx) throws FileSystemException {
// find all setter methods suitable for the given "name"
@@ -198,7 +206,7 @@ public class DelegatingFileSystemOptionsBuilder {
}
/**
- * tries to convert the value and pass it to the given method
+ * Tries to convert the value and pass it to the given method
*/
private boolean convertValuesAndInvoke(final Method configSetter, final Context ctx) throws FileSystemException {
final Class<?>[] parameters = configSetter.getParameterTypes();
@@ -300,7 +308,7 @@ public class DelegatingFileSystemOptionsBuilder {
}
/**
- * invokes the method with the converted values
+ * Invokes the method with the converted values
*/
private void invokeSetter(final Class<?> valueParameter, final Context ctx, final Method configSetter,
final Object values) throws FileSystemException {
@@ -320,7 +328,7 @@ public class DelegatingFileSystemOptionsBuilder {
}
/**
- * fills all available set*() methods for the context-scheme into the context.
+ * Fills all available set*() methods for the context-scheme into the context.
*/
private boolean fillConfigSetters(final Context ctx) throws FileSystemException {
final Map<String, List<Method>> schemeMethods = getSchemeMethods(ctx.scheme);
@@ -334,7 +342,7 @@ public class DelegatingFileSystemOptionsBuilder {
}
/**
- * get (cached) list of set*() methods for the given scheme
+ * Gets (cached) list of set*() methods for the given scheme
*/
private Map<String, List<Method>> getSchemeMethods(final String scheme) throws FileSystemException {
Map<String, List<Method>> schemeMethods = beanMethods.get(scheme);
@@ -347,7 +355,7 @@ public class DelegatingFileSystemOptionsBuilder {
}
/**
- * create the list of all set*() methods for the given scheme
+ * Creates the list of all set*() methods for the given scheme
*/
private Map<String, List<Method>> createSchemeMethods(final String scheme) throws FileSystemException {
final FileSystemConfigBuilder fscb = getManager().getFileSystemConfigBuilder(scheme);
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/EncryptUtil.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/EncryptUtil.java
index f5fe850..b7d3607 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/EncryptUtil.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/EncryptUtil.java
@@ -22,6 +22,7 @@ package org.apache.commons.vfs2.util;
* @since 2.0
*/
public final class EncryptUtil {
+
/**
* Don't allow class instantiation.
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/Messages.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/Messages.java
index 16b653f..1289cf5 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/Messages.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/Messages.java
@@ -26,6 +26,7 @@ import java.util.concurrent.ConcurrentMap;
* Formats messages.
*/
public final class Messages {
+
/**
* Map from message code to MessageFormat object for the message.
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorInputStream.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorInputStream.java
index a7bd8fd..d6b1041 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorInputStream.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorInputStream.java
@@ -26,6 +26,7 @@ import java.util.concurrent.atomic.AtomicLong;
* An InputStream that provides buffering and end-of-stream monitoring.
*/
public class MonitorInputStream extends BufferedInputStream {
+
private static final int EOF_CHAR = -1;
private final AtomicBoolean finished = new AtomicBoolean(false);
private final AtomicLong atomicCount = new AtomicLong(0);
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorOutputStream.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorOutputStream.java
index 3e98194..2cfb104 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorOutputStream.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorOutputStream.java
@@ -27,6 +27,7 @@ import org.apache.commons.vfs2.FileSystemException;
* An OutputStream that provides buffering and end-of-stream monitoring.
*/
public class MonitorOutputStream extends BufferedOutputStream {
+
private final AtomicBoolean finished = new AtomicBoolean(false);
/**
@@ -146,6 +147,7 @@ public class MonitorOutputStream extends BufferedOutputStream {
* <p>
* This is a workaround for an oddity with Java's BufferedOutputStream where you can write to even if the stream has
* been closed.
+ * </p>
*
* @throws FileSystemException if already closed.
* @since 2.0
@@ -160,6 +162,7 @@ public class MonitorOutputStream extends BufferedOutputStream {
* Called after this stream is closed.
* <p>
* This implementation does nothing.
+ * </p>
*
* @throws IOException if an error occurs.
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorRandomAccessContent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorRandomAccessContent.java
index 7b7b94e..cb54b2e 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorRandomAccessContent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorRandomAccessContent.java
@@ -25,6 +25,7 @@ import org.apache.commons.vfs2.RandomAccessContent;
* A RandomAccessContent that provides end-of-stream monitoring.
*/
public class MonitorRandomAccessContent implements RandomAccessContent {
+
private final RandomAccessContent content;
private boolean finished;
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 e60c011..db2d6bc 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
@@ -27,6 +27,7 @@ import java.util.Set;
* Class to help determining the OS.
*/
public final class Os {
+
/**
* All Windows based OSes.
*/
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 44b61e8..553aef7 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
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2.util;
* An enumerated type, which represents an OS family.
*/
public final class OsFamily {
+
private final String name;
private final OsFamily[] 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 d37e62c..1c480dd 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
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2.util;
* An enumerated type representing the modes of a random access content.
*/
public enum RandomAccessMode {
+
/**
* read.
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/URIBitSets.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/URIBitSets.java
index d79cf56..edb1069 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/URIBitSets.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/URIBitSets.java
@@ -26,6 +26,7 @@ import org.apache.commons.vfs2.provider.GenericURLFileName;
* This was forked from the {@link BitSet}s in <code>org.apache.commons.httpclient.URI</code>,
* in order to not be dependent on HttpClient v3 API, when generating and handling {@link GenericURLFileName}s,
* but it should work with any different HTTP backend provider implementations.
+ * </p>
*/
class URIBitSets {
@@ -48,7 +49,7 @@ class URIBitSets {
* <p><blockquote><pre>
* digit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" |
* "8" | "9"
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet digit = new BitSet(256);
// Static initializer for digit
@@ -63,7 +64,7 @@ class URIBitSets {
* BitSet for alpha.
* <p><blockquote><pre>
* alpha = lowalpha | upalpha
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet alpha = new BitSet(256);
// Static initializer for alpha
@@ -81,7 +82,7 @@ class URIBitSets {
* BitSet for alphanum (join of alpha & digit).
* <p><blockquote><pre>
* alphanum = alpha | digit
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet alphanum = new BitSet(256);
// Static initializer for alphanum
@@ -96,7 +97,7 @@ class URIBitSets {
* <p><blockquote><pre>
* hex = digit | "A" | "B" | "C" | "D" | "E" | "F" |
* "a" | "b" | "c" | "d" | "e" | "f"
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet hex = new BitSet(256);
// Static initializer for hex
@@ -115,7 +116,7 @@ class URIBitSets {
* BitSet for escaped.
* <p><blockquote><pre>
* escaped = "%" hex hex
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet escaped = new BitSet(256);
// Static initializer for escaped
@@ -130,7 +131,7 @@ class URIBitSets {
* <p><blockquote><pre>
* mark = "-" | "_" | "." | "!" | "~" | "*" | "'" |
* "(" | ")"
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet mark = new BitSet(256);
// Static initializer for mark
@@ -152,7 +153,7 @@ class URIBitSets {
* purpose are called unreserved.
* <p><blockquote><pre>
* unreserved = alphanum | mark
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet unreserved = new BitSet(256);
// Static initializer for unreserved
@@ -167,7 +168,7 @@ class URIBitSets {
* <p><blockquote><pre>
* reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
* "$" | ","
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet reserved = new BitSet(256);
// Static initializer for reserved
@@ -189,7 +190,7 @@ class URIBitSets {
* BitSet for uric.
* <p><blockquote><pre>
* uric = reserved | unreserved | escaped
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet uric = new BitSet(256);
// Static initializer for uric
@@ -204,7 +205,7 @@ class URIBitSets {
* BitSet for fragment (alias for uric).
* <p><blockquote><pre>
* fragment = *uric
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet fragment = uric;
@@ -213,7 +214,7 @@ class URIBitSets {
* BitSet for query (alias for uric).
* <p><blockquote><pre>
* query = *uric
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet query = uric;
@@ -223,7 +224,7 @@ class URIBitSets {
* <p><blockquote><pre>
* pchar = unreserved | escaped |
* ":" | "@" | "&" | "=" | "+" | "$" | ","
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet pchar = new BitSet(256);
// Static initializer for pchar
@@ -244,7 +245,7 @@ class URIBitSets {
* BitSet for param (alias for pchar).
* <p><blockquote><pre>
* param = *pchar
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet param = pchar;
@@ -253,7 +254,7 @@ class URIBitSets {
* BitSet for segment.
* <p><blockquote><pre>
* segment = *pchar *( ";" param )
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet segment = new BitSet(256);
// Static initializer for segment
@@ -268,7 +269,7 @@ class URIBitSets {
* BitSet for path segments.
* <p><blockquote><pre>
* path_segments = segment *( "/" segment )
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet path_segments = new BitSet(256);
// Static initializer for path_segments
@@ -282,7 +283,7 @@ class URIBitSets {
* URI absolute path.
* <p><blockquote><pre>
* abs_path = "/" path_segments
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet abs_path = new BitSet(256);
// Static initializer for abs_path
@@ -297,7 +298,7 @@ class URIBitSets {
* <p><blockquote><pre>
* uric_no_slash = unreserved | escaped | ";" | "?" | ":" | "@" |
* "&" | "=" | "+" | "$" | ","
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet uric_no_slash = new BitSet(256);
// Static initializer for uric_no_slash
@@ -320,7 +321,7 @@ class URIBitSets {
* URI bitset that combines uric_no_slash and uric.
* <p><blockquote><pre>
* opaque_part = uric_no_slash *uric
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet opaque_part = new BitSet(256);
// Static initializer for opaque_part
@@ -335,7 +336,7 @@ class URIBitSets {
* URI bitset that combines absolute path and opaque part.
* <p><blockquote><pre>
* path = [ abs_path | opaque_part ]
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet path = new BitSet(256);
// Static initializer for path
@@ -355,7 +356,7 @@ class URIBitSets {
* Bitset that combines digit and dot fo IPv$address.
* <p><blockquote><pre>
* IPv4address = 1*digit "." 1*digit "." 1*digit "." 1*digit
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet IPv4address = new BitSet(256);
// Static initializer for IPv4address
@@ -369,7 +370,7 @@ class URIBitSets {
* RFC 2373.
* <p><blockquote><pre>
* IPv6address = hexpart [ ":" IPv4address ]
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet IPv6address = new BitSet(256);
// Static initializer for IPv6address reference
@@ -384,7 +385,7 @@ class URIBitSets {
* RFC 2732, 2373.
* <p><blockquote><pre>
* IPv6reference = "[" IPv6address "]"
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet IPv6reference = new BitSet(256);
// Static initializer for IPv6reference
@@ -399,7 +400,7 @@ class URIBitSets {
* BitSet for toplabel.
* <p><blockquote><pre>
* toplabel = alpha | alpha *( alphanum | "-" ) alphanum
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet toplabel = new BitSet(256);
// Static initializer for toplabel
@@ -413,7 +414,7 @@ class URIBitSets {
* BitSet for domainlabel.
* <p><blockquote><pre>
* domainlabel = alphanum | alphanum *( alphanum | "-" ) alphanum
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet domainlabel = toplabel;
@@ -422,7 +423,7 @@ class URIBitSets {
* BitSet for hostname.
* <p><blockquote><pre>
* hostname = *( domainlabel "." ) toplabel [ "." ]
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet hostname = new BitSet(256);
// Static initializer for hostname
@@ -437,7 +438,7 @@ class URIBitSets {
* BitSet for host.
* <p><blockquote><pre>
* host = hostname | IPv4address | IPv6reference
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet host = new BitSet(256);
// Static initializer for host
@@ -452,7 +453,7 @@ class URIBitSets {
* BitSet for hostport.
* <p><blockquote><pre>
* hostport = host [ ":" port ]
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet hostport = new BitSet(256);
// Static initializer for hostport
@@ -468,7 +469,7 @@ class URIBitSets {
* <p><blockquote><pre>
* userinfo = *( unreserved | escaped |
* ";" | ":" | "&" | "=" | "+" | "$" | "," )
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet userinfo = new BitSet(256);
// Static initializer for userinfo
@@ -504,7 +505,7 @@ class URIBitSets {
* Bitset for server.
* <p><blockquote><pre>
* server = [ [ userinfo "@" ] hostport ]
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet server = new BitSet(256);
// Static initializer for server
@@ -520,7 +521,7 @@ class URIBitSets {
* <p><blockquote><pre>
* reg_name = 1*( unreserved | escaped | "$" | "," |
* ";" | ":" | "@" | "&" | "=" | "+" )
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet reg_name = new BitSet(256);
// Static initializer for reg_name
@@ -542,7 +543,7 @@ class URIBitSets {
* BitSet for authority.
* <p><blockquote><pre>
* authority = server | reg_name
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet authority = new BitSet(256);
// Static initializer for authority
@@ -556,7 +557,7 @@ class URIBitSets {
* BitSet for scheme.
* <p><blockquote><pre>
* scheme = alpha *( alpha | digit | "+" | "-" | "." )
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet scheme = new BitSet(256);
// Static initializer for scheme
@@ -574,7 +575,7 @@ class URIBitSets {
* <p><blockquote><pre>
* rel_segment = 1*( unreserved | escaped |
* ";" | "@" | "&" | "=" | "+" | "$" | "," )
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet rel_segment = new BitSet(256);
// Static initializer for rel_segment
@@ -595,7 +596,7 @@ class URIBitSets {
* BitSet for rel_path.
* <p><blockquote><pre>
* rel_path = rel_segment [ abs_path ]
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet rel_path = new BitSet(256);
// Static initializer for rel_path
@@ -609,7 +610,7 @@ class URIBitSets {
* BitSet for net_path.
* <p><blockquote><pre>
* net_path = "//" authority [ abs_path ]
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet net_path = new BitSet(256);
// Static initializer for net_path
@@ -624,7 +625,7 @@ class URIBitSets {
* BitSet for hier_part.
* <p><blockquote><pre>
* hier_part = ( net_path | abs_path ) [ "?" query ]
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet hier_part = new BitSet(256);
// Static initializer for hier_part
@@ -640,7 +641,7 @@ class URIBitSets {
* BitSet for relativeURI.
* <p><blockquote><pre>
* relativeURI = ( net_path | abs_path | rel_path ) [ "?" query ]
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet relativeURI = new BitSet(256);
// Static initializer for relativeURI
@@ -657,7 +658,7 @@ class URIBitSets {
* BitSet for absoluteURI.
* <p><blockquote><pre>
* absoluteURI = scheme ":" ( hier_part | opaque_part )
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet absoluteURI = new BitSet(256);
// Static initializer for absoluteURI
@@ -673,7 +674,7 @@ class URIBitSets {
* BitSet for URI-reference.
* <p><blockquote><pre>
* URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]
- * </pre></blockquote><p>
+ * </pre></blockquote></p>
*/
protected static final BitSet URI_reference = new BitSet(256);
// Static initializer for URI_reference
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 80c64cd..8c26aee 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
@@ -27,10 +27,11 @@ import org.apache.commons.vfs2.provider.GenericURLFileName;
/**
* The URI escape and character encoding and decoding utility.
- * <P>
+ * <p>
* This was forked from some needed methods such as <code>#encodePath(...)</code> in <code>org.apache.commons.httpclient.util.URIUtil</code>,
* in order to not be dependent on HttpClient v3 API, when generating and handling {@link GenericURLFileName}s,
* but it should work with any different HTTP backend provider implementations.
+ * </p>
*/
public class URIUtils {
@@ -82,10 +83,11 @@ public class URIUtils {
/**
* Internal URL codec utilities.
- * <P>
+ * <p>
* This was forked from some needed methods such as <code>#encodeUrl(...)</code> and <code>#hexDigit(int)</code>
* in <code>org.apache.commons.codec.net.URLCodec</code>, as commons-codec library cannot be pulled in transitively
* via Http Client v3 library any more.
+ * </p>
*/
private static class URLCodecUtils {
@@ -160,11 +162,12 @@ public class URIUtils {
/**
* Internal character encoding utilities.
- * <P>
+ * <p>
* This was forked from some needed methods such as <code>#getBytes(...)</code> and <code>#getAsciiString(...)</code>
* in <code>org.apache.commons.httpclient.util.EncodingUtil</code>,
* in order to not be dependent on HttpClient v3 API, when generating and handling {@link GenericURLFileName}s,
* but it should work with any different HTTP backend provider implementations.
+ * </p>
*/
private static class EncodingUtils {
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/UserAuthenticatorUtils.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/UserAuthenticatorUtils.java
index 424199d..ca48fee 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/UserAuthenticatorUtils.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/UserAuthenticatorUtils.java
@@ -25,6 +25,7 @@ import org.apache.commons.vfs2.impl.DefaultFileSystemConfigBuilder;
* Helps with authentication.
*/
public final class UserAuthenticatorUtils {
+
private UserAuthenticatorUtils() {
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/WeakRefFileListener.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/WeakRefFileListener.java
index 00c59db..7340cda 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/WeakRefFileListener.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/WeakRefFileListener.java
@@ -30,6 +30,7 @@ import org.apache.commons.vfs2.FileSystem;
* @since 2.0
*/
public class WeakRefFileListener implements FileListener {
+
private final FileSystem fs;
private final FileName name;
private final WeakReference<FileListener> listener;
@@ -102,6 +103,7 @@ public class WeakRefFileListener implements FileListener {
* Called when a file is changed.
* <p>
* This will only happen if you monitor the file using {@link org.apache.commons.vfs2.FileMonitor}.
+ * </p>
*
* @param event The FileChangeEvent.
* @throws Exception if an error occurs.
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/AgeFileFilterTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/AgeFileFilterTest.java
index 6f22987..8cf999d 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/AgeFileFilterTest.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/AgeFileFilterTest.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/AndFileFilterTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/AndFileFilterTest.java
index 6ca9da0..d67ceae 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/AndFileFilterTest.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/AndFileFilterTest.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/BaseFilterTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/BaseFilterTest.java
index 2886fef..fee5642 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/BaseFilterTest.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/BaseFilterTest.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -45,9 +45,9 @@ public abstract class BaseFilterTest {
/**
* Creates a file select info object for the given file.
- *
+ *
* @param file File to create an info for.
- *
+ *
* @return File selct info.
*/
protected static FileSelectInfo createFileSelectInfo(final File file) {
@@ -81,11 +81,11 @@ public abstract class BaseFilterTest {
/**
* Returns a ZIP file object.
- *
+ *
* @param file File to resolve.
- *
+ *
* @return File object.
- *
+ *
* @throws FileSystemException Error resolving the file.
*/
protected static FileObject getZipFileObject(final File file) throws FileSystemException {
@@ -95,7 +95,7 @@ public abstract class BaseFilterTest {
/**
* Asserts that the array contains the given file names.
- *
+ *
* @param files Array to check.
* @param filenames File names to find.
*/
@@ -119,7 +119,7 @@ public abstract class BaseFilterTest {
/**
* Returns the temporary directory.
- *
+ *
* @return java.io.tmpdir
*/
protected static File getTempDir() {
@@ -128,9 +128,9 @@ public abstract class BaseFilterTest {
/**
* Returns a sub directory of the temporary directory.
- *
+ *
* @param name Name of the sub directory.
- *
+ *
* @return Sub directory of java.io.tmpdir.
*/
protected static File getTestDir(final String name) {
@@ -139,7 +139,7 @@ public abstract class BaseFilterTest {
/**
* Verifies at least all given objects are in the list.
- *
+ *
* @param list List to use.
* @param objects Objects to find.
*/
@@ -151,7 +151,7 @@ public abstract class BaseFilterTest {
/**
* Verifies only the given objects are in the list.
- *
+ *
* @param list List to scan.
* @param objects Objects to find.
*/
@@ -164,11 +164,11 @@ public abstract class BaseFilterTest {
/**
* Adds a file to a ZIP output stream.
- *
+ *
* @param srcFile File to add - Cannot be <code>null</code>.
* @param destPath Path to use for the file - May be <code>null</code> or empty.
* @param out Destination stream - Cannot be <code>null</code>.
- *
+ *
* @throws IOException Error writing to the output stream.
*/
private static void zipFile(final File srcFile, final String destPath, final ZipOutputStream out)
@@ -189,14 +189,14 @@ public abstract class BaseFilterTest {
/**
* Add a directory to a ZIP output stream.
- *
+ *
* @param srcDir Directory to add - Cannot be <code>null</code> and must be a
* valid directory.
* @param filter Filter or <code>null</code> for all files.
* @param destPath Path to use for the ZIP archive - May be <code>null</code> or
* an empyt string.
* @param out Destination stream - Cannot be <code>null</code>.
- *
+ *
* @throws IOException Error writing to the output stream.
*/
private static void zipDir(final File srcDir, final FileFilter filter, final String destPath,
@@ -217,14 +217,14 @@ public abstract class BaseFilterTest {
* Creates a ZIP file and adds all files in a directory and all it's sub
* directories to the archive. Only entries are added that comply to the file
* filter.
- *
+ *
* @param srcDir Directory to add - Cannot be <code>null</code> and must be a
* valid directory.
* @param filter Filter or <code>null</code> for all files/directories.
* @param destPath Path to use for the ZIP archive - May be <code>null</code> or
* an empyt string.
* @param destFile Target ZIP file - Cannot be <code>null</code>.
- *
+ *
* @throws IOException Error writing to the output stream.
*/
public static void zipDir(final File srcDir, final FileFilter filter, final String destPath, final File destFile)
@@ -252,13 +252,13 @@ public abstract class BaseFilterTest {
/**
* Creates a ZIP file and adds all files in a directory and all it's sub
* directories to the archive.
- *
+ *
* @param srcDir Directory to add - Cannot be <code>null</code> and must be a
* valid directory.
* @param destPath Path to use for the ZIP archive - May be <code>null</code> or
* an empyt string.
* @param destFile Target ZIP file - Cannot be <code>null</code>.
- *
+ *
* @throws IOException Error writing to the output stream.
*/
public static void zipDir(final File srcDir, final String destPath, final File destFile) throws IOException {
@@ -270,12 +270,12 @@ public abstract class BaseFilterTest {
/**
* Concatenate a path and a filename taking <code>null</code> and empty string
* values into account.
- *
+ *
* @param path Path - Can be <code>null</code> or an empty string.
* @param filename Filename - Cannot be <code>null</code>.
* @param separator Separator for directories - Can be <code>null</code> or an
* empty string.
- *
+ *
* @return Path and filename divided by the separator.
*/
public static String concatPathAndFilename(final String path, final String filename, final String separator) {
@@ -310,11 +310,11 @@ public abstract class BaseFilterTest {
/**
* List all files for a directory.
- *
+ *
* @param srcDir Directory to list the files for - Cannot be <code>null</code>
* and must be a valid directory.
* @param filter Filter or <code>null</code> for all files.
- *
+ *
* @return List of child entries of the directory.
*/
private static File[] listFiles(final File srcDir, final FileFilter filter) {
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/CanExecuteFileFilterTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/CanExecuteFileFilterTest.java
index f655b72..9a28a1b 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/CanExecuteFileFilterTest.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/CanExecuteFileFilterTest.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/CanReadFileFilterTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/CanReadFileFilterTest.java
index d96fe4e..1ec9f6d 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/CanReadFileFilterTest.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/CanReadFileFilterTest.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/CanWriteFileFilterTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/CanWriteFileFilterTest.java
index 080b561..6805b00 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/CanWriteFileFilterTest.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/CanWriteFileFilterTest.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/DirectoryAndFileFilterTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/DirectoryAndFileFilterTest.java
index 37bf8cc..f7964b1 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/DirectoryAndFileFilterTest.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/DirectoryAndFileFilterTest.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/EmptyFileFilterTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/EmptyFileFilterTest.java
index c9242c7..bf25a05 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/EmptyFileFilterTest.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/EmptyFileFilterTest.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/HiddenFileFilterTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/HiddenFileFilterTest.java
index 5b168a8..4b6803d 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/HiddenFileFilterTest.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/HiddenFileFilterTest.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/NameFileFilterTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/NameFileFilterTest.java
index 0e1a385..30063be 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/NameFileFilterTest.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/NameFileFilterTest.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/NotFileFilterTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/NotFileFilterTest.java
index 329a432..891ab24 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/NotFileFilterTest.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/NotFileFilterTest.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/OrFileFilterTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/OrFileFilterTest.java
index f8f4dd5..29a1a43 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/OrFileFilterTest.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/OrFileFilterTest.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/PrefixFileFilterTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/PrefixFileFilterTest.java
index deaae5f..552d57f 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/PrefixFileFilterTest.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/PrefixFileFilterTest.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/RegexFileFilterTestCase.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/RegexFileFilterTestCase.java
index cab20ff..789d115 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/RegexFileFilterTestCase.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/RegexFileFilterTestCase.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/SizeFileFilterTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/SizeFileFilterTest.java
index fe5ffcd..1c39286 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/SizeFileFilterTest.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/SizeFileFilterTest.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/SuffixFileFilterTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/SuffixFileFilterTest.java
index 3c7341f..865c8f5 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/SuffixFileFilterTest.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/SuffixFileFilterTest.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/WildcardFileFilterTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/WildcardFileFilterTest.java
index cd9799c..36d3458 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/WildcardFileFilterTest.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/filter/WildcardFileFilterTest.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/impl/test/DefaultFileMonitorTests.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/impl/test/DefaultFileMonitorTests.java
index 5055292..2469617 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/impl/test/DefaultFileMonitorTests.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/impl/test/DefaultFileMonitorTests.java
@@ -31,6 +31,7 @@ import org.apache.commons.vfs2.impl.DefaultFileMonitor;
* Test to verify DefaultFileMonitor
*/
public class DefaultFileMonitorTests extends AbstractVfsTestCase {
+
private FileSystemManager fsManager;
private File testDir;
private int changeStatus = 0;
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/impl/test/DefaultFileSystemManagerTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/impl/test/DefaultFileSystemManagerTest.java
index 6fe458c..5f228ca 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/impl/test/DefaultFileSystemManagerTest.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/impl/test/DefaultFileSystemManagerTest.java
@@ -25,6 +25,7 @@ import org.apache.commons.vfs2.VFS;
import org.junit.Test;
public class DefaultFileSystemManagerTest {
+
@Test(expected = NullPointerException.class)
public void testResolveFileRelativeThrows() throws FileSystemException {
VFS.getManager().resolveFile((File) null, "relativePath");
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/impl/test/VfsClassLoaderTests.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/impl/test/VfsClassLoaderTests.java
index f0ca9b3..8df392b 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/impl/test/VfsClassLoaderTests.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/impl/test/VfsClassLoaderTests.java
@@ -36,6 +36,7 @@ import org.apache.commons.vfs2.test.AbstractProviderTestCase;
* VfsClassLoader test cases.
*/
public class VfsClassLoaderTests extends AbstractProviderTestCase {
+
/**
* Returns the capabilities required by the tests of this test case.
*/
@@ -96,6 +97,7 @@ public class VfsClassLoaderTests extends AbstractProviderTestCase {
* <p>
* This is run for all providers, but only when a local provider is present and jar extension is registered it will
* actually carry out all tests.
+ * </p>
*/
public void testGetResourcesJARs() throws Exception {
final FileSystemManager manager = getManager();
@@ -144,6 +146,7 @@ public class VfsClassLoaderTests extends AbstractProviderTestCase {
* Tests retrieving resources (from local directory with .jar extension).
* <p>
* This test is repeated with various provider configurations but works on local files, only.
+ * </p>
*/
public void testGetResourcesNoLayerLocal() throws Exception {
final FileSystemManager manager = getManager();
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/ram/test/CustomRamProviderTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/ram/test/CustomRamProviderTest.java
index ab64a4b..ef4c4ee 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/ram/test/CustomRamProviderTest.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/ram/test/CustomRamProviderTest.java
@@ -246,7 +246,7 @@ public class CustomRamProviderTest {
// Expected
}
}
-
+
/**
* Tests VFS-625.
* @throws FileSystemException
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/test/AbstractProviderTestCase.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/test/AbstractProviderTestCase.java
index 9fb630f..a7afba5 100644
--- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/test/AbstractProviderTestCase.java
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/test/AbstractProviderTestCase.java
@@ -170,8 +170,11 @@ public abstract class AbstractProviderTestCase extends AbstractVfsTestCase {
* Runs the test. This implementation short-circuits the test if the provider being tested does not have the
* capabilities required by this test.
* <p>
- * TODO - Handle negative caps as well - ie, only run a test if the provider does not have certain caps.<br>
+ * TODO - Handle negative caps as well - ie, only run a test if the provider does not have certain caps.
+ * </p>
+ * <p>
* TODO - Figure out how to remove the test from the TestResult if the test is skipped.
+ * </p>
*/
@Override
protected void runTest() throws Throwable {