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 8d24086 Inline single use local vars. Private static final should be upper case. Simplify. Javadoc typos. Reuse constants. 8d24086 is described below commit 8d24086b0e698209de34d0ada251edc79511ceda Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Tue Mar 2 08:52:42 2021 -0500 Inline single use local vars. Private static final should be upper case. Simplify. Javadoc typos. Reuse constants. --- .../operations/AbstractFileOperationProvider.java | 4 +--- .../commons/vfs2/provider/ftp/FtpFileProvider.java | 9 +++++---- .../commons/vfs2/provider/ftp/FtpFileSystem.java | 2 +- .../commons/vfs2/provider/ftps/FtpsClientFactory.java | 7 +------ .../commons/vfs2/provider/gzip/GzipFileObject.java | 6 ++---- .../commons/vfs2/provider/hdfs/HdfsFileProvider.java | 8 ++++---- .../commons/vfs2/provider/hdfs/HdfsFileSystem.java | 7 +------ .../provider/hdfs/HdfsFileSystemConfigBuilder.java | 3 +-- .../commons/vfs2/provider/http/HttpFileProvider.java | 4 ++-- .../commons/vfs2/provider/http/HttpFileSystem.java | 2 +- .../provider/http/HttpFileSystemConfigBuilder.java | 10 +++++----- .../vfs2/provider/http4/Http4FileProvider.java | 4 ++-- .../commons/vfs2/provider/http4/Http4FileSystem.java | 2 +- .../provider/http4/Http4FileSystemConfigBuilder.java | 10 +++++----- .../vfs2/provider/http5/Http5FileProvider.java | 4 ++-- .../commons/vfs2/provider/http5/Http5FileSystem.java | 2 +- .../provider/http5/Http5FileSystemConfigBuilder.java | 19 ++++++++++++------- .../commons/vfs2/provider/jar/JarFileProvider.java | 6 +++--- .../commons/vfs2/provider/jar/JarFileSystem.java | 2 +- 19 files changed, 51 insertions(+), 60 deletions(-) diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperationProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperationProvider.java index cee7814..de2ff56 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperationProvider.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperationProvider.java @@ -71,9 +71,7 @@ public abstract class AbstractFileOperationProvider implements FileOperationProv @Override public final FileOperation getOperation(final FileObject file, final Class<? extends FileOperation> operationClass) throws FileSystemException { - final Class<? extends FileOperation> implementation = lookupOperation(operationClass); - - return instantiateOperation(file, implementation); + return instantiateOperation(file, lookupOperation(operationClass)); } /** 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 aba9deb..63cac0b 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 @@ -46,9 +46,10 @@ public class FtpFileProvider extends AbstractOriginatingFileProvider { public static final UserAuthenticationData.Type[] AUTHENTICATOR_TYPES = new UserAuthenticationData.Type[] { UserAuthenticationData.USERNAME, UserAuthenticationData.PASSWORD }; - static final Collection<Capability> capabilities = Collections.unmodifiableCollection(Arrays.asList(Capability.CREATE, Capability.DELETE, Capability.RENAME, Capability.GET_TYPE, - Capability.LIST_CHILDREN, Capability.READ_CONTENT, Capability.GET_LAST_MODIFIED, Capability.URI, - Capability.WRITE_CONTENT, Capability.APPEND_CONTENT, Capability.RANDOM_ACCESS_READ)); + static final Collection<Capability> CAPABILITIES = Collections + .unmodifiableCollection(Arrays.asList(Capability.CREATE, Capability.DELETE, Capability.RENAME, + Capability.GET_TYPE, Capability.LIST_CHILDREN, Capability.READ_CONTENT, Capability.GET_LAST_MODIFIED, + Capability.URI, Capability.WRITE_CONTENT, Capability.APPEND_CONTENT, Capability.RANDOM_ACCESS_READ)); /** * Constructs a new provider. @@ -77,7 +78,7 @@ public class FtpFileProvider extends AbstractOriginatingFileProvider { @Override public Collection<Capability> getCapabilities() { - return capabilities; + return CAPABILITIES; } @Override 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 de76ecb..8baf694 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 @@ -66,7 +66,7 @@ public class FtpFileSystem extends AbstractFileSystem { */ @Override protected void addCapabilities(final Collection<Capability> caps) { - caps.addAll(FtpFileProvider.capabilities); + caps.addAll(FtpFileProvider.CAPABILITIES); } /** diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsClientFactory.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsClientFactory.java index dd3affc..8e5a63f 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsClientFactory.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsClientFactory.java @@ -67,12 +67,7 @@ public final class FtpsClientFactory { @Override protected FTPSClient createClient(final FileSystemOptions fileSystemOptions) throws FileSystemException { - final FTPSClient client; - if (builder.getFtpsMode(fileSystemOptions) == FtpsMode.IMPLICIT) { - client = new FTPSClient(true); - } else { - client = new FTPSClient(); - } + final FTPSClient client = new FTPSClient(builder.getFtpsMode(fileSystemOptions) == FtpsMode.IMPLICIT); final TrustManager trustManager = builder.getTrustManager(fileSystemOptions); if (trustManager != null) { diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileObject.java index 20ff716..959e7a6 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileObject.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileObject.java @@ -52,14 +52,12 @@ public class GzipFileObject extends CompressedFileFileObject<GzipFileSystem> { @Override protected InputStream doGetInputStream(final int bufferSize) throws Exception { - final InputStream inputStream = getContainer().getContent().getInputStream(); - return new GZIPInputStream(inputStream, bufferSize); + return new GZIPInputStream(getContainer().getContent().getInputStream(), bufferSize); } @Override protected OutputStream doGetOutputStream(final boolean bAppend) throws Exception { - final OutputStream os = getContainer().getContent().getOutputStream(false); - return new GZIPOutputStream(os); + return new GZIPOutputStream(getContainer().getContent().getOutputStream(false)); } private static GzipFileSystem cast(final CompressedFileFileSystem fs) { 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 f13248a..5b21dc9 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 @@ -55,7 +55,7 @@ public class HdfsFileProvider extends AbstractOriginatingFileProvider { } /** - * Create a new HdfsFileSystem instance. + * Creates a new HdfsFileSystem instance. * * @param rootName Name of the root file. * @param fileSystemOptions Configuration options for this instance. @@ -68,7 +68,7 @@ public class HdfsFileProvider extends AbstractOriginatingFileProvider { } /** - * Get Capabilities of HdfsFileSystem. + * Gets Capabilities of HdfsFileSystem. * * @return The capabilities (unmodifiable). */ @@ -78,9 +78,9 @@ public class HdfsFileProvider extends AbstractOriginatingFileProvider { } /** - * Return config builder. + * Gets the config builder. * - * @return A config builder for HdfsFileSystems. + * @return The config builder for HdfsFileSystems. * @see org.apache.commons.vfs2.provider.AbstractFileProvider#getConfigBuilder() */ @Override 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 ce1ea2d..e141e92 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 @@ -151,12 +151,7 @@ public class HdfsFileSystem extends AbstractFileSystem { } final boolean useCache = null != getFileSystemManager().getFilesCache(); - FileObject fileObject; - if (useCache) { - fileObject = this.getFileFromCache(name); - } else { - fileObject = null; - } + FileObject fileObject = useCache ? getFileFromCache(name) : null; if (null == fileObject) { String path; try { 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 af5738c..2821afc 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 @@ -106,8 +106,7 @@ public final class HdfsFileSystemConfigBuilder extends FileSystemConfigBuilder { if (pathNames == null || pathNames.isEmpty()) { return null; } - final String[] paths = pathNames.split(","); - return Arrays.stream(paths).map(Path::new).toArray(Path[]::new); + return Arrays.stream(pathNames.split(",")).map(Path::new).toArray(Path[]::new); } /** 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 470508b..3d6b51b 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 @@ -41,7 +41,7 @@ public class HttpFileProvider extends AbstractOriginatingFileProvider { public static final UserAuthenticationData.Type[] AUTHENTICATOR_TYPES = new UserAuthenticationData.Type[] { UserAuthenticationData.USERNAME, UserAuthenticationData.PASSWORD }; - static final Collection<Capability> capabilities = Collections + static final Collection<Capability> CAPABILITIES = Collections .unmodifiableCollection(Arrays.asList(Capability.GET_TYPE, Capability.READ_CONTENT, Capability.URI, Capability.GET_LAST_MODIFIED, Capability.ATTRIBUTES, Capability.RANDOM_ACCESS_READ, Capability.DIRECTORY_READ_CONTENT)); @@ -86,7 +86,7 @@ public class HttpFileProvider extends AbstractOriginatingFileProvider { @Override public Collection<Capability> getCapabilities() { - return capabilities; + return CAPABILITIES; } @Override 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 509b4b4..aa40797 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 @@ -46,7 +46,7 @@ public class HttpFileSystem extends AbstractFileSystem { */ @Override protected void addCapabilities(final Collection<Capability> caps) { - caps.addAll(HttpFileProvider.capabilities); + caps.addAll(HttpFileProvider.CAPABILITIES); } /** @since 2.0 */ 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 68dbe11..1d3847f 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 @@ -206,10 +206,10 @@ public class HttpFileSystemConfigBuilder extends FileSystemConfigBuilder { } /** - * Sets the charset used for url encoding. + * Gets the charset used for url encoding. * * @param opts The FileSystem options. - * @return the chaset + * @return the charset name. */ public String getUrlCharset(final FileSystemOptions opts) { return getString(opts, "urlCharset"); @@ -381,10 +381,10 @@ public class HttpFileSystemConfigBuilder extends FileSystemConfigBuilder { * Sets the charset used for url encoding. * * @param opts The FileSystem options. - * @param chaset the chaset + * @param charset the charset name. */ - public void setUrlCharset(final FileSystemOptions opts, final String chaset) { - setParam(opts, "urlCharset", chaset); + public void setUrlCharset(final FileSystemOptions opts, final String charset) { + setParam(opts, "urlCharset", charset); } /** 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 2891fbb..14834b5 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 @@ -92,7 +92,7 @@ public class Http4FileProvider extends AbstractOriginatingFileProvider { }; /** FileProvider capabilities */ - static final Collection<Capability> capabilities = + static final Collection<Capability> CAPABILITIES = Collections.unmodifiableCollection( Arrays.asList( Capability.GET_TYPE, @@ -344,7 +344,7 @@ public class Http4FileProvider extends AbstractOriginatingFileProvider { @Override public Collection<Capability> getCapabilities() { - return capabilities; + return CAPABILITIES; } @Override 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 b73b543..b683157 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 @@ -81,7 +81,7 @@ public class Http4FileSystem extends AbstractFileSystem { @Override protected void addCapabilities(final Collection<Capability> caps) { - caps.addAll(Http4FileProvider.capabilities); + caps.addAll(Http4FileProvider.CAPABILITIES); } @Override 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 f5a41bc..2702172 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 @@ -368,7 +368,7 @@ public class Http4FileSystemConfigBuilder extends FileSystemConfigBuilder { * Sets the charset used for url encoding. * * @param opts The FileSystem options. - * @return the chaset + * @return the charset name. */ public String getUrlCharset(final FileSystemOptions opts) { return getString(opts, "urlCharset"); @@ -611,13 +611,13 @@ public class Http4FileSystemConfigBuilder extends FileSystemConfigBuilder { } /** - * Sets the charset used for url encoding. + * Sets the charset used for URL encoding. * * @param opts The FileSystem options. - * @param chaset the chaset + * @param charset the charset name. */ - public void setUrlCharset(final FileSystemOptions opts, final String chaset) { - setParam(opts, "urlCharset", chaset); + public void setUrlCharset(final FileSystemOptions opts, final String charset) { + setParam(opts, "urlCharset", charset); } /** diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileProvider.java index 6d0937e..b508313 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileProvider.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileProvider.java @@ -92,7 +92,7 @@ public class Http5FileProvider extends AbstractOriginatingFileProvider { }; /** FileProvider capabilities */ - static final Collection<Capability> capabilities = + static final Collection<Capability> CAPABILITIES = Collections.unmodifiableCollection( Arrays.asList( Capability.GET_TYPE, @@ -354,7 +354,7 @@ public class Http5FileProvider extends AbstractOriginatingFileProvider { @Override public Collection<Capability> getCapabilities() { - return capabilities; + return CAPABILITIES; } @Override diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystem.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystem.java index b269377..3700025 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystem.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystem.java @@ -81,7 +81,7 @@ public class Http5FileSystem extends AbstractFileSystem { @Override protected void addCapabilities(final Collection<Capability> caps) { - caps.addAll(Http5FileProvider.capabilities); + caps.addAll(Http5FileProvider.CAPABILITIES); } @Override diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystemConfigBuilder.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystemConfigBuilder.java index 642de71..e0a9d7a 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystemConfigBuilder.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystemConfigBuilder.java @@ -113,6 +113,11 @@ public class Http5FileSystemConfigBuilder extends FileSystemConfigBuilder { protected static final String KEY_FOLLOW_REDIRECT = "followRedirect"; /** + * Defines the charset of a URL. + */ + private static final String KEY_URL_CHARSET = "urlCharset"; + + /** * Defines the User-Agent request header string of the underlying HttpClient. * <p> * This parameter expects a value of type {@link String}. @@ -393,13 +398,13 @@ public class Http5FileSystemConfigBuilder extends FileSystemConfigBuilder { } /** - * Sets the charset used for url encoding. + * Gets the charset used for url encoding. * * @param opts The FileSystem options. - * @return the chaset + * @return the charset name */ public String getUrlCharset(final FileSystemOptions opts) { - return getString(opts, "urlCharset"); + return getString(opts, KEY_URL_CHARSET); } /** @@ -652,10 +657,10 @@ public class Http5FileSystemConfigBuilder extends FileSystemConfigBuilder { * Sets the charset used for url encoding. * * @param opts The FileSystem options. - * @param chaset the chaset + * @param charset the charset name. */ - public void setUrlCharset(final FileSystemOptions opts, final String chaset) { - setParam(opts, "urlCharset", chaset); + public void setUrlCharset(final FileSystemOptions opts, final String charset) { + setParam(opts, KEY_URL_CHARSET, charset); } /** @@ -665,6 +670,6 @@ public class Http5FileSystemConfigBuilder extends FileSystemConfigBuilder { * @param userAgent User Agent String */ public void setUserAgent(final FileSystemOptions opts, final String userAgent) { - setParam(opts, "userAgent", userAgent); + setParam(opts, KEY_USER_AGENT, userAgent); } } 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 8e3a02f..a2393c3 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 @@ -38,13 +38,13 @@ import org.apache.commons.vfs2.provider.zip.ZipFileProvider; */ public class JarFileProvider extends ZipFileProvider { - static final Collection<Capability> capabilities; + static final Collection<Capability> CAPABILITIES; static { final Collection<Capability> combined = new ArrayList<>(ZipFileProvider.capabilities); combined.addAll(Arrays.asList(Capability.ATTRIBUTES, Capability.FS_ATTRIBUTES, Capability.SIGNING, Capability.MANIFEST_ATTRIBUTES, Capability.VIRTUAL)); - capabilities = Collections.unmodifiableCollection(combined); + CAPABILITIES = Collections.unmodifiableCollection(combined); } public JarFileProvider() { @@ -66,6 +66,6 @@ public class JarFileProvider extends ZipFileProvider { @Override public Collection<Capability> getCapabilities() { - return capabilities; + return CAPABILITIES; } } diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileSystem.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileSystem.java index a5433bf..b6d2735 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileSystem.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileSystem.java @@ -72,7 +72,7 @@ public class JarFileSystem extends ZipFileSystem { @Override protected void addCapabilities(final Collection<Capability> caps) { // super.addCapabilities(caps); - caps.addAll(JarFileProvider.capabilities); + caps.addAll(JarFileProvider.CAPABILITIES); } Attributes getAttributes() throws IOException {