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
commit 8d71b881bea339780ff9769309087775118ec705 Author: Gary Gregory <[email protected]> AuthorDate: Sun Jan 4 15:49:42 2026 -0500 Javadoc Add an empty line before a Javadoc comment --- checkstyle-suppressions.xml | 2 +- .../src/main/java/org/apache/commons/vfs2/FileSystemOptions.java | 1 + .../java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java | 1 + .../java/org/apache/commons/vfs2/impl/PrivilegedFileReplicator.java | 3 +++ .../main/java/org/apache/commons/vfs2/provider/DefaultFileContent.java | 2 ++ .../main/java/org/apache/commons/vfs2/provider/ftp/FtpFileObject.java | 1 + .../commons/vfs2/provider/http4/Http4FileSystemConfigBuilder.java | 2 ++ .../commons/vfs2/provider/http5/Http5FileSystemConfigBuilder.java | 1 + .../java/org/apache/commons/vfs2/provider/sftp/SftpStreamProxy.java | 1 + .../src/test/java/org/apache/commons/vfs2/FileTypeSelectorTest.java | 1 + .../java/org/apache/commons/vfs2/provider/http/HttpProviderTest.java | 1 + .../apache/commons/vfs2/provider/http5s/Http5sGetContentInfoTest.java | 1 + 12 files changed, 16 insertions(+), 1 deletion(-) diff --git a/checkstyle-suppressions.xml b/checkstyle-suppressions.xml index 52c9422c8..fb896d0f8 100644 --- a/checkstyle-suppressions.xml +++ b/checkstyle-suppressions.xml @@ -37,7 +37,7 @@ <suppress checks="FinalClass" files="URIUtils.java"/> <suppress checks="FinalClass" files="ZipFileSystemConfigBuilder.java"/> <!-- Can't change method name without breaking binary compatibility. --> - <suppress checks="MethodName" files="DefaultFileSystemManager.java" lines="192"/> + <suppress checks="MethodName" files="DefaultFileSystemManager.java" lines="193"/> <!-- Use of literals here is reasonable. --> <suppress checks="MagicNumber" files="URIUtils.java" lines="143, 152, 162"/> <suppress checks="MagicNumber" files="RamFileRandomAccessContent.java"/> diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemOptions.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemOptions.java index 0b817ae52..2d28118d8 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemOptions.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemOptions.java @@ -48,6 +48,7 @@ public final class FileSystemOptions implements Cloneable, Comparable<FileSystem * Keys in the options Map. */ private static final class FileSystemOptionKey implements Comparable<FileSystemOptionKey> { + /** Constant used to create hash code */ private static final int HASH = 29; 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 052978a13..a18e04834 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 @@ -139,6 +139,7 @@ public class DefaultFileSystemManager implements FileSystemManager { * The cache strategy */ private CacheStrategy fileCacheStrategy; + /** * Class which decorates all returned fileObjects */ 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 f908a52b2..f40f25948 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 @@ -39,6 +39,7 @@ public class PrivilegedFileReplicator implements FileReplicator, VfsComponent { * An action that closes the wrapped replicator. */ private final class CloseAction implements PrivilegedAction<Object> { + /** * Performs the action. */ @@ -48,10 +49,12 @@ public class PrivilegedFileReplicator implements FileReplicator, VfsComponent { return null; } } + /** * An action that initializes the wrapped replicator. */ private final class InitAction implements PrivilegedExceptionAction<Object> { + /** * Performs the action. */ 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 22fc40450..cc17a3a5c 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 @@ -90,6 +90,7 @@ public final class DefaultFileContent implements FileContent { } } } + /** * An output stream for writing content. */ @@ -135,6 +136,7 @@ public final class DefaultFileContent implements FileContent { } } } + /** * An input/output stream for reading/writing content on random positions */ diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileObject.java index 1da81d7d3..04080d5d7 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileObject.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileObject.java @@ -99,6 +99,7 @@ public class FtpFileObject extends AbstractFileObject<FtpFileSystem> { } } } + /** * An OutputStream that monitors for end-of-file. */ 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 456df2ee3..e0f576871 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 @@ -257,6 +257,7 @@ public class Http4FileSystemConfigBuilder extends FileSystemConfigBuilder { public String getKeyStoreFile(final FileSystemOptions opts) { return getParam(opts, KEYSTORE_FILE); } + /** * Gets keystore pass phrase for SSL connections. * @param opts the file system options to modify @@ -285,6 +286,7 @@ public class Http4FileSystemConfigBuilder extends FileSystemConfigBuilder { public int getMaxConnectionsPerHost(final FileSystemOptions opts) { return getInteger(opts, MAX_HOST_CONNECTIONS, DEFAULT_MAX_HOST_CONNECTIONS); } + /** * Gets the maximum number of connections allowed. * 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 d1486cbcb..49d5538b4 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 @@ -607,6 +607,7 @@ public class Http5FileSystemConfigBuilder extends FileSystemConfigBuilder { public void setProxyPort(final FileSystemOptions opts, final int proxyPort) { setParam(opts, "proxyPort", Integer.valueOf(proxyPort)); } + /** * Sets the proxy-scheme to use for http connection. You have to set the ProxyHost too if you would like to have the * proxy really used. diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpStreamProxy.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpStreamProxy.java index 337a4a866..9289bff30 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpStreamProxy.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpStreamProxy.java @@ -39,6 +39,7 @@ import com.jcraft.jsch.SocketFactory; * @since 2.1 */ public class SftpStreamProxy implements Proxy { + /** * Command format using bash built-in TCP stream. */ diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/FileTypeSelectorTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/FileTypeSelectorTest.java index a0c553459..1113db64c 100644 --- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/FileTypeSelectorTest.java +++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/FileTypeSelectorTest.java @@ -66,6 +66,7 @@ public class FileTypeSelectorTest { "FILE, 5", "FOLDER, 8" }) + /** Test file type selector with different file types */ public void testFileTypeSelector(final FileType fileType, final int expectedCount) throws Exception { final FileSelector selector = new FileTypeSelector(fileType); diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/http/HttpProviderTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/http/HttpProviderTest.java index 930a552e7..e2bdd1ca4 100644 --- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/http/HttpProviderTest.java +++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/http/HttpProviderTest.java @@ -43,6 +43,7 @@ import org.junit.jupiter.api.TestInstance; * This class replaces {@link HttpProviderTestCase} with a pure JUnit 5 implementation. * </p> */ + /** HTTP Provider Tests */ @Tag("provider") @Tag("http") diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/http5s/Http5sGetContentInfoTest.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/http5s/Http5sGetContentInfoTest.java index b63b2b47a..213b4648e 100644 --- a/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/http5s/Http5sGetContentInfoTest.java +++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/http5s/Http5sGetContentInfoTest.java @@ -79,6 +79,7 @@ public class Http5sGetContentInfoTest { builder.setKeyStoreType(opts, "JCEKS"); return opts; } + /** * Tests VFS-427 NPE on Http5FileObject.getContent().getContentInfo(). *
