This is an automated email from the ASF dual-hosted git repository.
garydgregory 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 ba5f637e Javadoc
ba5f637e is described below
commit ba5f637e6df3218b32998e5b69fb82dc2e68306d
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Aug 2 16:39:11 2026 -0400
Javadoc
---
.../org/apache/commons/net/bsd/RExecClient.java | 2 +-
.../commons/net/discard/DiscardUDPClient.java | 4 ++--
.../commons/net/examples/ftp/TFTPExample.java | 2 +-
.../commons/net/examples/mail/IMAPUtils.java | 2 +-
.../commons/net/examples/ntp/SimpleNTPServer.java | 6 +++---
.../java/org/apache/commons/net/ftp/FTPClient.java | 10 +++++-----
.../org/apache/commons/net/ftp/FTPSClient.java | 2 +-
.../org/apache/commons/net/imap/IMAPReply.java | 4 ++--
.../java/org/apache/commons/net/nntp/NNTP.java | 2 +-
.../org/apache/commons/net/nntp/NNTPClient.java | 22 +++++++++++-----------
.../java/org/apache/commons/net/tftp/TFTP.java | 2 +-
.../java/org/apache/commons/net/MockTcpServer.java | 6 +++---
.../commons/net/daytime/MockDaytimeTCPServer.java | 6 +++---
.../org/apache/commons/net/tftp/TFTPServer.java | 8 ++++----
14 files changed, 39 insertions(+), 39 deletions(-)
diff --git a/src/main/java/org/apache/commons/net/bsd/RExecClient.java
b/src/main/java/org/apache/commons/net/bsd/RExecClient.java
index d7b5b499..aaf4d540 100644
--- a/src/main/java/org/apache/commons/net/bsd/RExecClient.java
+++ b/src/main/java/org/apache/commons/net/bsd/RExecClient.java
@@ -158,7 +158,7 @@ public class RExecClient extends SocketClient {
* @param user The user name
* @param password The password
* @param command The command to run
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
public void rexec(final String user, final String password, final String
command) throws IOException {
rexec(user, password, command, false);
diff --git a/src/main/java/org/apache/commons/net/discard/DiscardUDPClient.java
b/src/main/java/org/apache/commons/net/discard/DiscardUDPClient.java
index fde3b62e..2a43f8fa 100644
--- a/src/main/java/org/apache/commons/net/discard/DiscardUDPClient.java
+++ b/src/main/java/org/apache/commons/net/discard/DiscardUDPClient.java
@@ -51,7 +51,7 @@ public class DiscardUDPClient extends DatagramSocketClient {
* @param data The buffer to send
* @param host The target host
* @see #send(byte[], int, InetAddress, int)
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
public void send(final byte[] data, final InetAddress host) throws
IOException {
send(data, data.length, host, DEFAULT_PORT);
@@ -64,7 +64,7 @@ public class DiscardUDPClient extends DatagramSocketClient {
* @param length The length of the data in the buffer
* @param host The target host
* @see #send(byte[], int, InetAddress, int)
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
public void send(final byte[] data, final int length, final InetAddress
host) throws IOException {
send(data, length, host, DEFAULT_PORT);
diff --git a/src/main/java/org/apache/commons/net/examples/ftp/TFTPExample.java
b/src/main/java/org/apache/commons/net/examples/ftp/TFTPExample.java
index a7cf2294..d22e9feb 100644
--- a/src/main/java/org/apache/commons/net/examples/ftp/TFTPExample.java
+++ b/src/main/java/org/apache/commons/net/examples/ftp/TFTPExample.java
@@ -75,7 +75,7 @@ public final class TFTPExample {
* Runs this application.
*
* @param args command line arguments.
- * @throws IOException if a network or I/O error occurs.
+ * @throws IOException Thrown if a network or I/O error occurs.
*/
public static void main(final String[] args) throws IOException {
boolean receiveFile = true;
diff --git a/src/main/java/org/apache/commons/net/examples/mail/IMAPUtils.java
b/src/main/java/org/apache/commons/net/examples/mail/IMAPUtils.java
index d09086d2..807f142c 100644
--- a/src/main/java/org/apache/commons/net/examples/mail/IMAPUtils.java
+++ b/src/main/java/org/apache/commons/net/examples/mail/IMAPUtils.java
@@ -36,7 +36,7 @@ final class IMAPUtils {
* @param defaultTimeout initial timeout (in milliseconds)
* @param listener for tracing protocol IO (may be null)
* @return The IMAP client - connected and logged in
- * @throws IOException if any problems occur
+ * @throws IOException Thrown if any problems occur
*/
static IMAPClient imapLogin(final URI uri, final int defaultTimeout, final
ProtocolCommandListener listener) throws IOException {
final String userInfo = uri.getUserInfo();
diff --git
a/src/main/java/org/apache/commons/net/examples/ntp/SimpleNTPServer.java
b/src/main/java/org/apache/commons/net/examples/ntp/SimpleNTPServer.java
index 9c74f662..0708fe37 100644
--- a/src/main/java/org/apache/commons/net/examples/ntp/SimpleNTPServer.java
+++ b/src/main/java/org/apache/commons/net/examples/ntp/SimpleNTPServer.java
@@ -81,7 +81,7 @@ public class SimpleNTPServer implements Runnable {
/**
* Connects to server socket and listen for client connections.
*
- * @throws IOException if an I/O error occurs when creating the socket.
+ * @throws IOException Thrown if an I/O error occurs when creating the
socket.
*/
public void connect() throws IOException {
if (socket == null) {
@@ -103,7 +103,7 @@ public class SimpleNTPServer implements Runnable {
*
* @param request incoming DatagramPacket
* @param rcvTime time packet received
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected void handlePacket(final DatagramPacket request, final long
rcvTime) throws IOException {
final NtpV3Packet message = new NtpV3Impl();
@@ -181,7 +181,7 @@ public class SimpleNTPServer implements Runnable {
/**
* Starts time service and provide time to client connections.
*
- * @throws IOException if an I/O error occurs when creating the socket.
+ * @throws IOException Thrown if an I/O error occurs when creating the
socket.
*/
public void start() throws IOException {
if (socket == null) {
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 870782ea..efe740fc 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
@@ -1659,7 +1659,7 @@ public class FTPClient extends FTP implements
Configurable {
*
* @param path The file path to query.
* @return A string representing the last file modification time in {@code
yyyyMMDDhhmmss} format.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
* @since 2.0
*/
public String getModificationTime(final String path) throws IOException {
@@ -2502,7 +2502,7 @@ public class FTPClient extends FTP implements
Configurable {
*
* @param path The file path to query.
* @return A Calendar representing the last file modification time, may be
{@code null}. The Calendar timestamp will be null if a parse error occurs.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
* @since 3.8.0
*/
public Calendar mdtmCalendar(final String path) throws IOException {
@@ -2519,7 +2519,7 @@ public class FTPClient extends FTP implements
Configurable {
*
* @param path The file path to query.
* @return A FTPFile representing the last file modification time, may be
{@code null}. The FTPFile timestamp will be null if a parse error occurs.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
* @since 3.4
*/
public FTPFile mdtmFile(final String path) throws IOException {
@@ -2540,7 +2540,7 @@ public class FTPClient extends FTP implements
Configurable {
*
* @param path The file path to query.
* @return An Instant representing the last file modification time, may be
{@code null}. The Instant timestamp will be null if a parse error occurs.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
* @since 3.9.0
*/
public Instant mdtmInstant(final String path) throws IOException {
@@ -3158,7 +3158,7 @@ public class FTPClient extends FTP implements
Configurable {
* @param path The file path for which last modified time is to be
changed.
* @param timeval The timestamp to set to, in {@code yyyyMMDDhhmmss}
format.
* @return true if successfully set, false if not
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
* @since 2.2
* @see <a
href="https://tools.ietf.org/html/draft-somers-ftp-mfxx-04";>https://tools.ietf.org/html/draft-somers-ftp-mfxx-04</a>
*/
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 0dce90b7..b6e931b1 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
@@ -953,7 +953,7 @@ public class FTPSClient extends FTPClient {
* @param command The FTP command.
* @return server reply.
* @throws IOException If an I/O error occurs while sending the command.
- * @throws SSLException if a CCC command fails
+ * @throws SSLException Thrown if a CCC command fails
* @see org.apache.commons.net.ftp.FTP#sendCommand(String)
*/
// Would like to remove this method, but that will break any existing
clients that are using CCC
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 78447945..a9413717 100644
--- a/src/main/java/org/apache/commons/net/imap/IMAPReply.java
+++ b/src/main/java/org/apache/commons/net/imap/IMAPReply.java
@@ -98,7 +98,7 @@ public final class IMAPReply {
*
* @param line The tagged line to be checked
* @return {@link #OK} or {@link #NO} or {@link #BAD} or {@link #CONT}
- * @throws IOException if the input has an unexpected format
+ * @throws IOException Thrown if the input has an unexpected format
*/
public static int getReplyCode(final String line) throws IOException {
return getReplyCode(line, TAGGED_PATTERN);
@@ -131,7 +131,7 @@ public final class IMAPReply {
*
* @param line The untagged line to be checked
* @return {@link #OK} or {@link #NO} or {@link #BAD} or {@link #CONT}
- * @throws IOException if the input has an unexpected format
+ * @throws IOException Thrown if the input has an unexpected format
*/
public static int getUntaggedReplyCode(final String line) throws
IOException {
return getReplyCode(line, UNTAGGED_PATTERN);
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 cc9e39a4..b05e2b30 100644
--- a/src/main/java/org/apache/commons/net/nntp/NNTP.java
+++ b/src/main/java/org/apache/commons/net/nntp/NNTP.java
@@ -464,7 +464,7 @@ public class NNTP extends SocketClient {
*
* @param wildmat A wildmat (pseudo-regex) pattern. See RFC 2980 for
details.
* @return The reply code received from the server.
- * @throws IOException if the command fails
+ * @throws IOException Thrown if the command fails
*/
public int listActive(final String wildmat) throws IOException {
final StringBuilder command = new StringBuilder("ACTIVE ");
diff --git a/src/main/java/org/apache/commons/net/nntp/NNTPClient.java
b/src/main/java/org/apache/commons/net/nntp/NNTPClient.java
index be840f7c..968dcbe8 100644
--- a/src/main/java/org/apache/commons/net/nntp/NNTPClient.java
+++ b/src/main/java/org/apache/commons/net/nntp/NNTPClient.java
@@ -264,7 +264,7 @@ public class NNTPClient extends NNTP {
* @param lowArticleNumber low
* @param highArticleNumber high
* @return An Iterable of Articles
- * @throws IOException if the command failed
+ * @throws IOException Thrown if the command failed
* @since 3.0
*/
public Iterable<Article> iterateArticleInfo(final long lowArticleNumber,
final long highArticleNumber) throws IOException {
@@ -636,7 +636,7 @@ public class NNTPClient extends NNTP {
* Same as {@code retrieveArticle((String) null)} Note: the return can be
cast to a {@link BufferedReader}
*
* @return A DotTerminatedMessageReader instance from which the article
can be read. null if the article does not exist.
- * @throws IOException if an IO error occurs
+ * @throws IOException Thrown if an IO error occurs
*/
public Reader retrieveArticle() throws IOException {
return retrieveArticle((String) null);
@@ -673,7 +673,7 @@ public class NNTPClient extends NNTP {
*
* @param articleNumber The article number to fetch
* @return A DotTerminatedMessageReader instance from which the article
can be read. null if the article does not exist.
- * @throws IOException if an IO error occurs
+ * @throws IOException Thrown if an IO error occurs
*/
public BufferedReader retrieveArticle(final long articleNumber) throws
IOException {
return retrieveArticle(articleNumber, null);
@@ -712,7 +712,7 @@ public class NNTPClient extends NNTP {
*
* @param articleId The article id to retrieve
* @return A DotTerminatedMessageReader instance from which the article
can be read. null if the article does not exist.
- * @throws IOException if an IO error occurs
+ * @throws IOException Thrown if an IO error occurs
*/
public Reader retrieveArticle(final String articleId) throws IOException {
return retrieveArticle(articleId, (ArticleInfo) null);
@@ -766,7 +766,7 @@ public class NNTPClient extends NNTP {
* Same as {@code retrieveArticleBody(null)} Note: the return can be cast
to a {@link BufferedReader}
*
* @return A DotTerminatedMessageReader instance from which the article
body can be read. null if the article does not exist.
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
public Reader retrieveArticleBody() throws IOException {
return retrieveArticleBody(null);
@@ -803,7 +803,7 @@ public class NNTPClient extends NNTP {
*
* @param articleNumber The article number
* @return The reader
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
public BufferedReader retrieveArticleBody(final long articleNumber) throws
IOException {
return retrieveArticleBody(articleNumber, null);
@@ -842,7 +842,7 @@ public class NNTPClient extends NNTP {
*
* @param articleId The article id
* @return A DotTerminatedMessageReader instance from which the article
body can be read. null if the article does not exist.
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
public Reader retrieveArticleBody(final String articleId) throws
IOException {
return retrieveArticleBody(articleId, (ArticleInfo) null);
@@ -897,7 +897,7 @@ public class NNTPClient extends NNTP {
* Same as {@code retrieveArticleHeader((String) null)} Note: the return
can be cast to a {@link BufferedReader}
*
* @return The reader
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
public Reader retrieveArticleHeader() throws IOException {
return retrieveArticleHeader((String) null);
@@ -934,7 +934,7 @@ public class NNTPClient extends NNTP {
*
* @param articleNumber The article number
* @return The reader
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
public BufferedReader retrieveArticleHeader(final long articleNumber)
throws IOException {
return retrieveArticleHeader(articleNumber, null);
@@ -973,7 +973,7 @@ public class NNTPClient extends NNTP {
*
* @param articleId The article id to fetch
* @return The reader
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
public Reader retrieveArticleHeader(final String articleId) throws
IOException {
return retrieveArticleHeader(articleId, (ArticleInfo) null);
@@ -1310,7 +1310,7 @@ public class NNTPClient extends NNTP {
*
* @param newsgroup The newsgroup name
* @return true if newsgroup exist and was selected
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
public boolean selectNewsgroup(final String newsgroup) throws IOException {
return selectNewsgroup(newsgroup, null);
diff --git a/src/main/java/org/apache/commons/net/tftp/TFTP.java
b/src/main/java/org/apache/commons/net/tftp/TFTP.java
index eb0199ca..adcd3bad 100644
--- a/src/main/java/org/apache/commons/net/tftp/TFTP.java
+++ b/src/main/java/org/apache/commons/net/tftp/TFTP.java
@@ -196,7 +196,7 @@ public class TFTP extends DatagramSocketClient {
* This method synchronizes a connection by discarding all packets that
may be in the local socket buffer. This method need only be called when you
* implement your own TFTP client or server.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
public final void discardPackets() throws IOException {
final DatagramPacket datagram = new DatagramPacket(new
byte[packetSize], packetSize);
diff --git a/src/test/java/org/apache/commons/net/MockTcpServer.java
b/src/test/java/org/apache/commons/net/MockTcpServer.java
index c23001c2..a1888fb5 100644
--- a/src/test/java/org/apache/commons/net/MockTcpServer.java
+++ b/src/test/java/org/apache/commons/net/MockTcpServer.java
@@ -66,7 +66,7 @@ public abstract class MockTcpServer implements Runnable,
Closeable {
* Creates new {@link MockTcpServer} that will bind to {@link
InetAddress#getLocalHost()}
* on random port.
*
- * @throws IOException if an I/O error occurs when opening the socket.
+ * @throws IOException Thrown if an I/O error occurs when opening the
socket.
*/
protected MockTcpServer() throws IOException {
this(0);
@@ -77,7 +77,7 @@ public abstract class MockTcpServer implements Runnable,
Closeable {
* on specified port.
*
* @param port The port number the server will bind to, or 0 to use a port
number that is automatically allocated
- * @throws IOException if an I/O error occurs when opening the socket.
+ * @throws IOException Thrown if an I/O error occurs when opening the
socket.
*/
protected MockTcpServer(final int port) throws IOException {
this(port, InetAddress.getLocalHost());
@@ -88,7 +88,7 @@ public abstract class MockTcpServer implements Runnable,
Closeable {
*
* @param port The port number the server will bind to, or 0 to use a port
number that is automatically allocated
* @param serverAddress The InetAddress the server will bind to
- * @throws IOException if an I/O error occurs when opening the socket.
+ * @throws IOException Thrown if an I/O error occurs when opening the
socket.
*/
protected MockTcpServer(final int port, final InetAddress serverAddress)
throws IOException {
this.serverAddress = serverAddress;
diff --git
a/src/test/java/org/apache/commons/net/daytime/MockDaytimeTCPServer.java
b/src/test/java/org/apache/commons/net/daytime/MockDaytimeTCPServer.java
index 33fd85ac..e0cdb7f4 100644
--- a/src/test/java/org/apache/commons/net/daytime/MockDaytimeTCPServer.java
+++ b/src/test/java/org/apache/commons/net/daytime/MockDaytimeTCPServer.java
@@ -60,7 +60,7 @@ public final class MockDaytimeTCPServer extends MockTcpServer
{
* Creates new {@link MockDaytimeTCPServer} that will bind to {@link
InetAddress#getLocalHost()}
* on random port.
*
- * @throws IOException if an I/O error occurs when opening the socket.
+ * @throws IOException Thrown if an I/O error occurs when opening the
socket.
*/
public MockDaytimeTCPServer() throws IOException {
}
@@ -70,7 +70,7 @@ public final class MockDaytimeTCPServer extends MockTcpServer
{
* on specified port.
*
* @param port The port number the server will bind to, or 0 to use a port
number that is automatically allocated
- * @throws IOException if an I/O error occurs when opening the socket.
+ * @throws IOException Thrown if an I/O error occurs when opening the
socket.
*/
public MockDaytimeTCPServer(final int port) throws IOException {
super(port);
@@ -81,7 +81,7 @@ public final class MockDaytimeTCPServer extends MockTcpServer
{
*
* @param port The port number the server will bind to, or 0 to use a port
number that is automatically allocated
* @param serverAddress The InetAddress the server will bind to
- * @throws IOException if an I/O error occurs when opening the socket.
+ * @throws IOException Thrown if an I/O error occurs when opening the
socket.
*/
public MockDaytimeTCPServer(final int port, final InetAddress
serverAddress) throws IOException {
super(port, serverAddress);
diff --git a/src/test/java/org/apache/commons/net/tftp/TFTPServer.java
b/src/test/java/org/apache/commons/net/tftp/TFTPServer.java
index c48dba2c..9af3bfd7 100644
--- a/src/test/java/org/apache/commons/net/tftp/TFTPServer.java
+++ b/src/test/java/org/apache/commons/net/tftp/TFTPServer.java
@@ -479,7 +479,7 @@ public class TFTPServer implements Runnable, AutoCloseable {
* @param mode A value as specified above.
* @param log Stream to write log message to. If not
provided, uses System.out
* @param errorLog Stream to write error messages to. If not
provided, uses System.err.
- * @throws IOException if the server directory is invalid or does not
exist.
+ * @throws IOException Thrown if the server directory is invalid or does
not exist.
*/
public TFTPServer(final File serverReadDirectory, final File
serverWriteDirectory, final int port, final InetAddress localAddress, final
ServerMode mode,
final PrintStream log, final PrintStream errorLog) throws
IOException {
@@ -507,7 +507,7 @@ public class TFTPServer implements Runnable, AutoCloseable {
* @param mode A value as specified above.
* @param log Stream to write log message to. If not
provided, uses System.out
* @param errorLog Stream to write error messages to. If not
provided, uses System.err.
- * @throws IOException if the server directory is invalid or does not
exist.
+ * @throws IOException Thrown if the server directory is invalid or does
not exist.
*/
public TFTPServer(final File serverReadDirectory, final File
serverWriteDirectory, final int port, final NetworkInterface localiface, final
ServerMode mode,
final PrintStream log, final PrintStream errorLog) throws
IOException {
@@ -541,7 +541,7 @@ public class TFTPServer implements Runnable, AutoCloseable {
* @param mode A value as specified above.
* @param log Stream to write log message to. If not
provided, uses System.out
* @param errorLog Stream to write error messages to. If not
provided, uses System.err.
- * @throws IOException if the server directory is invalid or does not
exist.
+ * @throws IOException Thrown if the server directory is invalid or does
not exist.
*/
public TFTPServer(final File serverReadDirectory, final File
serverWriteDirectory, final int port, final ServerMode mode, final PrintStream
log,
final PrintStream errorLog) throws IOException {
@@ -565,7 +565,7 @@ public class TFTPServer implements Runnable, AutoCloseable {
* @param serverReadDirectory directory for GET requests
* @param serverWriteDirectory directory for PUT requests
* @param mode A value as specified above.
- * @throws IOException if the server directory is invalid or does not
exist.
+ * @throws IOException Thrown if the server directory is invalid or does
not exist.
*/
public TFTPServer(final File serverReadDirectory, final File
serverWriteDirectory, final ServerMode mode) throws IOException {
this(serverReadDirectory, serverWriteDirectory, DEFAULT_TFTP_PORT,
mode, null, null);
