From b6535fde6d6ed58efa8cd450e3dd99e6ca054576 Mon Sep 17 00:00:00 2001 From: Gary Gregory Date: Sat, 11 Nov 2023 16:17:12 -0500 Subject: [PATCH] Javadoc --- .../apache/commons/vfs2/provider/hdfs/HdfsFileSystem.java | 2 +- .../vfs2/provider/webdav4/test/JackrabbitMain.java | 2 +- .../org/apache/commons/vfs2/provider/smb/SmbFileName.java | 2 +- .../org/apache/commons/vfs2/filter/RegexFileFilter.java | 8 ++++---- .../apache/commons/vfs2/filter/WildcardFileFilter.java | 8 ++++---- .../commons/vfs2/provider/http4/Http4FileObject.java | 4 ++-- .../commons/vfs2/provider/http4/Http4FileSystem.java | 2 +- .../vfs2/provider/http4/Http4FileSystemConfigBuilder.java | 2 +- .../commons/vfs2/provider/http4s/Http4sFileProvider.java | 2 +- .../commons/vfs2/provider/http5/Http5FileObject.java | 4 ++-- .../commons/vfs2/provider/http5/Http5FileSystem.java | 2 +- .../vfs2/provider/http5/Http5FileSystemConfigBuilder.java | 2 +- .../commons/vfs2/provider/http5s/Http5sFileProvider.java | 2 +- 13 files changed, 21 insertions(+), 21 deletions(-) diff --git a/commons-vfs2-hdfs/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileSystem.java b/commons-vfs2-hdfs/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileSystem.java index b416ba8c03..ddcf6a12bc 100644 --- a/commons-vfs2-hdfs/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileSystem.java +++ b/commons-vfs2-hdfs/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileSystem.java @@ -50,7 +50,7 @@ public class HdfsFileSystem extends AbstractFileSystem { private FileSystem fs; /** - * Construct file system. + * Constructs file system. * * @param rootName Name of the root directory of this file system. * @param fileSystemOptions options for this file system instance. diff --git a/commons-vfs2-jackrabbit2/src/test/java/org/apache/commons/vfs2/provider/webdav4/test/JackrabbitMain.java b/commons-vfs2-jackrabbit2/src/test/java/org/apache/commons/vfs2/provider/webdav4/test/JackrabbitMain.java index 9922ae9a85..ca187f2127 100644 --- a/commons-vfs2-jackrabbit2/src/test/java/org/apache/commons/vfs2/provider/webdav4/test/JackrabbitMain.java +++ b/commons-vfs2-jackrabbit2/src/test/java/org/apache/commons/vfs2/provider/webdav4/test/JackrabbitMain.java @@ -78,7 +78,7 @@ public static void main(String[] args) throws Exception { private final ServerConnector connector = new ServerConnector(server); /** - * Construct Main application instance. + * Constructs Main application instance. *

* Note: Constructor is protected because other projects such as Commons VFS can extend this for some reasons * (e.g, unit testing against Jackrabbit WebDAV). diff --git a/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileName.java b/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileName.java index 3a109bcf45..d5176635a4 100644 --- a/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileName.java +++ b/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileName.java @@ -94,7 +94,7 @@ public String getShare() { } /** - * Construct the path suitable for SmbFile when used with NtlmPasswordAuthentication. + * Constructs the path suitable for SmbFile when used with NtlmPasswordAuthentication. * * @return caches and return URI with no username/password, never null * @throws FileSystemException if any of the invoked methods throw diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/RegexFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/RegexFileFilter.java index 8a80c57f91..2279f0f457 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/RegexFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/RegexFileFilter.java @@ -57,7 +57,7 @@ public class RegexFileFilter implements FileFilter, Serializable { private final Pattern pattern; /** - * Construct a new regular expression filter for a compiled regular expression. + * Constructs a new regular expression filter for a compiled regular expression. * * @param pattern regular expression to match - Cannot be null */ @@ -70,7 +70,7 @@ public RegexFileFilter(final Pattern pattern) { } /** - * Construct a new regular expression filter. + * Constructs a new regular expression filter. * * @param pattern regular string expression to match - Cannot be null */ @@ -83,7 +83,7 @@ public RegexFileFilter(final String pattern) { } /** - * Construct a new regular expression filter with the specified flags. + * Constructs a new regular expression filter with the specified flags. * * @param pattern regular string expression to match * @param flags pattern flags - e.g. {@link Pattern#CASE_INSENSITIVE} @@ -96,7 +96,7 @@ public RegexFileFilter(final String pattern, final int flags) { } /** - * Construct a new regular expression filter with the specified flags case + * Constructs a new regular expression filter with the specified flags case * sensitivity. * * @param pattern regular string expression to match - Cannot be null diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/WildcardFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/WildcardFileFilter.java index 60033b2adf..e36ce6339a 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/WildcardFileFilter.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/WildcardFileFilter.java @@ -208,7 +208,7 @@ static boolean wildcardMatch(final String fileName, final String wildcardMatcher private final List wildcards; /** - * Construct a new wildcard filter for a list of wildcards specifying + * Constructs a new wildcard filter for a list of wildcards specifying * case-sensitivity. * * @param caseSensitivity how to handle case sensitivity, null means @@ -224,7 +224,7 @@ public WildcardFileFilter(final IOCase caseSensitivity, final List wildc } /** - * Construct a new wildcard filter for an array of wildcards specifying + * Constructs a new wildcard filter for an array of wildcards specifying * case-sensitivity. * * @param caseSensitivity how to handle case sensitivity, null means @@ -240,7 +240,7 @@ public WildcardFileFilter(final IOCase caseSensitivity, final String... wildcard } /** - * Construct a new case-sensitive wildcard filter for a list of wildcards. + * Constructs a new case-sensitive wildcard filter for a list of wildcards. * * @param wildcards the list of wildcards to match, not null */ @@ -249,7 +249,7 @@ public WildcardFileFilter(final List wildcards) { } /** - * Construct a new case-sensitive wildcard filter for an array of wildcards. + * Constructs a new case-sensitive wildcard filter for an array of wildcards. *

* The array is not cloned, so could be changed after constructing the instance. * This would be inadvisable however. 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 4aa72e70fa..f5a252c3f7 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,7 +68,7 @@ public class Http4FileObject extends AbstractFileObj private HttpResponse lastHeadResponse; /** - * Construct {@code Http4FileObject}. + * Constructs {@code Http4FileObject}. * * @param name file name * @param fileSystem file system @@ -80,7 +80,7 @@ protected Http4FileObject(final AbstractFileName name, final FS fileSystem) } /** - * Construct {@code Http4FileObject}. + * Constructs {@code Http4FileObject}. * * @param name file name * @param fileSystem file system 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 684859c466..4de2b93792 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 @@ -53,7 +53,7 @@ public class Http4FileSystem extends AbstractFileSystem { private final HttpClientContext httpClientContext; /** - * Construct {@code Http4FileSystem}. + * Constructs {@code Http4FileSystem}. * * @param rootName root base name * @param fileSystemOptions file system options 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 125b33f5e9..e593b11fef 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 @@ -190,7 +190,7 @@ private Http4FileSystemConfigBuilder() { } /** - * Construct an {@code Http4FileSystemConfigBuilder}. + * Constructs an {@code Http4FileSystemConfigBuilder}. * * @param prefix String for properties of this file system. */ diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4s/Http4sFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4s/Http4sFileProvider.java index 754beab320..11d17dd180 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4s/Http4sFileProvider.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4s/Http4sFileProvider.java @@ -26,7 +26,7 @@ public class Http4sFileProvider extends Http4FileProvider { /** - * Construct a {@code Http4sFileProvider}. + * Constructs a {@code Http4sFileProvider}. */ public Http4sFileProvider() { setFileNameParser(Http4sFileNameParser.getInstance()); diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java index 034d988709..4fdc9ee73d 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java @@ -68,7 +68,7 @@ public class Http5FileObject extends AbstractFileObj private HttpResponse lastHeadResponse; /** - * Construct {@code Http4FileObject}. + * Constructs {@code Http4FileObject}. * * @param name file name * @param fileSystem file system @@ -80,7 +80,7 @@ protected Http5FileObject(final AbstractFileName name, final FS fileSystem) } /** - * Construct {@code Http4FileObject}. + * Constructs {@code Http4FileObject}. * * @param name file name * @param fileSystem file system 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 078a8dbe34..e2f024e8ff 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 @@ -53,7 +53,7 @@ public class Http5FileSystem extends AbstractFileSystem { private final HttpClientContext httpClientContext; /** - * Construct {@code Http4FileSystem}. + * Constructs {@code Http4FileSystem}. * * @param rootName root base name * @param fileSystemOptions file system options 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 7f81840bed..bd191bbce7 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 @@ -210,7 +210,7 @@ private Http5FileSystemConfigBuilder() { } /** - * Construct an {@code Http4FileSystemConfigBuilder}. + * Constructs an {@code Http4FileSystemConfigBuilder}. * * @param prefix String for properties of this file system. */ diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5s/Http5sFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5s/Http5sFileProvider.java index 3d471219bb..37f40e4d0b 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5s/Http5sFileProvider.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5s/Http5sFileProvider.java @@ -26,7 +26,7 @@ public class Http5sFileProvider extends Http5FileProvider { /** - * Construct a {@code Http4sFileProvider}. + * Constructs a {@code Http4sFileProvider}. */ public Http5sFileProvider() { setFileNameParser(Http5sFileNameParser.getInstance());