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 b7ee52b1 Javadoc
b7ee52b1 is described below
commit b7ee52b1aab193f72e26f5944b647c3bcaab0d9c
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Jan 17 09:26:10 2024 -0500
Javadoc
---
src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java | 4 ++--
src/main/java/org/apache/commons/net/ftp/FTPSClient.java | 6 +++---
.../java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java | 4 ++--
src/main/java/org/apache/commons/net/imap/IMAPSClient.java | 6 +++---
src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java | 2 +-
src/main/java/org/apache/commons/net/ntp/TimeInfo.java | 2 +-
src/main/java/org/apache/commons/net/ntp/TimeStamp.java | 2 +-
src/main/java/org/apache/commons/net/pop3/POP3SClient.java | 6 +++---
src/main/java/org/apache/commons/net/smtp/SMTPSClient.java | 6 +++---
9 files changed, 19 insertions(+), 19 deletions(-)
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java
b/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java
index 180b2917..a4ca970f 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java
@@ -97,7 +97,7 @@ public class FTPListParseEngine {
* Returns a list of FTPFile objects containing the whole list of files
returned by the server as read by this object's parser. The files are filtered
* before being added to the array.
*
- * @param filter FTPFileFilter, must not be <code>null</code>.
+ * @param filter FTPFileFilter, must not be {@code null}.
*
* @return a list of FTPFile objects containing the whole list of files
returned by the server as read by this object's parser.
* <p>
@@ -128,7 +128,7 @@ public class FTPListParseEngine {
* Returns an array of FTPFile objects containing the whole list of files
returned by the server as read by this object's parser. The files are filtered
* before being added to the array.
*
- * @param filter FTPFileFilter, must not be <code>null</code>.
+ * @param filter FTPFileFilter, must not be {@code null}.
*
* @return an array of FTPFile objects containing the whole list of files
returned by the server as read by this object's parser.
* <p>
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 43fa1e32..4d1cbf89 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
@@ -572,7 +572,7 @@ public class FTPSClient extends FTPClient {
* Returns the names of the cipher suites which could be enabled for use
on this connection. When the underlying {@link Socket} is not an {@link
SSLSocket}
* instance, returns null.
*
- * @return An array of cipher suite names, or <code>null</code>
+ * @return An array of cipher suite names, or {@code null}
*/
public String[] getEnabledCipherSuites() {
if (_socket_ instanceof SSLSocket) {
@@ -585,7 +585,7 @@ public class FTPSClient extends FTPClient {
* Returns the names of the protocol versions which are currently enabled
for use on this connection. When the underlying {@link Socket} is not an
* {@link SSLSocket} instance, returns null.
*
- * @return An array of protocols, or <code>null</code>
+ * @return An array of protocols, or {@code null}
*/
public String[] getEnabledProtocols() {
if (_socket_ instanceof SSLSocket) {
@@ -1027,7 +1027,7 @@ public class FTPSClient extends FTPClient {
/**
* Override the default {@link HostnameVerifier} to use. The verifier is
only used on client mode connections.
*
- * @param newHostnameVerifier The HostnameVerifier implementation to set
or <code>null</code> to disable.
+ * @param newHostnameVerifier The HostnameVerifier implementation to set
or {@code null} to disable.
* @since 3.4
*/
public void setHostnameVerifier(final HostnameVerifier
newHostnameVerifier) {
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
b/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
index e5e9e374..eaf46fd1 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
@@ -275,8 +275,8 @@ public class OS400FTPEntryParser extends
ConfigurableFTPFileEntryParserImpl {
/**
*
- * @param string String value that is checked for <code>null</code> or
empty.
- * @return {@code true} for <code>null</code> or empty values, else {@code
false}.
+ * @param string String value that is checked for {@code null} or empty.
+ * @return {@code true} for {@code null} or empty values, else {@code
false}.
*/
private boolean isNullOrEmpty(final String string) {
return string == null || string.isEmpty();
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 2992f169..6fffb19d 100644
--- a/src/main/java/org/apache/commons/net/imap/IMAPSClient.java
+++ b/src/main/java/org/apache/commons/net/imap/IMAPSClient.java
@@ -197,7 +197,7 @@ public class IMAPSClient extends IMAPClient {
* Returns the names of the cipher suites which could be enabled for use
on this connection. When the underlying {@link java.net.Socket Socket} is not an
* {@link SSLSocket} instance, returns null.
*
- * @return An array of cipher suite names, or <code>null</code>.
+ * @return An array of cipher suite names, or {@code null}.
*/
public String[] getEnabledCipherSuites() {
if (_socket_ instanceof SSLSocket) {
@@ -210,7 +210,7 @@ public class IMAPSClient extends IMAPClient {
* Returns the names of the protocol versions which are currently enabled
for use on this connection. When the underlying {@link java.net.Socket Socket}
is
* not an {@link SSLSocket} instance, returns null.
*
- * @return An array of protocols, or <code>null</code>.
+ * @return An array of protocols, or {@code null}.
*/
public String[] getEnabledProtocols() {
if (_socket_ instanceof SSLSocket) {
@@ -338,7 +338,7 @@ public class IMAPSClient extends IMAPClient {
/**
* Override the default {@link HostnameVerifier} to use.
*
- * @param newHostnameVerifier The HostnameVerifier implementation to set
or <code>null</code> to disable.
+ * @param newHostnameVerifier The HostnameVerifier implementation to set
or {@code null} to disable.
* @since 3.4
*/
public void setHostnameVerifier(final HostnameVerifier
newHostnameVerifier) {
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 baddddc5..bafdc71d 100644
--- a/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
+++ b/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
@@ -80,7 +80,7 @@ public class NtpV3Impl implements NtpV3Packet {
}
/**
- * Compares this object against the specified object. The result is {@code
true} if and only if the argument is not <code>null</code> and is a
+ * Compares this object against the specified object. The result is {@code
true} if and only if the argument is not {@code null} and is a
* <code>NtpV3Impl</code> object that contains the same values as this
object.
*
* @param obj the object to compare with.
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 3125b192..2ad05bbc 100644
--- a/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
+++ b/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
@@ -211,7 +211,7 @@ public class TimeInfo {
}
/**
- * Compares this object against the specified object. The result is {@code
true} if and only if the argument is not <code>null</code> and is a
+ * Compares this object against the specified object. The result is {@code
true} if and only if the argument is not {@code null} and is a
* <code>TimeStamp</code> object that contains the same values as this
object.
*
* @param obj the object to compare with.
diff --git a/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
b/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
index c1f1b310..786e55b2 100644
--- a/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
+++ b/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
@@ -264,7 +264,7 @@ public class TimeStamp implements Serializable,
Comparable<TimeStamp> {
}
/**
- * Compares this object against the specified object. The result is {@code
true} if and only if the argument is not <code>null</code> and is a
+ * Compares this object against the specified object. The result is {@code
true} if and only if the argument is not {@code null} and is a
* <code>Long</code> object that contains the same <code>long</code> value
as this object.
*
* @param obj the object to compare with.
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 f42a1633..7a83430e 100644
--- a/src/main/java/org/apache/commons/net/pop3/POP3SClient.java
+++ b/src/main/java/org/apache/commons/net/pop3/POP3SClient.java
@@ -192,7 +192,7 @@ public class POP3SClient extends POP3Client {
* Returns the names of the cipher suites which could be enabled for use
on this connection. When the underlying {@link java.net.Socket Socket} is not an
* {@link SSLSocket} instance, returns null.
*
- * @return An array of cipher suite names, or <code>null</code>.
+ * @return An array of cipher suite names, or {@code null}.
*/
public String[] getEnabledCipherSuites() {
if (_socket_ instanceof SSLSocket) {
@@ -205,7 +205,7 @@ public class POP3SClient extends POP3Client {
* Returns the names of the protocol versions which are currently enabled
for use on this connection. When the underlying {@link java.net.Socket Socket}
is
* not an {@link SSLSocket} instance, returns null.
*
- * @return An array of protocols, or <code>null</code>.
+ * @return An array of protocols, or {@code null}.
*/
public String[] getEnabledProtocols() {
if (_socket_ instanceof SSLSocket) {
@@ -333,7 +333,7 @@ public class POP3SClient extends POP3Client {
/**
* Override the default {@link HostnameVerifier} to use.
*
- * @param newHostnameVerifier The HostnameVerifier implementation to set
or <code>null</code> to disable.
+ * @param newHostnameVerifier The HostnameVerifier implementation to set
or {@code null} to disable.
* @since 3.4
*/
public void setHostnameVerifier(final HostnameVerifier
newHostnameVerifier) {
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 7aafc667..897c8264 100644
--- a/src/main/java/org/apache/commons/net/smtp/SMTPSClient.java
+++ b/src/main/java/org/apache/commons/net/smtp/SMTPSClient.java
@@ -202,7 +202,7 @@ public class SMTPSClient extends SMTPClient {
* Returns the names of the cipher suites which could be enabled for use
on this connection. When the underlying {@link java.net.Socket Socket} is not an
* {@link SSLSocket} instance, returns null.
*
- * @return An array of cipher suite names, or <code>null</code>.
+ * @return An array of cipher suite names, or {@code null}.
*/
public String[] getEnabledCipherSuites() {
if (_socket_ instanceof SSLSocket) {
@@ -215,7 +215,7 @@ public class SMTPSClient extends SMTPClient {
* Returns the names of the protocol versions which are currently enabled
for use on this connection. When the underlying {@link java.net.Socket Socket}
is
* not an {@link SSLSocket} instance, returns null.
*
- * @return An array of protocols, or <code>null</code>.
+ * @return An array of protocols, or {@code null}.
*/
public String[] getEnabledProtocols() {
if (_socket_ instanceof SSLSocket) {
@@ -342,7 +342,7 @@ public class SMTPSClient extends SMTPClient {
/**
* Override the default {@link HostnameVerifier} to use.
*
- * @param newHostnameVerifier The HostnameVerifier implementation to set
or <code>null</code> to disable.
+ * @param newHostnameVerifier The HostnameVerifier implementation to set
or {@code null} to disable.
* @since 3.4
*/
public void setHostnameVerifier(final HostnameVerifier
newHostnameVerifier) {
