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 832a2398 Javadoc
832a2398 is described below
commit 832a239897b74acc55e89e9869125a1cf0ec3908
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Jan 4 15:10:01 2026 -0500
Javadoc
Add an empty line before a Javadoc comment
---
.../apache/commons/net/DatagramSocketClient.java | 1 +
.../apache/commons/net/DefaultSocketFactory.java | 1 +
.../org/apache/commons/net/echo/EchoUDPClient.java | 1 +
.../java/org/apache/commons/net/ftp/FTPClient.java | 1 -
.../apache/commons/net/ftp/FTPListParseEngine.java | 1 +
.../net/ftp/parser/FTPFileEntryParserFactory.java | 1 +
.../commons/net/ftp/parser/FTPTimestampParser.java | 1 +
.../commons/net/ftp/parser/OS2FTPEntryParser.java | 1 +
.../ftp/parser/RegexFTPFileEntryParserImpl.java | 1 +
.../commons/net/imap/AuthenticatingIMAPClient.java | 1 +
.../java/org/apache/commons/net/imap/IMAP.java | 7 ++-
.../org/apache/commons/net/imap/IMAPClient.java | 50 ++++++++++++++++++++++
.../org/apache/commons/net/imap/IMAPCommand.java | 15 ++++---
.../org/apache/commons/net/imap/IMAPReply.java | 1 +
.../org/apache/commons/net/imap/IMAPSClient.java | 5 +++
.../apache/commons/net/io/CopyStreamListener.java | 1 +
.../apache/commons/net/nntp/ArticlePointer.java | 2 +
.../java/org/apache/commons/net/nntp/NNTP.java | 1 +
.../org/apache/commons/net/nntp/NewsgroupInfo.java | 1 +
.../org/apache/commons/net/ntp/NTPUDPClient.java | 1 +
.../java/org/apache/commons/net/pop3/POP3.java | 5 +++
.../org/apache/commons/net/pop3/POP3Command.java | 14 ++++++
.../org/apache/commons/net/pop3/POP3Reply.java | 1 +
.../org/apache/commons/net/pop3/POP3SClient.java | 4 ++
.../java/org/apache/commons/net/smtp/SMTP.java | 1 +
.../org/apache/commons/net/smtp/SMTPSClient.java | 5 +++
.../commons/net/telnet/EchoOptionHandler.java | 1 +
.../commons/net/telnet/SimpleOptionHandler.java | 1 +
.../net/telnet/SuppressGAOptionHandler.java | 1 +
.../java/org/apache/commons/net/telnet/Telnet.java | 5 ++-
.../apache/commons/net/telnet/TelnetCommand.java | 1 +
.../commons/net/telnet/TelnetInputStream.java | 1 +
.../net/telnet/TelnetNotificationHandler.java | 1 +
.../apache/commons/net/telnet/TelnetOption.java | 1 +
.../commons/net/telnet/TelnetOptionHandler.java | 1 +
.../net/telnet/TerminalTypeOptionHandler.java | 1 +
.../net/telnet/WindowSizeOptionHandler.java | 1 +
.../org/apache/commons/net/tftp/TFTPAckPacket.java | 1 +
.../org/apache/commons/net/tftp/TFTPClient.java | 1 +
.../apache/commons/net/tftp/TFTPDataPacket.java | 1 +
.../apache/commons/net/tftp/TFTPErrorPacket.java | 1 +
.../org/apache/commons/net/tftp/TFTPPacket.java | 1 +
.../apache/commons/net/tftp/TFTPRequestPacket.java | 1 +
.../org/apache/commons/net/time/TimeTCPClient.java | 1 +
.../org/apache/commons/net/util/SubnetUtils.java | 1 +
.../org/apache/commons/net/whois/WhoisClient.java | 1 +
.../net/telnet/SimpleOptionHandlerTest.java | 1 +
.../commons/net/telnet/TelnetClientTest.java | 1 +
.../commons/net/telnet/TelnetOptionTest.java | 1 +
.../net/telnet/WindowSizeOptionHandlerTest.java | 1 +
50 files changed, 141 insertions(+), 11 deletions(-)
diff --git a/src/main/java/org/apache/commons/net/DatagramSocketClient.java
b/src/main/java/org/apache/commons/net/DatagramSocketClient.java
index 3ae30717..c0953e77 100644
--- a/src/main/java/org/apache/commons/net/DatagramSocketClient.java
+++ b/src/main/java/org/apache/commons/net/DatagramSocketClient.java
@@ -39,6 +39,7 @@ import org.apache.commons.io.IOUtils;
* @see DatagramSocketFactory
*/
public abstract class DatagramSocketClient implements AutoCloseable {
+
/**
* The default DatagramSocketFactory shared by all DatagramSocketClient
instances.
*/
diff --git a/src/main/java/org/apache/commons/net/DefaultSocketFactory.java
b/src/main/java/org/apache/commons/net/DefaultSocketFactory.java
index 854e784e..08622564 100644
--- a/src/main/java/org/apache/commons/net/DefaultSocketFactory.java
+++ b/src/main/java/org/apache/commons/net/DefaultSocketFactory.java
@@ -37,6 +37,7 @@ import javax.net.SocketFactory;
* @see SocketClient#setSocketFactory
*/
public class DefaultSocketFactory extends SocketFactory {
+
/** The proxy to use when creating new sockets. */
private final Proxy connProxy;
diff --git a/src/main/java/org/apache/commons/net/echo/EchoUDPClient.java
b/src/main/java/org/apache/commons/net/echo/EchoUDPClient.java
index 4ab53242..d056608c 100644
--- a/src/main/java/org/apache/commons/net/echo/EchoUDPClient.java
+++ b/src/main/java/org/apache/commons/net/echo/EchoUDPClient.java
@@ -34,6 +34,7 @@ import org.apache.commons.net.util.NetConstants;
*/
public final class EchoUDPClient extends DiscardUDPClient {
+
/** The default echo port. It is set to 7 according to RFC 862. */
public static final int DEFAULT_PORT = 7;
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 8a75e1cb..cb8d8cd3 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
@@ -2683,7 +2683,6 @@ public class FTPClient extends FTP implements
Configurable {
return false;
}
- // For server to server transfers
/**
* Initiate a server to server file transfer. This method tells the server
to which the client is connected to append to a given file on the other server.
* The other server must have had a {@code remoteRetrieve} issued to it by
another FTPClient.
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 33d8bb46..96ec816a 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java
@@ -69,6 +69,7 @@ import org.apache.commons.io.Charsets;
* </p>
*/
public class FTPListParseEngine {
+
/**
* An empty immutable {@code FTPFile} array.
*/
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/FTPFileEntryParserFactory.java
b/src/main/java/org/apache/commons/net/ftp/parser/FTPFileEntryParserFactory.java
index 898cf169..cd18437f 100644
---
a/src/main/java/org/apache/commons/net/ftp/parser/FTPFileEntryParserFactory.java
+++
b/src/main/java/org/apache/commons/net/ftp/parser/FTPFileEntryParserFactory.java
@@ -26,6 +26,7 @@ import org.apache.commons.net.ftp.FTPFileEntryParser;
* @since 1.2
*/
public interface FTPFileEntryParserFactory {
+
/**
* <p>
* Implementation should be a method that extracts a key from the supplied
{@link FTPClientConfig FTPClientConfig} parameter and creates an object
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParser.java
b/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParser.java
index 12a0d0a5..5f6e57e2 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParser.java
@@ -31,6 +31,7 @@ public interface FTPTimestampParser {
* the default default date format.
*/
String DEFAULT_SDF = UnixFTPEntryParser.DEFAULT_DATE_FORMAT;
+
/**
* the default recent date format.
*/
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/OS2FTPEntryParser.java
b/src/main/java/org/apache/commons/net/ftp/parser/OS2FTPEntryParser.java
index b7d285e2..a66096ab 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/OS2FTPEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/OS2FTPEntryParser.java
@@ -32,6 +32,7 @@ import org.apache.commons.net.ftp.FTPFileEntryParser;
public class OS2FTPEntryParser extends ConfigurableFTPFileEntryParserImpl {
private static final String DEFAULT_DATE_FORMAT = "MM-dd-yy HH:mm"; //
11-09-01 12:30
+
/**
* this is the regular expression used by this parser.
*/
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/RegexFTPFileEntryParserImpl.java
b/src/main/java/org/apache/commons/net/ftp/parser/RegexFTPFileEntryParserImpl.java
index 55e4741f..22bc2adf 100644
---
a/src/main/java/org/apache/commons/net/ftp/parser/RegexFTPFileEntryParserImpl.java
+++
b/src/main/java/org/apache/commons/net/ftp/parser/RegexFTPFileEntryParserImpl.java
@@ -32,6 +32,7 @@ import org.apache.commons.net.ftp.FTPFileEntryParserImpl;
* </p>
*/
public abstract class RegexFTPFileEntryParserImpl extends
FTPFileEntryParserImpl {
+
/**
* Internal pattern the matcher tries to match, representing a file entry
*/
diff --git
a/src/main/java/org/apache/commons/net/imap/AuthenticatingIMAPClient.java
b/src/main/java/org/apache/commons/net/imap/AuthenticatingIMAPClient.java
index bdf24d47..7064582f 100644
--- a/src/main/java/org/apache/commons/net/imap/AuthenticatingIMAPClient.java
+++ b/src/main/java/org/apache/commons/net/imap/AuthenticatingIMAPClient.java
@@ -41,6 +41,7 @@ public class AuthenticatingIMAPClient extends IMAPSClient {
/** The standardized (RFC4616) PLAIN method, which sends the password
unencrypted (insecure). */
PLAIN("PLAIN"),
+
/** The standardized (RFC2195) CRAM-MD5 method, which doesn't send the
password (secure). */
CRAM_MD5("CRAM-MD5"),
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 32a4bf02..94927a77 100644
--- a/src/main/java/org/apache/commons/net/imap/IMAP.java
+++ b/src/main/java/org/apache/commons/net/imap/IMAP.java
@@ -35,11 +35,13 @@ import org.apache.commons.net.util.NetConstants;
* The IMAP class provides the basic the functionality necessary to implement
your own IMAP client.
*/
public class IMAP extends SocketClient {
+
/**
* Implement this interface and register it via {@link
#setChunkListener(IMAPChunkListener)} in order to get access to multi-line
partial command responses.
* Useful when processing large FETCH responses.
*/
public interface IMAPChunkListener {
+
/**
* Called when a multi-line partial response has been received.
*
@@ -53,12 +55,16 @@ public class IMAP extends SocketClient {
* Enumerates IMAP states.
*/
public enum IMAPState {
+
/** A constant representing the state where the client is not yet
connected to a server. */
DISCONNECTED_STATE,
+
/** A constant representing the "not authenticated" state. */
NOT_AUTH_STATE,
+
/** A constant representing the "authenticated" state. */
AUTH_STATE,
+
/** A constant representing the "logout" state. */
LOGOUT_STATE
}
@@ -66,7 +72,6 @@ public class IMAP extends SocketClient {
/** The default IMAP port (RFC 3501). */
public static final int DEFAULT_PORT = 143;
- // RFC 3501, section 5.1.3. It should be "modified UTF-7".
/**
* The default control socket encoding.
*/
diff --git a/src/main/java/org/apache/commons/net/imap/IMAPClient.java
b/src/main/java/org/apache/commons/net/imap/IMAPClient.java
index 29fa9a3c..ab99daa5 100644
--- a/src/main/java/org/apache/commons/net/imap/IMAPClient.java
+++ b/src/main/java/org/apache/commons/net/imap/IMAPClient.java
@@ -28,24 +28,34 @@ public class IMAPClient extends IMAP {
* The message data item names for the FETCH command defined in RFC 3501.
*/
public enum FETCH_ITEM_NAMES {
+
/** Macro equivalent to: (FLAGS INTERNALDATE RFC822.SIZE ENVELOPE). */
ALL,
+
/** Macro equivalent to: (FLAGS INTERNALDATE RFC822.SIZE). */
FAST,
+
/** Macro equivalent to: (FLAGS INTERNALDATE RFC822.SIZE ENVELOPE
BODY). */
FULL,
+
/** Non-extensible form of BODYSTRUCTURE or the text of a particular
body section. */
BODY,
+
/** The [MIME-IMB] body structure of the message. */
BODYSTRUCTURE,
+
/** The envelope structure of the message. */
ENVELOPE,
+
/** The flags that are set for this message. */
FLAGS,
+
/** The internal date of the message. */
INTERNALDATE,
+
/** A prefix for RFC-822 item names. */
RFC822,
+
/** The unique identifier for the message. */
UID
}
@@ -54,114 +64,149 @@ public class IMAPClient extends IMAP {
* The search criteria defined in RFC 3501.
*/
public enum SEARCH_CRITERIA {
+
/** All messages in the mailbox. */
ALL,
+
/** Messages with the \Answered flag set. */
ANSWERED,
+
/**
* Messages that contain the specified string in the envelope
structure's BCC field.
*/
BCC,
+
/**
* Messages whose internal date (disregarding time and time zone) is
earlier than the specified date.
*/
BEFORE,
+
/**
* Messages that contain the specified string in the body of the
message.
*/
BODY,
+
/**
* Messages that contain the specified string in the envelope
structure's CC field.
*/
CC,
+
/** Messages with the \Deleted flag set. */
DELETED,
+
/** Messages with the \Draft flag set. */
DRAFT,
+
/** Messages with the \Flagged flag set. */
FLAGGED,
+
/**
* Messages that contain the specified string in the envelope
structure's FROM field.
*/
FROM,
+
/**
* Messages that have a header with the specified field-name (as
defined in [RFC-2822]) and that contains the specified string in the text of
the header
* (what comes after the colon). If the string to search is
zero-length, this matches all messages that have a header line with the
specified field-name
* regardless of the contents.
*/
HEADER,
+
/** Messages with the specified keyword flag set. */
KEYWORD,
+
/**
* Messages with an [RFC-2822] size larger than the specified number
of octets.
*/
LARGER,
+
/**
* Messages that have the \Recent flag set but not the \Seen flag.
This is functionally equivalent to "(RECENT UNSEEN)".
*/
NEW,
+
/** Messages that do not match the specified search key. */
NOT,
+
/**
* Messages that do not have the \Recent flag set. This is
functionally equivalent to "NOT RECENT" (as opposed to "NOT NEW").
*/
OLD,
+
/**
* Messages whose internal date (disregarding time and time zone) is
within the specified date.
*/
ON,
+
/** Messages that match either search key. */
OR,
+
/** Messages that have the \Recent flag set. */
RECENT,
+
/** Messages that have the \Seen flag set. */
SEEN,
+
/**
* Messages whose [RFC-2822] Date: header (disregarding time and time
zone) is earlier than the specified date.
*/
SENTBEFORE,
+
/**
* Messages whose [RFC-2822] Date: header (disregarding time and time
zone) is within the specified date.
*/
SENTON,
+
/**
* Messages whose [RFC-2822] Date: header (disregarding time and time
zone) is within or later than the specified date.
*/
SENTSINCE,
+
/**
* Messages whose internal date (disregarding time and time zone) is
within or later than the specified date.
*/
SINCE,
+
/**
* Messages with an [RFC-2822] size smaller than the specified number
of octets.
*/
SMALLER,
+
/**
* Messages that contain the specified string in the envelope
structure's SUBJECT field.
*/
SUBJECT,
+
/**
* Messages that contain the specified string in the header or body of
the message.
*/
TEXT,
+
/**
* Messages that contain the specified string in the envelope
structure's TO field.
*/
TO,
+
/**
* Messages with unique identifiers corresponding to the specified
unique identifier set. Sequence set ranges are permitted.
*/
UID,
+
/** Messages that do not have the \Answered flag set. */
UNANSWERED,
+
/** Messages that do not have the \Deleted flag set. */
UNDELETED,
+
/** Messages that do not have the \Draft flag set. */
UNDRAFT,
+
/** Messages that do not have the \Flagged flag set. */
UNFLAGGED,
+
/** Messages that do not have the specified keyword flag set. */
UNKEYWORD,
+
/** Messages that do not have the \Seen flag set. */
UNSEEN
}
@@ -172,14 +217,19 @@ public class IMAPClient extends IMAP {
* The status data items defined in RFC 3501.
*/
public enum STATUS_DATA_ITEMS {
+
/** The number of messages in the mailbox. */
MESSAGES,
+
/** The number of messages with the \Recent flag set. */
RECENT,
+
/** The next unique identifier value of the mailbox. */
UIDNEXT,
+
/** The unique identifier validity value of the mailbox. */
UIDVALIDITY,
+
/** The number of messages which do not have the \Seen flag set. */
UNSEEN
}
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 edad05ea..05c2380c 100644
--- a/src/main/java/org/apache/commons/net/imap/IMAPCommand.java
+++ b/src/main/java/org/apache/commons/net/imap/IMAPCommand.java
@@ -24,7 +24,6 @@ public enum IMAPCommand {
// These enums must either use the same name as the IMAP command
// or must provide the correct string as the parameter.
- // Commands valid in any state:
/**
* Valid in any state.
*/
@@ -40,19 +39,18 @@ public enum IMAPCommand {
*/
LOGOUT(0),
- // Commands valid in Not Authenticated state
/**
- * Valid in Not Authenticated state
+ * Valid in Not Authenticated state.
*/
STARTTLS(0),
/**
- * Valid in Not Authenticated state
+ * Valid in Not Authenticated state.
*/
AUTHENTICATE(1),
/**
- * Valid in Not Authenticated state
+ * Valid in Not Authenticated state.
*/
LOGIN(2),
@@ -61,7 +59,6 @@ public enum IMAPCommand {
*/
XOAUTH(1),
- // commands valid in authenticated state
/**
* Valid in authenticated state.
*/
@@ -86,22 +83,27 @@ public enum IMAPCommand {
* Valid in authenticated state.
*/
RENAME(2),
+
/**
* Valid in authenticated state.
*/
SUBSCRIBE(1),
+
/**
* Valid in authenticated state.
*/
UNSUBSCRIBE(1),
+
/**
* Valid in authenticated state.
*/
LIST(2),
+
/**
* Valid in authenticated state.
*/
LSUB(2),
+
/**
* Valid in authenticated state.
*/
@@ -112,7 +114,6 @@ public enum IMAPCommand {
*/
APPEND(2, 4), // mbox [(flags)] [date-time] literal
- // commands valid in selected state (substate of authenticated)
/**
* Valid in selected state (substate of authenticated).
*/
diff --git a/src/main/java/org/apache/commons/net/imap/IMAPReply.java
b/src/main/java/org/apache/commons/net/imap/IMAPReply.java
index 428e9bcc..9c83a93d 100644
--- a/src/main/java/org/apache/commons/net/imap/IMAPReply.java
+++ b/src/main/java/org/apache/commons/net/imap/IMAPReply.java
@@ -27,6 +27,7 @@ import org.apache.commons.net.MalformedServerReplyException;
* Stores IMAP reply code constants.
*/
public final class IMAPReply {
+
/** The reply code indicating success of an operation. */
public static final int OK = 0;
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 8ed3e554..de2efa10 100644
--- a/src/main/java/org/apache/commons/net/imap/IMAPSClient.java
+++ b/src/main/java/org/apache/commons/net/imap/IMAPSClient.java
@@ -60,6 +60,7 @@ import org.apache.commons.net.util.SSLSocketUtils;
* {@link #setEndpointCheckingEnabled(boolean)} (on Java 1.7+) to enable
verification.
*/
public class IMAPSClient extends IMAPClient {
+
/** The default IMAP over SSL port. */
public static final int DEFAULT_IMAPS_PORT = 993;
@@ -68,14 +69,18 @@ public class IMAPSClient extends IMAPClient {
/** The security mode. True - Implicit Mode / False - Explicit Mode. */
private final boolean isImplicit;
+
/** The secure socket protocol to be used, like SSL/TLS. */
private final String protocol;
+
/** The context object. */
private SSLContext context;
+
/**
* The cipher suites. SSLSockets have a default set of these anyway, so no
initialization required.
*/
private String[] suites;
+
/** The protocol versions. */
private String[] protocols // null;
; // {"SSLv2", "SSLv3", "TLSv1", "TLSv1.1", "SSLv2Hello"};
diff --git a/src/main/java/org/apache/commons/net/io/CopyStreamListener.java
b/src/main/java/org/apache/commons/net/io/CopyStreamListener.java
index 43572950..fe97df1c 100644
--- a/src/main/java/org/apache/commons/net/io/CopyStreamListener.java
+++ b/src/main/java/org/apache/commons/net/io/CopyStreamListener.java
@@ -30,6 +30,7 @@ import java.util.EventListener;
* @see Util
*/
public interface CopyStreamListener extends EventListener {
+
/**
* Accepts a source event after copying a block of bytes from a stream.
The CopyStreamEvent will contain the total number of bytes transferred so far
and
* the number of bytes transferred in the last write.
diff --git a/src/main/java/org/apache/commons/net/nntp/ArticlePointer.java
b/src/main/java/org/apache/commons/net/nntp/ArticlePointer.java
index 1aa1bc59..7e957fd2 100644
--- a/src/main/java/org/apache/commons/net/nntp/ArticlePointer.java
+++ b/src/main/java/org/apache/commons/net/nntp/ArticlePointer.java
@@ -26,8 +26,10 @@ package org.apache.commons.net.nntp;
*/
@Deprecated
public final class ArticlePointer {
+
/** The number of the referenced article. */
public int articleNumber;
+
/**
* The unique id of the referenced article, including the enclosing <
and > symbols which are technically not part of the identifier, but are
required
* by all NNTP commands taking an article id as an argument.
diff --git a/src/main/java/org/apache/commons/net/nntp/NNTP.java
b/src/main/java/org/apache/commons/net/nntp/NNTP.java
index ac4aecbb..c6430cef 100644
--- a/src/main/java/org/apache/commons/net/nntp/NNTP.java
+++ b/src/main/java/org/apache/commons/net/nntp/NNTP.java
@@ -59,6 +59,7 @@ import org.apache.commons.net.io.CRLFLineReader;
*/
public class NNTP extends SocketClient {
+
/** The default NNTP port. Its value is 119 according to RFC 977. */
public static final int DEFAULT_PORT = 119;
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 3e25e879..409cccd2 100644
--- a/src/main/java/org/apache/commons/net/nntp/NewsgroupInfo.java
+++ b/src/main/java/org/apache/commons/net/nntp/NewsgroupInfo.java
@@ -26,6 +26,7 @@ package org.apache.commons.net.nntp;
*/
public final class NewsgroupInfo {
+
/**
* A constant indicating that the posting permission of a newsgroup is
unknown. For example, the NNTP GROUP command does not return posting
information, so
* NewsgroupInfo instances obtained from that command will have an
UNKNOWN_POSTING_PERMISSION.
diff --git a/src/main/java/org/apache/commons/net/ntp/NTPUDPClient.java
b/src/main/java/org/apache/commons/net/ntp/NTPUDPClient.java
index 2ba9e03e..14b79a8f 100644
--- a/src/main/java/org/apache/commons/net/ntp/NTPUDPClient.java
+++ b/src/main/java/org/apache/commons/net/ntp/NTPUDPClient.java
@@ -31,6 +31,7 @@ import org.apache.commons.net.DatagramSocketClient;
* Network Time Protocol is stateless.
*/
public final class NTPUDPClient extends DatagramSocketClient {
+
/** The default NTP port. It is set to 123 according to RFC 1305. */
public static final int DEFAULT_PORT = 123;
diff --git a/src/main/java/org/apache/commons/net/pop3/POP3.java
b/src/main/java/org/apache/commons/net/pop3/POP3.java
index 8606719d..a93561ef 100644
--- a/src/main/java/org/apache/commons/net/pop3/POP3.java
+++ b/src/main/java/org/apache/commons/net/pop3/POP3.java
@@ -49,16 +49,21 @@ import org.apache.commons.net.util.NetConstants;
*/
public class POP3 extends SocketClient {
+
/** The default POP3 port. Set to 110 according to RFC 1288. */
public static final int DEFAULT_PORT = 110;
+
/**
* A constant representing the state where the client is not yet connected
to a POP3 server.
*/
public static final int DISCONNECTED_STATE = -1;
+
/** A constant representing the POP3 authorization state. */
public static final int AUTHORIZATION_STATE = 0;
+
/** A constant representing the POP3 transaction state. */
public static final int TRANSACTION_STATE = 1;
+
/** A constant representing the POP3 update state. */
public static final int UPDATE_STATE = 2;
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 9f96d961..0ae1ce1d 100644
--- a/src/main/java/org/apache/commons/net/pop3/POP3Command.java
+++ b/src/main/java/org/apache/commons/net/pop3/POP3Command.java
@@ -22,36 +22,50 @@ package org.apache.commons.net.pop3;
*/
public final class POP3Command {
+
/** Send user name. */
public static final int USER = 0;
+
/** Send password. */
public static final int PASS = 1;
+
/** Quit session. */
public static final int QUIT = 2;
+
/** Gets status. */
public static final int STAT = 3;
+
/** List message(s). */
public static final int LIST = 4;
+
/** Retrieve message(s). */
public static final int RETR = 5;
+
/** Delete message(s). */
public static final int DELE = 6;
+
/** No operation. Used as a session keepalive. */
public static final int NOOP = 7;
+
/** Reset session. */
public static final int RSET = 8;
+
/** Authorization. */
public static final int APOP = 9;
+
/** Retrieve top number lines from message. */
public static final int TOP = 10;
+
/** List unique message identifier(s). */
public static final int UIDL = 11;
+
/**
* The capabilities command.
*
* @since 3.0
*/
public static final int CAPA = 12;
+
/**
* Authentication
*
diff --git a/src/main/java/org/apache/commons/net/pop3/POP3Reply.java
b/src/main/java/org/apache/commons/net/pop3/POP3Reply.java
index 7ddcbe0d..3bfea065 100644
--- a/src/main/java/org/apache/commons/net/pop3/POP3Reply.java
+++ b/src/main/java/org/apache/commons/net/pop3/POP3Reply.java
@@ -22,6 +22,7 @@ package org.apache.commons.net.pop3;
*/
public final class POP3Reply {
+
/** The reply code indicating success of an operation. */
public static final int OK = 0;
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 1071b0ea..fb7345b2 100644
--- a/src/main/java/org/apache/commons/net/pop3/POP3SClient.java
+++ b/src/main/java/org/apache/commons/net/pop3/POP3SClient.java
@@ -59,14 +59,18 @@ public class POP3SClient extends POP3Client {
/** The security mode. True - Implicit Mode / False - Explicit Mode. */
private final boolean isImplicit;
+
/** The secure socket protocol to be used, like SSL/TLS. */
private final String protocol;
+
/** The context object. */
private SSLContext context;
+
/**
* The cipher suites. SSLSockets have a default set of these anyway, so no
initialization required.
*/
private String[] suites;
+
/** The protocol versions. */
private String[] protocols // null;
; // {"SSLv2", "SSLv3", "TLSv1", "TLSv1.1", "SSLv2Hello"};
diff --git a/src/main/java/org/apache/commons/net/smtp/SMTP.java
b/src/main/java/org/apache/commons/net/smtp/SMTP.java
index 5611e773..6102397c 100644
--- a/src/main/java/org/apache/commons/net/smtp/SMTP.java
+++ b/src/main/java/org/apache/commons/net/smtp/SMTP.java
@@ -61,6 +61,7 @@ import org.apache.commons.net.util.NetConstants;
*/
public class SMTP extends SocketClient {
+
/** The default SMTP port (25). */
public static final int DEFAULT_PORT = 25;
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 77099d7d..184ee8c4 100644
--- a/src/main/java/org/apache/commons/net/smtp/SMTPSClient.java
+++ b/src/main/java/org/apache/commons/net/smtp/SMTPSClient.java
@@ -60,23 +60,28 @@ import org.apache.commons.net.util.SSLSocketUtils;
* @since 3.0
*/
public class SMTPSClient extends SMTPClient {
+
/** Default secure socket protocol name, like TLS */
private static final String DEFAULT_PROTOCOL = "TLS";
/** The security mode. True - Implicit Mode / False - Explicit Mode. */
private final boolean isImplicit;
+
/** The secure socket protocol to be used, like SSL/TLS. */
private final String protocol;
+
/** The context object. */
private SSLContext context;
+
/**
* The cipher suites. SSLSockets have a default set of these anyway, so no
initialization required.
*/
private String[] suites;
+
/** The protocol versions. */
private String[] protocols;
diff --git a/src/main/java/org/apache/commons/net/telnet/EchoOptionHandler.java
b/src/main/java/org/apache/commons/net/telnet/EchoOptionHandler.java
index 17d65c11..d66c5af4 100644
--- a/src/main/java/org/apache/commons/net/telnet/EchoOptionHandler.java
+++ b/src/main/java/org/apache/commons/net/telnet/EchoOptionHandler.java
@@ -21,6 +21,7 @@ package org.apache.commons.net.telnet;
* Implements the Telnet echo option RFC 857.
*/
public class EchoOptionHandler extends TelnetOptionHandler {
+
/**
* Constructor for the EchoOptionHandler. Initial and accept behavior
flags are set to false
*/
diff --git
a/src/main/java/org/apache/commons/net/telnet/SimpleOptionHandler.java
b/src/main/java/org/apache/commons/net/telnet/SimpleOptionHandler.java
index abce8eb9..c91c19de 100644
--- a/src/main/java/org/apache/commons/net/telnet/SimpleOptionHandler.java
+++ b/src/main/java/org/apache/commons/net/telnet/SimpleOptionHandler.java
@@ -21,6 +21,7 @@ package org.apache.commons.net.telnet;
* Simple option handler that can be used for options that don't require
subnegotiation.
*/
public class SimpleOptionHandler extends TelnetOptionHandler {
+
/**
* Constructor for the SimpleOptionHandler. Initial and accept behavior
flags are set to false
*
diff --git
a/src/main/java/org/apache/commons/net/telnet/SuppressGAOptionHandler.java
b/src/main/java/org/apache/commons/net/telnet/SuppressGAOptionHandler.java
index fdbf6e17..e0ccd575 100644
--- a/src/main/java/org/apache/commons/net/telnet/SuppressGAOptionHandler.java
+++ b/src/main/java/org/apache/commons/net/telnet/SuppressGAOptionHandler.java
@@ -21,6 +21,7 @@ package org.apache.commons.net.telnet;
* Implements the Telnet suppress go ahead option RFC 858.
*/
public class SuppressGAOptionHandler extends TelnetOptionHandler {
+
/**
* Constructor for the SuppressGAOptionHandler. Initial and accept
behavior flags are set to false
*/
diff --git a/src/main/java/org/apache/commons/net/telnet/Telnet.java
b/src/main/java/org/apache/commons/net/telnet/Telnet.java
index e4e25123..98c2b08a 100644
--- a/src/main/java/org/apache/commons/net/telnet/Telnet.java
+++ b/src/main/java/org/apache/commons/net/telnet/Telnet.java
@@ -51,15 +51,16 @@ class Telnet extends SocketClient {
/* public */
static final int DEFAULT_PORT = 23;
- /* TERMINAL-TYPE option (start) */
/**
- * Terminal type option
+ * Terminal type option (start).
*/
protected static final int TERMINAL_TYPE = 24;
+
/**
* Send (for subnegotiation)
*/
protected static final int TERMINAL_TYPE_SEND = 1;
+
/**
* Is (for subnegotiation)
*/
diff --git a/src/main/java/org/apache/commons/net/telnet/TelnetCommand.java
b/src/main/java/org/apache/commons/net/telnet/TelnetCommand.java
index b5303083..f3b49339 100644
--- a/src/main/java/org/apache/commons/net/telnet/TelnetCommand.java
+++ b/src/main/java/org/apache/commons/net/telnet/TelnetCommand.java
@@ -25,6 +25,7 @@ package org.apache.commons.net.telnet;
*/
public final class TelnetCommand {
+
/** The maximum value a command code can have. This value is 255. */
public static final int MAX_COMMAND_VALUE = 255;
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 6b1f1d2d..36ebda62 100644
--- a/src/main/java/org/apache/commons/net/telnet/TelnetInputStream.java
+++ b/src/main/java/org/apache/commons/net/telnet/TelnetInputStream.java
@@ -23,6 +23,7 @@ import java.io.InputStream;
import java.io.InterruptedIOException;
final class TelnetInputStream extends BufferedInputStream implements Runnable {
+
/** End of file has been reached */
private static final int EOF = -1;
diff --git
a/src/main/java/org/apache/commons/net/telnet/TelnetNotificationHandler.java
b/src/main/java/org/apache/commons/net/telnet/TelnetNotificationHandler.java
index f88788c2..3d857d15 100644
--- a/src/main/java/org/apache/commons/net/telnet/TelnetNotificationHandler.java
+++ b/src/main/java/org/apache/commons/net/telnet/TelnetNotificationHandler.java
@@ -25,6 +25,7 @@ package org.apache.commons.net.telnet;
* </p>
*/
public interface TelnetNotificationHandler {
+
/**
* The remote party sent a DO command.
*/
diff --git a/src/main/java/org/apache/commons/net/telnet/TelnetOption.java
b/src/main/java/org/apache/commons/net/telnet/TelnetOption.java
index 8d6c98bd..a2463b97 100644
--- a/src/main/java/org/apache/commons/net/telnet/TelnetOption.java
+++ b/src/main/java/org/apache/commons/net/telnet/TelnetOption.java
@@ -27,6 +27,7 @@ package org.apache.commons.net.telnet;
* @see org.apache.commons.net.telnet.TelnetClient
*/
public class TelnetOption {
+
/** The maximum value an option code can have. This value is 255. */
public static final int MAX_OPTION_VALUE = 255;
diff --git
a/src/main/java/org/apache/commons/net/telnet/TelnetOptionHandler.java
b/src/main/java/org/apache/commons/net/telnet/TelnetOptionHandler.java
index 398a84a7..b5b81072 100644
--- a/src/main/java/org/apache/commons/net/telnet/TelnetOptionHandler.java
+++ b/src/main/java/org/apache/commons/net/telnet/TelnetOptionHandler.java
@@ -24,6 +24,7 @@ package org.apache.commons.net.telnet;
* </p>
*/
public abstract class TelnetOptionHandler {
+
/**
* Option code
*/
diff --git
a/src/main/java/org/apache/commons/net/telnet/TerminalTypeOptionHandler.java
b/src/main/java/org/apache/commons/net/telnet/TerminalTypeOptionHandler.java
index eab0e519..f34a6bec 100644
--- a/src/main/java/org/apache/commons/net/telnet/TerminalTypeOptionHandler.java
+++ b/src/main/java/org/apache/commons/net/telnet/TerminalTypeOptionHandler.java
@@ -21,6 +21,7 @@ package org.apache.commons.net.telnet;
* Implements the Telnet terminal type option RFC 1091.
*/
public class TerminalTypeOptionHandler extends TelnetOptionHandler {
+
/**
* Terminal type option
*/
diff --git
a/src/main/java/org/apache/commons/net/telnet/WindowSizeOptionHandler.java
b/src/main/java/org/apache/commons/net/telnet/WindowSizeOptionHandler.java
index 96390fcc..99a0ef62 100644
--- a/src/main/java/org/apache/commons/net/telnet/WindowSizeOptionHandler.java
+++ b/src/main/java/org/apache/commons/net/telnet/WindowSizeOptionHandler.java
@@ -23,6 +23,7 @@ package org.apache.commons.net.telnet;
* @since 2.0
*/
public class WindowSizeOptionHandler extends TelnetOptionHandler {
+
/**
* Window size option
*/
diff --git a/src/main/java/org/apache/commons/net/tftp/TFTPAckPacket.java
b/src/main/java/org/apache/commons/net/tftp/TFTPAckPacket.java
index 8c69c1ca..1d969e52 100644
--- a/src/main/java/org/apache/commons/net/tftp/TFTPAckPacket.java
+++ b/src/main/java/org/apache/commons/net/tftp/TFTPAckPacket.java
@@ -35,6 +35,7 @@ import java.net.InetAddress;
*/
public final class TFTPAckPacket extends TFTPPacket {
+
/** The block number being acknowledged by the packet. */
int blockNumber;
diff --git a/src/main/java/org/apache/commons/net/tftp/TFTPClient.java
b/src/main/java/org/apache/commons/net/tftp/TFTPClient.java
index 44891908..511c3100 100644
--- a/src/main/java/org/apache/commons/net/tftp/TFTPClient.java
+++ b/src/main/java/org/apache/commons/net/tftp/TFTPClient.java
@@ -46,6 +46,7 @@ import org.apache.commons.net.io.ToNetASCIIInputStream;
*/
public class TFTPClient extends TFTP {
+
/**
* The default number of times a {@code receive} attempt is allowed to
timeout before ending attempts to retry the {@code receive} and failing.
* The default is 5 timeouts.
diff --git a/src/main/java/org/apache/commons/net/tftp/TFTPDataPacket.java
b/src/main/java/org/apache/commons/net/tftp/TFTPDataPacket.java
index 296be691..d70479be 100644
--- a/src/main/java/org/apache/commons/net/tftp/TFTPDataPacket.java
+++ b/src/main/java/org/apache/commons/net/tftp/TFTPDataPacket.java
@@ -35,6 +35,7 @@ import java.net.InetAddress;
*/
public final class TFTPDataPacket extends TFTPPacket {
+
/** The maximum number of bytes in a TFTP data packet (512) */
public static final int MAX_DATA_LENGTH = 512;
diff --git a/src/main/java/org/apache/commons/net/tftp/TFTPErrorPacket.java
b/src/main/java/org/apache/commons/net/tftp/TFTPErrorPacket.java
index 406ee8f2..c2586627 100644
--- a/src/main/java/org/apache/commons/net/tftp/TFTPErrorPacket.java
+++ b/src/main/java/org/apache/commons/net/tftp/TFTPErrorPacket.java
@@ -36,6 +36,7 @@ import java.nio.charset.Charset;
*/
public final class TFTPErrorPacket extends TFTPPacket {
+
/** The undefined error code according to RFC 783, value 0. */
public static final int UNDEFINED = 0;
diff --git a/src/main/java/org/apache/commons/net/tftp/TFTPPacket.java
b/src/main/java/org/apache/commons/net/tftp/TFTPPacket.java
index 59b4eb46..4439410b 100644
--- a/src/main/java/org/apache/commons/net/tftp/TFTPPacket.java
+++ b/src/main/java/org/apache/commons/net/tftp/TFTPPacket.java
@@ -36,6 +36,7 @@ import java.net.InetAddress;
*/
public abstract class TFTPPacket {
+
/**
* The minimum size of a packet. This is 4 bytes. It is enough to store
the opcode and blocknumber or other required data depending on the packet type.
*/
diff --git a/src/main/java/org/apache/commons/net/tftp/TFTPRequestPacket.java
b/src/main/java/org/apache/commons/net/tftp/TFTPRequestPacket.java
index 159c6ae9..eeeacc01 100644
--- a/src/main/java/org/apache/commons/net/tftp/TFTPRequestPacket.java
+++ b/src/main/java/org/apache/commons/net/tftp/TFTPRequestPacket.java
@@ -43,6 +43,7 @@ import java.util.Map;
*/
public abstract class TFTPRequestPacket extends TFTPPacket {
+
/**
* An array containing the string names of the transfer modes and indexed
by the transfer mode constants.
*/
diff --git a/src/main/java/org/apache/commons/net/time/TimeTCPClient.java
b/src/main/java/org/apache/commons/net/time/TimeTCPClient.java
index 4737aa4b..e2c45866 100644
--- a/src/main/java/org/apache/commons/net/time/TimeTCPClient.java
+++ b/src/main/java/org/apache/commons/net/time/TimeTCPClient.java
@@ -33,6 +33,7 @@ import org.apache.commons.net.SocketClient;
*/
public final class TimeTCPClient extends SocketClient {
+
/** The default time port. It is set to 37 according to RFC 868. */
public static final int DEFAULT_PORT = 37;
diff --git a/src/main/java/org/apache/commons/net/util/SubnetUtils.java
b/src/main/java/org/apache/commons/net/util/SubnetUtils.java
index 5fe7fae5..99f9a148 100644
--- a/src/main/java/org/apache/commons/net/util/SubnetUtils.java
+++ b/src/main/java/org/apache/commons/net/util/SubnetUtils.java
@@ -351,6 +351,7 @@ public class SubnetUtils {
builder.append('.');
}
}
+
/**
* Extracts the components of a dotted decimal address and pack into an
integer using a regex match
*/
diff --git a/src/main/java/org/apache/commons/net/whois/WhoisClient.java
b/src/main/java/org/apache/commons/net/whois/WhoisClient.java
index b159fbc6..1f9818de 100644
--- a/src/main/java/org/apache/commons/net/whois/WhoisClient.java
+++ b/src/main/java/org/apache/commons/net/whois/WhoisClient.java
@@ -44,6 +44,7 @@ import org.apache.commons.net.finger.FingerClient;
*/
public final class WhoisClient extends FingerClient {
+
/**
* The default whois host to query. It is set to whois.internic.net.
*/
diff --git
a/src/test/java/org/apache/commons/net/telnet/SimpleOptionHandlerTest.java
b/src/test/java/org/apache/commons/net/telnet/SimpleOptionHandlerTest.java
index 16ca0a4b..8c418212 100644
--- a/src/test/java/org/apache/commons/net/telnet/SimpleOptionHandlerTest.java
+++ b/src/test/java/org/apache/commons/net/telnet/SimpleOptionHandlerTest.java
@@ -26,6 +26,7 @@ import org.junit.jupiter.api.Test;
* JUnit test class for SimpleOptionHandler
*/
public class SimpleOptionHandlerTest extends AbstractTelnetOptionHandlerTest {
+
/**
* setUp for the test.
*/
diff --git a/src/test/java/org/apache/commons/net/telnet/TelnetClientTest.java
b/src/test/java/org/apache/commons/net/telnet/TelnetClientTest.java
index 7e431614..7d7222f4 100644
--- a/src/test/java/org/apache/commons/net/telnet/TelnetClientTest.java
+++ b/src/test/java/org/apache/commons/net/telnet/TelnetClientTest.java
@@ -36,6 +36,7 @@ import org.junit.jupiter.api.Test;
* JUnit test class for TelnetClient.s Implements protocol compliance tests
*/
public class TelnetClientTest implements TelnetNotificationHandler {
+
/**
* Handy holder to hold both sides of the connection used in testing for
clarity.
*/
diff --git a/src/test/java/org/apache/commons/net/telnet/TelnetOptionTest.java
b/src/test/java/org/apache/commons/net/telnet/TelnetOptionTest.java
index 83643624..f7aa0abe 100644
--- a/src/test/java/org/apache/commons/net/telnet/TelnetOptionTest.java
+++ b/src/test/java/org/apache/commons/net/telnet/TelnetOptionTest.java
@@ -26,6 +26,7 @@ import org.junit.jupiter.api.Test;
* JUnit test class for TelnetOption
*/
public class TelnetOptionTest {
+
/**
* test of the getOption method.
*/
diff --git
a/src/test/java/org/apache/commons/net/telnet/WindowSizeOptionHandlerTest.java
b/src/test/java/org/apache/commons/net/telnet/WindowSizeOptionHandlerTest.java
index bb5fc5e6..e7a08d8b 100644
---
a/src/test/java/org/apache/commons/net/telnet/WindowSizeOptionHandlerTest.java
+++
b/src/test/java/org/apache/commons/net/telnet/WindowSizeOptionHandlerTest.java
@@ -26,6 +26,7 @@ import org.junit.jupiter.api.Test;
* JUnit test class for TerminalTypeOptionHandler
*/
public class WindowSizeOptionHandlerTest extends
AbstractTelnetOptionHandlerTest {
+
/**
* compares two arrays of int
*/
