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 59b75075 Normalize getter Javadoc
59b75075 is described below
commit 59b750753e741ac0b19ceb55f0187ff79a55f1aa
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Oct 31 06:52:15 2023 -0400
Normalize getter Javadoc
---
src/main/java/org/apache/commons/net/SocketClient.java | 8 ++++----
src/main/java/org/apache/commons/net/ftp/FTP.java | 2 +-
src/main/java/org/apache/commons/net/ftp/FTPClient.java | 10 +++++-----
src/main/java/org/apache/commons/net/ftp/FTPSClient.java | 4 ++--
src/main/java/org/apache/commons/net/imap/IMAP.java | 4 ++--
src/main/java/org/apache/commons/net/imap/IMAPCommand.java | 2 +-
src/main/java/org/apache/commons/net/imap/IMAPSClient.java | 6 +++---
src/main/java/org/apache/commons/net/nntp/ArticleIterator.java | 2 +-
src/main/java/org/apache/commons/net/nntp/NewsgroupInfo.java | 10 +++++-----
src/main/java/org/apache/commons/net/ntp/NtpUtils.java | 2 +-
src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java | 4 ++--
src/main/java/org/apache/commons/net/ntp/TimeInfo.java | 6 +++---
src/main/java/org/apache/commons/net/pop3/POP3Client.java | 2 +-
src/main/java/org/apache/commons/net/pop3/POP3Command.java | 4 ++--
src/main/java/org/apache/commons/net/pop3/POP3SClient.java | 6 +++---
src/main/java/org/apache/commons/net/smtp/SMTPSClient.java | 6 +++---
.../java/org/apache/commons/net/telnet/TelnetInputStream.java | 2 +-
17 files changed, 40 insertions(+), 40 deletions(-)
diff --git a/src/main/java/org/apache/commons/net/SocketClient.java
b/src/main/java/org/apache/commons/net/SocketClient.java
index 41be623a..a860f444 100644
--- a/src/main/java/org/apache/commons/net/SocketClient.java
+++ b/src/main/java/org/apache/commons/net/SocketClient.java
@@ -371,7 +371,7 @@ public abstract class SocketClient {
}
/**
- * Get the underlying socket connection timeout.
+ * Gets the underlying socket connection timeout.
*
* @return timeout (in ms)
* @since 2.0
@@ -440,7 +440,7 @@ public abstract class SocketClient {
}
/**
- * Get the current receivedBuffer size
+ * Gets the current receivedBuffer size
*
* @return the size, or -1 if not initialized
* @since 3.0
@@ -478,7 +478,7 @@ public abstract class SocketClient {
}
/**
- * Get the current sendBuffer size
+ * Gets the current sendBuffer size
*
* @return the size, or -1 if not initialized
* @since 3.0
@@ -488,7 +488,7 @@ public abstract class SocketClient {
}
/**
- * Get the underlying {@link ServerSocketFactory}
+ * Gets the underlying {@link ServerSocketFactory}
*
* @return The server socket factory
* @since 2.2
diff --git a/src/main/java/org/apache/commons/net/ftp/FTP.java
b/src/main/java/org/apache/commons/net/ftp/FTP.java
index 7314b521..9648355c 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTP.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTP.java
@@ -212,7 +212,7 @@ public class FTP extends SocketClient {
}
/**
- * Get the reply, but don't pass it to command listeners. Used for
keep-alive processing only.
+ * Gets the reply, but don't pass it to command listeners. Used for
keep-alive processing only.
*
* @since 3.0
* @throws IOException on error
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPClient.java
b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
index 617def64..d6e6e2c6 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
@@ -1448,7 +1448,7 @@ public class FTPClient extends FTP implements
Configurable {
}
/**
- * Get the client port for active mode.
+ * Gets the client port for active mode.
*
* @return The client port for active mode.
*/
@@ -1557,7 +1557,7 @@ public class FTPClient extends FTP implements
Configurable {
}
/**
- * Get the CSL debug array.
+ * Gets the CSL debug array.
* <p>
* <b>For debug use only</b>
* <p>
@@ -1606,7 +1606,7 @@ public class FTPClient extends FTP implements
Configurable {
}
/**
- * Get the host address for active mode; allows the local address to be
overridden.
+ * Gets the host address for active mode; allows the local address to be
overridden.
*
* @return __activeExternalHost if non-null, else getLocalAddress()
* @see #setActiveExternalIPAddress(String)
@@ -1707,7 +1707,7 @@ public class FTPClient extends FTP implements
Configurable {
}
/**
- * Get the reported host address for active mode EPRT/PORT commands;
allows override of {@link #getHostAddress()}.
+ * Gets the reported host address for active mode EPRT/PORT commands;
allows override of {@link #getHostAddress()}.
*
* Useful for FTP Client behind Firewall NAT.
*
@@ -2587,7 +2587,7 @@ public class FTPClient extends FTP implements
Configurable {
}
/**
- * Get file details using the MLST command
+ * Gets file details using the MLST command
*
* @param pathname the file or directory to list, may be {@code null}
* @return the file details, may be {@code null}
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
b/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
index d699bca6..edab7eb3 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
@@ -608,7 +608,7 @@ public class FTPSClient extends FTPClient {
}
/**
- * Get the currently configured {@link HostnameVerifier}. The verifier is
only used on client mode connections.
+ * Gets the currently configured {@link HostnameVerifier}. The verifier is
only used on client mode connections.
*
* @return A HostnameVerifier instance.
* @since 3.4
@@ -639,7 +639,7 @@ public class FTPSClient extends FTPClient {
}
/**
- * Get the currently configured {@link TrustManager}.
+ * Gets the currently configured {@link TrustManager}.
*
* @return A TrustManager instance.
*/
diff --git a/src/main/java/org/apache/commons/net/imap/IMAP.java
b/src/main/java/org/apache/commons/net/imap/IMAP.java
index 0b25b00e..ca3c1b34 100644
--- a/src/main/java/org/apache/commons/net/imap/IMAP.java
+++ b/src/main/java/org/apache/commons/net/imap/IMAP.java
@@ -230,7 +230,7 @@ public class IMAP extends SocketClient {
}
/**
- * Get the reply for a command that expects a tagged response.
+ * Gets the reply for a command that expects a tagged response.
*
* @throws IOException
*/
@@ -239,7 +239,7 @@ public class IMAP extends SocketClient {
}
/**
- * Get the reply for a command, reading the response until the reply is
found.
+ * Gets the reply for a command, reading the response until the reply is
found.
*
* @param wantTag {@code true} if the command expects a tagged response.
* @throws IOException
diff --git a/src/main/java/org/apache/commons/net/imap/IMAPCommand.java
b/src/main/java/org/apache/commons/net/imap/IMAPCommand.java
index a255928d..77e24ae2 100644
--- a/src/main/java/org/apache/commons/net/imap/IMAPCommand.java
+++ b/src/main/java/org/apache/commons/net/imap/IMAPCommand.java
@@ -151,7 +151,7 @@ public enum IMAPCommand {
UID(2, Integer.MAX_VALUE);
/**
- * Get the IMAP protocol string command corresponding to a command code.
+ * Gets the IMAP protocol string command corresponding to a command code.
*
* @param command the {@link IMAPCommand} whose command string is
required. Must not be null.
* @return The IMAP protocol string command corresponding to a command
code.
diff --git a/src/main/java/org/apache/commons/net/imap/IMAPSClient.java
b/src/main/java/org/apache/commons/net/imap/IMAPSClient.java
index 4d0451d8..5bd86db3 100644
--- a/src/main/java/org/apache/commons/net/imap/IMAPSClient.java
+++ b/src/main/java/org/apache/commons/net/imap/IMAPSClient.java
@@ -220,7 +220,7 @@ public class IMAPSClient extends IMAPClient {
}
/**
- * Get the currently configured {@link HostnameVerifier}.
+ * Gets the currently configured {@link HostnameVerifier}.
*
* @return A HostnameVerifier instance.
* @since 3.4
@@ -230,7 +230,7 @@ public class IMAPSClient extends IMAPClient {
}
/**
- * Get the {@link KeyManager} instance.
+ * Gets the {@link KeyManager} instance.
*
* @return The current {@link KeyManager} instance.
*/
@@ -239,7 +239,7 @@ public class IMAPSClient extends IMAPClient {
}
/**
- * Get the currently configured {@link TrustManager}.
+ * Gets the currently configured {@link TrustManager}.
*
* @return A TrustManager instance.
*/
diff --git a/src/main/java/org/apache/commons/net/nntp/ArticleIterator.java
b/src/main/java/org/apache/commons/net/nntp/ArticleIterator.java
index 9088db5b..3b553d18 100644
--- a/src/main/java/org/apache/commons/net/nntp/ArticleIterator.java
+++ b/src/main/java/org/apache/commons/net/nntp/ArticleIterator.java
@@ -43,7 +43,7 @@ class ArticleIterator implements Iterator<Article>,
Iterable<Article> {
}
/**
- * Get the next Article
+ * Gets the next Article
*
* @return the next {@link Article}, never {@code null}, if unparseable
then isDummy() will be true, and the subject will contain the raw info.
*/
diff --git a/src/main/java/org/apache/commons/net/nntp/NewsgroupInfo.java
b/src/main/java/org/apache/commons/net/nntp/NewsgroupInfo.java
index db1d68f6..cc0a20f8 100644
--- a/src/main/java/org/apache/commons/net/nntp/NewsgroupInfo.java
+++ b/src/main/java/org/apache/commons/net/nntp/NewsgroupInfo.java
@@ -55,7 +55,7 @@ public final class NewsgroupInfo {
}
/**
- * Get the estimated number of articles in the newsgroup. The accuracy of
this value will depend on the server implementation.
+ * Gets the estimated number of articles in the newsgroup. The accuracy of
this value will depend on the server implementation.
*
* @return The estimated number of articles in the newsgroup.
*/
@@ -69,7 +69,7 @@ public final class NewsgroupInfo {
}
/**
- * Get the number of the first article in the newsgroup.
+ * Gets the number of the first article in the newsgroup.
*
* @return The number of the first article in the newsgroup.
*/
@@ -83,7 +83,7 @@ public final class NewsgroupInfo {
}
/**
- * Get the number of the last article in the newsgroup.
+ * Gets the number of the last article in the newsgroup.
*
* @return The number of the last article in the newsgroup.
*/
@@ -92,7 +92,7 @@ public final class NewsgroupInfo {
}
/**
- * Get the newsgroup name.
+ * Gets the newsgroup name.
*
* @return The name of the newsgroup.
*/
@@ -101,7 +101,7 @@ public final class NewsgroupInfo {
}
/**
- * Get the posting permission of the newsgroup. This will be one of the
<code> POSTING_PERMISSION </code> constants.
+ * Gets the posting permission of the newsgroup. This will be one of the
<code> POSTING_PERMISSION </code> constants.
*
* @return The posting permission status of the newsgroup.
*/
diff --git a/src/main/java/org/apache/commons/net/ntp/NtpUtils.java
b/src/main/java/org/apache/commons/net/ntp/NtpUtils.java
index 3981a0f4..2c5bb8bf 100644
--- a/src/main/java/org/apache/commons/net/ntp/NtpUtils.java
+++ b/src/main/java/org/apache/commons/net/ntp/NtpUtils.java
@@ -73,7 +73,7 @@ public final class NtpUtils {
}
/**
- * Get refId as reference clock string (e.g. GPS, WWV, LCL). If string is
invalid (non-ASCII character) then returns empty string "". For details refer to
+ * Gets refId as reference clock string (e.g. GPS, WWV, LCL). If string is
invalid (non-ASCII character) then returns empty string "". For details refer to
* the <A
HREF="http://www.eecis.udel.edu/~mills/ntp/html/refclock.html#list";>Comprehensive
List of Clock Drivers</A>.
*
* @param message the message to check
diff --git a/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
b/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
index 17f4a777..4b49531d 100644
--- a/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
+++ b/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
@@ -134,7 +134,7 @@ public class NtpV3Impl implements NtpV3Packet {
}
/**
- * Get Long value represented by bits starting at specified index.
+ * Gets Long value represented by bits starting at specified index.
*
* @return 8 bytes as 64-bit long
*/
@@ -321,7 +321,7 @@ public class NtpV3Impl implements NtpV3Packet {
}
/**
- * Get NTP Timestamp at specified starting index.
+ * Gets NTP Timestamp at specified starting index.
*
* @param index index into data array
* @return TimeStamp object for 64 bits starting at index
diff --git a/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
b/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
index 2017afea..3125b192 100644
--- a/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
+++ b/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
@@ -231,7 +231,7 @@ public class TimeInfo {
}
/**
- * Get host address from message datagram if available
+ * Gets host address from message datagram if available
*
* @return host address of available otherwise null
* @since 3.4
@@ -251,7 +251,7 @@ public class TimeInfo {
}
/**
- * Get round-trip network delay. If null then could not compute the delay.
+ * Gets round-trip network delay. If null then could not compute the delay.
*
* @return Long or null if delay not available.
*/
@@ -269,7 +269,7 @@ public class TimeInfo {
}
/**
- * Get clock offset needed to adjust local clock to match remote clock. If
null then could not compute the offset.
+ * Gets clock offset needed to adjust local clock to match remote clock.
If null then could not compute the offset.
*
* @return Long or null if offset not available.
*/
diff --git a/src/main/java/org/apache/commons/net/pop3/POP3Client.java
b/src/main/java/org/apache/commons/net/pop3/POP3Client.java
index 25a7c31a..f19b26d4 100644
--- a/src/main/java/org/apache/commons/net/pop3/POP3Client.java
+++ b/src/main/java/org/apache/commons/net/pop3/POP3Client.java
@@ -412,7 +412,7 @@ public class POP3Client extends POP3 {
}
/**
- * Get the mailbox status. A status attempt can only succeed if the client
is in the {@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE
+ * Gets the mailbox status. A status attempt can only succeed if the
client is in the {@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE
* TRANSACTION_STATE } . Returns a POP3MessageInfo instance containing the
number of messages in the mailbox and the total size of the messages in bytes.
* Returns null if the status the attempt fails.
*
diff --git a/src/main/java/org/apache/commons/net/pop3/POP3Command.java
b/src/main/java/org/apache/commons/net/pop3/POP3Command.java
index 3780f239..cd48cc08 100644
--- a/src/main/java/org/apache/commons/net/pop3/POP3Command.java
+++ b/src/main/java/org/apache/commons/net/pop3/POP3Command.java
@@ -28,7 +28,7 @@ public final class POP3Command {
public static final int PASS = 1;
/** Quit session. */
public static final int QUIT = 2;
- /** Get status. */
+ /** Gets status. */
public static final int STAT = 3;
/** List message(s). */
public static final int LIST = 4;
@@ -70,7 +70,7 @@ public final class POP3Command {
}
/**
- * Get the POP3 protocol string command corresponding to a command code.
+ * Gets the POP3 protocol string command corresponding to a command code.
*
* @param command the command code
*
diff --git a/src/main/java/org/apache/commons/net/pop3/POP3SClient.java
b/src/main/java/org/apache/commons/net/pop3/POP3SClient.java
index 59d7e472..d6634271 100644
--- a/src/main/java/org/apache/commons/net/pop3/POP3SClient.java
+++ b/src/main/java/org/apache/commons/net/pop3/POP3SClient.java
@@ -215,7 +215,7 @@ public class POP3SClient extends POP3Client {
}
/**
- * Get the currently configured {@link HostnameVerifier}.
+ * Gets the currently configured {@link HostnameVerifier}.
*
* @return A HostnameVerifier instance.
* @since 3.4
@@ -225,7 +225,7 @@ public class POP3SClient extends POP3Client {
}
/**
- * Get the {@link KeyManager} instance.
+ * Gets the {@link KeyManager} instance.
*
* @return The current {@link KeyManager} instance.
*/
@@ -234,7 +234,7 @@ public class POP3SClient extends POP3Client {
}
/**
- * Get the currently configured {@link TrustManager}.
+ * Gets the currently configured {@link TrustManager}.
*
* @return A TrustManager instance.
*/
diff --git a/src/main/java/org/apache/commons/net/smtp/SMTPSClient.java
b/src/main/java/org/apache/commons/net/smtp/SMTPSClient.java
index 9a6f6ca5..9dbcf827 100644
--- a/src/main/java/org/apache/commons/net/smtp/SMTPSClient.java
+++ b/src/main/java/org/apache/commons/net/smtp/SMTPSClient.java
@@ -225,7 +225,7 @@ public class SMTPSClient extends SMTPClient {
}
/**
- * Get the currently configured {@link HostnameVerifier}.
+ * Gets the currently configured {@link HostnameVerifier}.
*
* @return A HostnameVerifier instance.
* @since 3.4
@@ -235,7 +235,7 @@ public class SMTPSClient extends SMTPClient {
}
/**
- * Get the {@link KeyManager} instance.
+ * Gets the {@link KeyManager} instance.
*
* @return The current {@link KeyManager} instance.
*/
@@ -244,7 +244,7 @@ public class SMTPSClient extends SMTPClient {
}
/**
- * Get the currently configured {@link TrustManager}.
+ * Gets the currently configured {@link TrustManager}.
*
* @return A TrustManager instance.
*/
diff --git a/src/main/java/org/apache/commons/net/telnet/TelnetInputStream.java
b/src/main/java/org/apache/commons/net/telnet/TelnetInputStream.java
index fafe42f9..3b6246e6 100644
--- a/src/main/java/org/apache/commons/net/telnet/TelnetInputStream.java
+++ b/src/main/java/org/apache/commons/net/telnet/TelnetInputStream.java
@@ -261,7 +261,7 @@ final class TelnetInputStream extends BufferedInputStream
implements Runnable {
// as a processDo/Will/etc. command invoked from TelnetInputStream
// tries to write.
/**
- * Get the next byte of data. IAC commands are processed internally and do
not return data.
+ * Gets the next byte of data. IAC commands are processed internally and
do not return data.
*
* @param mayBlock true if method is allowed to block
* @return the next byte of data, or -1 (EOF) if end of stread reached, or
-2 (WOULD_BLOCK) if mayBlock is false and there is no data available
