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-net.git
The following commit(s) were added to refs/heads/master by this push:
new f4e58774 Javadoc
f4e58774 is described below
commit f4e587742822425e88f2576b4768faf80e1c2949
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Thu Oct 19 07:44:28 2023 -0400
Javadoc
---
.../org/apache/commons/net/ftp/FTPFileEntryParser.java | 2 +-
.../net/ftp/parser/DefaultFTPFileEntryParserFactory.java | 15 ++++++++-------
.../net/ftp/parser/EnterpriseUnixFTPEntryParser.java | 2 +-
.../apache/commons/net/ftp/parser/VMSFTPEntryParser.java | 2 +-
4 files changed, 11 insertions(+), 10 deletions(-)
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java
b/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java
index 6643ce56..0de9da1e 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java
@@ -40,7 +40,7 @@ import java.util.List;
* </pre>
*
* The second example uses the <code>FTPClient.listFiles()</code> API to pull
the whole list from the current working directory in one call, but specifying by
- * classname the parser to be used. For this particular parser class, this
approach is necessary since there is no way to autodetect this server type.
+ * class name the parser to be used. For this particular parser class, this
approach is necessary since there is no way to autodetect this server type.
*
* <pre>
* FTPClient f = FTPClient();
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/DefaultFTPFileEntryParserFactory.java
b/src/main/java/org/apache/commons/net/ftp/parser/DefaultFTPFileEntryParserFactory.java
index f11d9bb6..39a3d529 100644
---
a/src/main/java/org/apache/commons/net/ftp/parser/DefaultFTPFileEntryParserFactory.java
+++
b/src/main/java/org/apache/commons/net/ftp/parser/DefaultFTPFileEntryParserFactory.java
@@ -64,16 +64,17 @@ public class DefaultFTPFileEntryParserFactory implements
FTPFileEntryParserFacto
/**
* This default implementation of the FTPFileEntryParserFactory interface
works according to the following logic: First it attempts to interpret the
- * supplied key as a fully qualified classname (default package is not
allowed) of a class implementing the FTPFileEntryParser interface. If that
succeeds,
- * a parser object of this class is instantiated and is returned;
otherwise it attempts to interpret the key as an identirier commonly used by
the FTP SYST
+ * supplied key as a fully qualified class name (default package is not
allowed) of a class implementing the FTPFileEntryParser interface. If that
succeeds,
+ * a parser object of this class is instantiated and is returned;
otherwise it attempts to interpret the key as an identifier commonly used by
the FTP SYST
* command to identify systems.
* <p>
- * If <code>key</code> is not recognized as a fully qualified classname
known to the system, this method will then attempt to see whether it
<b>contains</b>
- * a string identifying one of the known parsers. This comparison is
<b>case-insensitive</b>. The intent here is where possible, to select as keys
strings
- * which are returned by the SYST command on the systems which the
corresponding parser successfully parses. This enables this factory to be used
in the
- * auto-detection system.
+ * If <code>key</code> is not recognized as a fully qualified class name
known to the system, this method will then attempt to see whether it
+ * <b>contains</b> a string identifying one of the known parsers. This
comparison is <b>case-insensitive</b>. The intent here is where possible, to
select
+ * as keys strings which are returned by the SYST command on the systems
which the corresponding parser successfully parses. This enables this factory
to be
+ * used in the auto-detection system.
+ * </p>
*
- * @param key should be a fully qualified classname corresponding to a
class implementing the FTPFileEntryParser interface<br>
+ * @param key should be a fully qualified class name corresponding to a
class implementing the FTPFileEntryParser interface<br>
* OR<br>
* a string containing (case-insensitively) one of the
following keywords:
* <ul>
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/EnterpriseUnixFTPEntryParser.java
b/src/main/java/org/apache/commons/net/ftp/parser/EnterpriseUnixFTPEntryParser.java
index e6ae9e16..48046772 100644
---
a/src/main/java/org/apache/commons/net/ftp/parser/EnterpriseUnixFTPEntryParser.java
+++
b/src/main/java/org/apache/commons/net/ftp/parser/EnterpriseUnixFTPEntryParser.java
@@ -28,7 +28,7 @@ import org.apache.commons.net.ftp.FTPFile;
* "-C--E-----FTP B QUA1I1 18128 41 Aug 12 13:56 QUADTEST"
* </pre>
* <p>
- * Note: EnterpriseUnixFTPEntryParser can only be instantiated through the
DefaultFTPParserFactory by classname. It will not be chosen by the autodetection
+ * Note: EnterpriseUnixFTPEntryParser can only be instantiated through the
DefaultFTPParserFactory by class name. It will not be chosen by the
autodetection
* scheme.
* </p>
*
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
b/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
index 8aa75779..c04b9529 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
@@ -34,7 +34,7 @@ import org.apache.commons.net.ftp.FTPFile;
* "DATA.DIR;1 1/9 2-JUN-1998 07:32:04 [GROUP,OWNER]
(RWED,RWED,RWED,RE)",
* </pre>
* <p>
- * Note: VMSFTPEntryParser can only be instantiated through the
DefaultFTPParserFactory by classname. It will not be chosen by the
autodetection scheme.
+ * Note: VMSFTPEntryParser can only be instantiated through the
DefaultFTPParserFactory by class name. It will not be chosen by the
autodetection scheme.
* </p>
*
* @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for
usage instructions)
