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 4825a42 Javadoc: Use "file system" instead of "filesystem". Camel-case "fileSystem". 4825a42 is described below commit 4825a42ceb33dc90e7cd160d4f89689246630315 Author: Gary Gregory <gardgreg...@gmail.com> AuthorDate: Thu May 30 14:07:26 2019 -0400 Javadoc: Use "file system" instead of "filesystem". Camel-case "fileSystem". --- .../commons/vfs2/provider/mime/MimeFileProvider.java | 2 +- .../commons/vfs2/provider/smb/SmbFileProvider.java | 2 +- .../java/org/apache/commons/vfs2/Capability.java | 2 +- .../org/apache/commons/vfs2/FileSystemManager.java | 4 ++-- .../java/org/apache/commons/vfs2/FilesCache.java | 8 ++++---- .../apache/commons/vfs2/cache/SoftRefFilesCache.java | 2 +- .../commons/vfs2/impl/DefaultFileSystemManager.java | 20 ++++++++++---------- .../commons/vfs2/impl/VirtualFileProvider.java | 6 +++--- .../commons/vfs2/provider/AbstractFileProvider.java | 6 +++--- .../apache/commons/vfs2/provider/FileProvider.java | 2 +- 10 files changed, 27 insertions(+), 27 deletions(-) diff --git a/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/mime/MimeFileProvider.java b/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/mime/MimeFileProvider.java index e0f0524..a7888ad 100644 --- a/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/mime/MimeFileProvider.java +++ b/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/mime/MimeFileProvider.java @@ -44,7 +44,7 @@ public class MimeFileProvider extends AbstractLayeredFileProvider implements Fil } /** - * Creates the filesystem. + * Creates the file system. */ @Override protected FileSystem doCreateFileSystem(final String scheme, final FileObject file, diff --git a/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileProvider.java b/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileProvider.java index bab43ec..1949f48 100644 --- a/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileProvider.java +++ b/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileProvider.java @@ -50,7 +50,7 @@ public class SmbFileProvider extends AbstractOriginatingFileProvider implements } /** - * Creates the filesystem. + * Creates the file system. */ @Override protected FileSystem doCreateFileSystem(final FileName name, final FileSystemOptions fileSystemOptions) diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/Capability.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/Capability.java index 431d7cd..2ea6f65 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/Capability.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/Capability.java @@ -138,7 +138,7 @@ public enum Capability { DISPATCHER, /** - * A compressed filesystem is a file system which use compression. + * A compressed file system is a file system which use compression. */ COMPRESS, diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemManager.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemManager.java index 5eae5e3..5f9d773 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemManager.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemManager.java @@ -89,9 +89,9 @@ public interface FileSystemManager { * If you use VFS as singleton it is VERY dangerous to call this method. * </p> * - * @param filesystem The FileSystem to close. + * @param fileSystem The FileSystem to close. */ - void closeFileSystem(FileSystem filesystem); + void closeFileSystem(FileSystem fileSystem); /** * Creates a layered file system. A layered file system is a file system that is created from the contents of a diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FilesCache.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FilesCache.java index 82771b8..3ab742d 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FilesCache.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FilesCache.java @@ -39,11 +39,11 @@ public interface FilesCache { /** * Retrieves a FileObject from the cache by name. * - * @param filesystem The FileSystem. + * @param file system The FileSystem. * @param name the name * @return the file object or null if file is not cached */ - FileObject getFile(final FileSystem filesystem, final FileName name); + FileObject getFile(final FileSystem fileSystem, final FileName name); /** * Purges the entries corresponding to the FileSystem. @@ -60,10 +60,10 @@ public interface FilesCache { /** * Removes a file from cache. * - * @param filesystem filesystem + * @param fileSystem file system * @param name filename */ - void removeFile(final FileSystem filesystem, final FileName name); + void removeFile(final FileSystem fileSystem, final FileName name); /** * If the cache uses timestamps it could use this method to handle updates of them. 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 d96a35e..9ca6295 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 @@ -247,7 +247,7 @@ public class SoftRefFilesCache extends AbstractFilesCache { } /* * This is not thread-safe as another thread might be opening the file system ((DefaultFileSystemManager) - * getContext().getFileSystemManager()) ._closeFileSystem(filesystem); + * getContext().getFileSystemManager()).closeFileSystem(fileSystem); */ } diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java index 2271473..d67b6ac 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java @@ -985,15 +985,15 @@ public class DefaultFileSystemManager implements FileSystemManager, AutoCloseabl * <p> * If you use VFS as singleton it is VERY dangerous to call this method. * - * @param filesystem The FileSystem to close. + * @param fileSystem The FileSystem to close. */ @Override - public void closeFileSystem(final FileSystem filesystem) { + public void closeFileSystem(final FileSystem fileSystem) { // inform the cache ... - getFilesCache().clear(filesystem); + getFilesCache().clear(fileSystem); // just in case the cache didnt call _closeFileSystem - _closeFileSystem(filesystem); + _closeFileSystem(fileSystem); } /** @@ -1002,15 +1002,15 @@ public class DefaultFileSystemManager implements FileSystemManager, AutoCloseabl * If you use VFS as singleton it is VERY dangerous to call this method * </p> * - * @param filesystem The FileSystem to close. + * @param fileSystem The FileSystem to close. */ - public void _closeFileSystem(final FileSystem filesystem) { - final FileProvider provider = providers.get(filesystem.getRootName().getScheme()); + public void _closeFileSystem(final FileSystem fileSystem) { + final FileProvider provider = providers.get(fileSystem.getRootName().getScheme()); if (provider != null) { - ((AbstractFileProvider) provider).closeFileSystem(filesystem); - } else if (filesystem instanceof VirtualFileSystem) { + ((AbstractFileProvider) provider).closeFileSystem(fileSystem); + } else if (fileSystem instanceof VirtualFileSystem) { // vfsProvider does not implement AbstractFileProvider - vfsProvider.closeFileSystem(filesystem); + vfsProvider.closeFileSystem(fileSystem); } } 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 24706f9..a817bfc 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 @@ -66,10 +66,10 @@ public class VirtualFileProvider extends AbstractVfsContainer { * This gets called from DefaultFileManager#_closeFileSystem. * </p> * - * @param filesystem the file system remembered by this provider. + * @param fileSystem the file system remembered by this provider. */ - void closeFileSystem(final FileSystem filesystem) { - final AbstractFileSystem fs = (AbstractFileSystem) filesystem; + void closeFileSystem(final FileSystem fileSystem) { + final AbstractFileSystem fs = (AbstractFileSystem) fileSystem; removeComponent(fs); fs.close(); 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 db9c7fa..23f1f14 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 @@ -151,10 +151,10 @@ public abstract class AbstractFileProvider extends AbstractVfsContainer implemen /** * Close the FileSystem. * - * @param filesystem The FileSystem to close. + * @param fileSystem The FileSystem to close. */ - public void closeFileSystem(final FileSystem filesystem) { - final AbstractFileSystem fs = (AbstractFileSystem) filesystem; + public void closeFileSystem(final FileSystem fileSystem) { + final AbstractFileSystem fs = (AbstractFileSystem) fileSystem; final FileSystemKey key = fs.getCacheKey(); if (key != null) { 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 f6cf353..8137b4c 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 @@ -67,7 +67,7 @@ public interface FileProvider { /** * Gets the file system capabilities. * <p> - * These are the same as on the filesystem, but available before the first file system was instanciated. + * These are the same as on the file system, but available before the first file system was instanciated. * </p> * * @return a Collection of the file systems Capabilities.