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 d6781264 No need for blank Javadoc lines between Javadoc @ tags
d6781264 is described below
commit d678126426620f1f10ab65fd3c5fd3448639a641
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Thu Nov 28 12:47:17 2024 -0500
No need for blank Javadoc lines between Javadoc @ tags
---
.../java/org/apache/commons/net/DatagramSocketFactory.java | 1 -
.../java/org/apache/commons/net/PrintCommandListener.java | 6 ------
src/main/java/org/apache/commons/net/echo/EchoUDPClient.java | 1 -
.../org/apache/commons/net/examples/ntp/SimpleNTPServer.java | 1 -
src/main/java/org/apache/commons/net/ftp/FTP.java | 2 --
src/main/java/org/apache/commons/net/ftp/FTPClient.java | 11 -----------
.../java/org/apache/commons/net/ftp/FTPFileEntryParser.java | 2 --
.../org/apache/commons/net/ftp/FTPFileEntryParserImpl.java | 2 --
.../java/org/apache/commons/net/ftp/FTPListParseEngine.java | 6 ------
.../net/ftp/parser/DefaultFTPFileEntryParserFactory.java | 1 -
.../commons/net/ftp/parser/FTPFileEntryParserFactory.java | 2 --
.../apache/commons/net/ftp/parser/FTPTimestampParserImpl.java | 1 -
.../commons/net/ftp/parser/RegexFTPFileEntryParserImpl.java | 3 ---
.../org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java | 1 -
.../commons/net/ftp/parser/VMSVersioningFTPEntryParser.java | 1 -
src/main/java/org/apache/commons/net/nntp/ArticlePointer.java | 1 -
src/main/java/org/apache/commons/net/nntp/NNTPClient.java | 2 --
src/main/java/org/apache/commons/net/ntp/TimeStamp.java | 3 ---
src/main/java/org/apache/commons/net/pop3/POP3Command.java | 1 -
.../org/apache/commons/net/smtp/AuthenticatingSMTPClient.java | 1 -
src/main/java/org/apache/commons/net/telnet/Telnet.java | 8 --------
src/main/java/org/apache/commons/net/telnet/TelnetClient.java | 6 ------
.../apache/commons/net/telnet/TelnetNotificationHandler.java | 1 -
src/main/java/org/apache/commons/net/util/Base64.java | 1 -
src/main/java/org/apache/commons/net/util/Charsets.java | 1 -
.../java/org/apache/commons/net/ftp/AbstractFtpsTest.java | 1 -
.../java/org/apache/commons/net/telnet/TelnetClientTest.java | 1 -
.../org/apache/commons/net/telnet/TelnetTestSimpleServer.java | 1 -
28 files changed, 69 deletions(-)
diff --git a/src/main/java/org/apache/commons/net/DatagramSocketFactory.java
b/src/main/java/org/apache/commons/net/DatagramSocketFactory.java
index fc8c2125..8bb046f5 100644
--- a/src/main/java/org/apache/commons/net/DatagramSocketFactory.java
+++ b/src/main/java/org/apache/commons/net/DatagramSocketFactory.java
@@ -33,7 +33,6 @@ public interface DatagramSocketFactory {
* Creates a DatagramSocket on the local host at the first available port.
*
* @return the socket
- *
* @throws SocketException If the socket could not be created.
*/
DatagramSocket createDatagramSocket() throws SocketException;
diff --git a/src/main/java/org/apache/commons/net/PrintCommandListener.java
b/src/main/java/org/apache/commons/net/PrintCommandListener.java
index 900f99dd..f1390d8d 100644
--- a/src/main/java/org/apache/commons/net/PrintCommandListener.java
+++ b/src/main/java/org/apache/commons/net/PrintCommandListener.java
@@ -52,7 +52,6 @@ public class PrintCommandListener implements
ProtocolCommandListener {
*
* @param printStream where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
- *
* @since 3.0
*/
@SuppressWarnings("resource")
@@ -66,7 +65,6 @@ public class PrintCommandListener implements
ProtocolCommandListener {
* @param printStream where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
* @param eolMarker if non-zero, add a marker just before the EOL.
- *
* @since 3.0
*/
@SuppressWarnings("resource")
@@ -81,7 +79,6 @@ public class PrintCommandListener implements
ProtocolCommandListener {
* @param suppressLogin if {@code true}, only print command name for login
* @param eolMarker if non-zero, add a marker just before the EOL.
* @param showDirection if {@code true}, add {@code "> "} or {@code "< "}
as appropriate to the output
- *
* @since 3.0
*/
@SuppressWarnings("resource")
@@ -103,7 +100,6 @@ public class PrintCommandListener implements
ProtocolCommandListener {
*
* @param writer where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
- *
* @since 3.0
*/
public PrintCommandListener(final PrintWriter writer, final boolean
suppressLogin) {
@@ -116,7 +112,6 @@ public class PrintCommandListener implements
ProtocolCommandListener {
* @param writer where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
* @param eolMarker if non-zero, add a marker just before the EOL.
- *
* @since 3.0
*/
public PrintCommandListener(final PrintWriter writer, final boolean
suppressLogin, final char eolMarker) {
@@ -130,7 +125,6 @@ public class PrintCommandListener implements
ProtocolCommandListener {
* @param suppressLogin if {@code true}, only print command name for login
* @param eolMarker if non-zero, add a marker just before the EOL.
* @param showDirection if {@code true}, add {@code ">} " or {@code "< "}
as appropriate to the output
- *
* @since 3.0
*/
public PrintCommandListener(final PrintWriter writer, final boolean
suppressLogin, final char eolMarker, final boolean showDirection) {
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 f0e77ea2..c81bf1b0 100644
--- a/src/main/java/org/apache/commons/net/echo/EchoUDPClient.java
+++ b/src/main/java/org/apache/commons/net/echo/EchoUDPClient.java
@@ -56,7 +56,6 @@ public final class EchoUDPClient extends DiscardUDPClient {
*
* @param data the buffer to receive the input
* @param length of the buffer
- *
* @return Length of actual data received.
* @throws IOException If an error occurs while receiving the data.
*/
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 168f4073..26e5ea09 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
@@ -102,7 +102,6 @@ public class SimpleNTPServer implements Runnable {
*
* @param request incoming DatagramPacket
* @param rcvTime time packet received
- *
* @throws IOException if an I/O error occurs.
*/
protected void handlePacket(final DatagramPacket request, final long
rcvTime) throws IOException {
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 65d6aca2..42004193 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTP.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTP.java
@@ -487,7 +487,6 @@ public class FTP extends SocketClient {
* </ul>
*
* @see "http://www.faqs.org/rfcs/rfc2428.html";
- *
* @param host The host owning the port.
* @param port The new port.
* @return The reply code received from the server.
@@ -683,7 +682,6 @@ public class FTP extends SocketClient {
* Returns the nth line of text from the last FTP server response as a
string. The end of line markers of each are stripped from the line.
*
* @param index The index of the line to return, 0-based.
- *
* @return The lines of text from the last FTP response as an array.
*/
String getReplyString(final int index) {
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 78c14ceb..e2277e0c 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
@@ -1275,7 +1275,6 @@ public class FTPClient extends FTP implements
Configurable {
* @param command The command to invoke
* @param params The parameters string, may be {@code null}
* @return True if successfully completed, false if not, in which case
call {@link #getReplyCode()} or {@link #getReplyString()} to get the reason.
- *
* @throws IOException If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.
* @since 3.0
*/
@@ -1405,7 +1404,6 @@ public class FTPClient extends FTP implements
Configurable {
* Queries the server for a supported feature, and returns its value (if
any). Caches the parsed response to avoid resending the command repeatedly.
*
* @param feature the feature to check
- *
* @return if the feature is present, returns the feature value or the
empty string if the feature exists but has no value. Returns {@code null} if the
* feature is not found or the command failed. Check {@link
#getReplyCode()} or {@link #getReplyString()} if so.
* @throws IOException on error
@@ -1423,7 +1421,6 @@ public class FTPClient extends FTP implements
Configurable {
* Queries the server for a supported feature, and returns its values (if
any). Caches the parsed response to avoid resending the command repeatedly.
*
* @param feature the feature to check
- *
* @return if the feature is present, returns the feature values (empty
array if none) Returns {@code null} if the feature is not found or the command
* failed. Check {@link #getReplyCode()} or {@link
#getReplyString()} if so.
* @throws IOException on error
@@ -1737,7 +1734,6 @@ public class FTPClient extends FTP implements
Configurable {
* Issue the FTP SIZE command to the server for a given pathname. This
should produce the size of the file.
*
* @param pathname the file name
- *
* @return The size information returned by the server; {@code null} if
there was an error
* @throws FTPConnectionClosedException If the FTP server prematurely
closes the connection as a result of the client being idle or some other reason
* causing the server to send FTP
reply code 421. This exception may be caught either as an IOException or
@@ -1772,7 +1768,6 @@ public class FTPClient extends FTP implements
Configurable {
* Issue the FTP STAT command to the server for a given pathname. This
should produce a listing of the file or directory.
*
* @param pathname the file name
- *
* @return The status information returned by the server.
* @throws FTPConnectionClosedException If the FTP server prematurely
closes the connection as a result of the client being idle or some other reason
* causing the server to send FTP
reply code 421. This exception may be caught either as an IOException or
@@ -1873,7 +1868,6 @@ public class FTPClient extends FTP implements
Configurable {
*
* @param feature the name of the feature; it is converted to upper case.
* @param value the value to find.
- *
* @return {@code true} if the feature is present, {@code false} if the
feature is not present or the {@link #feat()} command failed. Check
* {@link #getReplyCode()} or {@link #getReplyString()} if it is
necessary to distinguish these cases.
*
@@ -2023,7 +2017,6 @@ public class FTPClient extends FTP implements
Configurable {
* </pre>
*
* @param pathname the starting directory
- *
* @return A FTPListParseEngine object that holds the raw information and
is capable of providing parsed FTPFile objects, one for each file containing
* information contained in the given path in the format
determined by the {@code parser} parameter. Null will be returned if a data
connection
* cannot be opened. If the current working directory contains no
files, an empty array will be the return.
@@ -2059,7 +2052,6 @@ public class FTPClient extends FTP implements
Configurable {
* is not defined the SYST command is used to provide the
value. To allow for arbitrary system types, the return from the SYST command is
* used to look up an alias for the type in the {@link
#SYSTEM_TYPE_PROPERTIES} properties file if it is available.
* @param pathname the starting directory
- *
* @return A FTPListParseEngine object that holds the raw information and
is capable of providing parsed FTPFile objects, one for each file containing
* information contained in the given path in the format
determined by the {@code parser} parameter. Null will be returned if a data
connection
* cannot be opened. If the current working directory contains no
files, an empty array will be the return.
@@ -2120,7 +2112,6 @@ public class FTPClient extends FTP implements
Configurable {
* restores the old behavior. To enable this by default, use the system
property {@link FTPClient#FTP_IP_ADDRESS_FROM_PASV_RESPONSE}.
*
* @return True, if the IP address from the server's response will be used
(pre-3.9 compatible behavior), or false (ignore that IP address).
- *
* @see FTPClient#FTP_IP_ADDRESS_FROM_PASV_RESPONSE
* @see #setIpAddressFromPasvResponse(boolean)
* @since 3.9.0
@@ -2641,7 +2632,6 @@ public class FTPClient extends FTP implements
Configurable {
* The other server must have had a {@code remoteRetrieve} issued to it by
another FTPClient.
*
* @param fileName The name of the file to be appended to, or if the file
does not exist, the name to call the file being stored.
- *
* @return True if successfully completed, false if not.
* @throws FTPConnectionClosedException If the FTP server prematurely
closes the connection as a result of the client being idle or some other reason
* causing the server to send FTP
reply code 421. This exception may be caught either as an IOException or
@@ -3124,7 +3114,6 @@ public class FTPClient extends FTP implements
Configurable {
* set the factory used for parser creation to the supplied factory object.
*
* @param parserFactory factory object used to create FTPFileEntryParsers
- *
* @see org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory
* @see org.apache.commons.net.ftp.parser.DefaultFTPFileEntryParserFactory
*/
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java
b/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java
index f5ee8832..dbace5c2 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java
@@ -82,7 +82,6 @@ public interface FTPFileEntryParser {
* The default implementation can be a no-op.
*
* @param original Original list after it has been created from the server
stream
- *
* @return Original list as processed by this method.
*/
List<String> preParse(List<String> original);
@@ -92,7 +91,6 @@ public interface FTPFileEntryParser {
* particular ftp system being parsed. In many but not all cases, this can
be defined simply by calling BufferedReader.readLine().
*
* @param reader The BufferedReader object from which entries are to be
read.
- *
* @return A string representing the next ftp entry or null if none found.
* @throws IOException thrown on any IO Error reading from the reader.
*/
diff --git
a/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParserImpl.java
b/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParserImpl.java
index 4721ee78..da93cc58 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParserImpl.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParserImpl.java
@@ -39,7 +39,6 @@ public abstract class FTPFileEntryParserImpl implements
FTPFileEntryParser {
* This default implementation does nothing.
*
* @param original Original list after it has been created from the server
stream
- *
* @return {@code original} unmodified.
*/
@Override
@@ -52,7 +51,6 @@ public abstract class FTPFileEntryParserImpl implements
FTPFileEntryParser {
* BufferedReader.readLine().
*
* @param reader The BufferedReader object from which entries are to be
read.
- *
* @return A string representing the next ftp entry or null if none found.
* @throws IOException thrown on any IO Error reading from the reader.
*/
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 f6369fc6..020b8389 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java
@@ -98,7 +98,6 @@ public class FTPListParseEngine {
* before being added to the array.
*
* @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>
* <strong> NOTE:</strong> This array may contain null members if
any of the individual file listings failed to parse. The caller should check
each
@@ -129,7 +128,6 @@ public class FTPListParseEngine {
* before being added to the array.
*
* @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>
* <strong> NOTE:</strong> This array may contain null members if
any of the individual file listings failed to parse. The caller should check
each
@@ -150,7 +148,6 @@ public class FTPListParseEngine {
* After this method is called this object's internal iterator is advanced
by a number of positions equal to the size of the array returned.
*
* @param quantityRequested the maximum number of entries we want to get.
- *
* @return an array of at most {@code quantityRequested} FTPFile objects
starting at the current position of this iterator within its list and at least
the
* number of elements which exist in the list at and after its
current position.
* <p>
@@ -183,7 +180,6 @@ public class FTPListParseEngine {
* After this method is called this object's internal iterator is moved
back by a number of positions equal to the size of the array returned.
*
* @param quantityRequested the maximum number of entries we want to get.
- *
* @return an array of at most {@code quantityRequested} FTPFile objects
starting at the current position of this iterator within its list and at least
the
* number of elements which exist in the list at and after its
current position. This array will be in the same order as the underlying list
(not
* reversed).
@@ -231,7 +227,6 @@ public class FTPListParseEngine {
*
* @param inputStream The socket stream on which the input will be read.
* @param charsetName The encoding to use.
- *
* @throws IOException thrown on any failure to read the stream
*/
private void read(final InputStream inputStream, final String charsetName)
throws IOException {
@@ -264,7 +259,6 @@ public class FTPListParseEngine {
*
* @param inputStream input stream provided by the server socket.
* @param charsetName the encoding to be used for reading the stream
- *
* @throws IOException thrown on any failure to read from the sever.
*/
public void readServerList(final InputStream inputStream, final String
charsetName) throws IOException {
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/DefaultFTPFileEntryParserFactory.java
b/src/main/java/org/apache/commons/net/ftp/parser/DefaultFTPFileEntryParserFactory.java
index 3a0304a0..4deb840b 100644
---
a/src/main/java/org/apache/commons/net/ftp/parser/DefaultFTPFileEntryParserFactory.java
+++
b/src/main/java/org/apache/commons/net/ftp/parser/DefaultFTPFileEntryParserFactory.java
@@ -50,7 +50,6 @@ public class DefaultFTPFileEntryParserFactory implements
FTPFileEntryParserFacto
* </p>
*
* @param config A {@link FTPClientConfig FTPClientConfig} used to
configure the parser created
- *
* @return the {@link FTPFileEntryParser} so created.
* @throws ParserInitializationException Thrown on any exception in
instantiation
* @throws NullPointerException if {@code config} is {@code null}
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 61fbad96..f9f9f52d 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
@@ -37,7 +37,6 @@ public interface FTPFileEntryParserFactory {
* </p>
*
* @param config A {@link FTPClientConfig FTPClientConfig} used to
configure the parser created
- *
* @return the {@link FTPFileEntryParser} so created.
* @throws ParserInitializationException Thrown on any exception in
instantiation
* @since 1.4
@@ -48,7 +47,6 @@ public interface FTPFileEntryParserFactory {
* Implementation should be a method that decodes the supplied key and
creates an object implementing the interface FTPFileEntryParser.
*
* @param key A string that somehow identifies an FTPFileEntryParser to be
created.
- *
* @return the FTPFileEntryParser created.
* @throws ParserInitializationException Thrown on any exception in
instantiation
*/
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParserImpl.java
b/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParserImpl.java
index 869e9277..42820df9 100644
---
a/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParserImpl.java
+++
b/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParserImpl.java
@@ -235,7 +235,6 @@ public class FTPTimestampParserImpl implements
FTPTimestampParser, Configurable
* This method assumes that the server time is the same as the local time.
*
* @see FTPTimestampParserImpl#parseTimestamp(String, Calendar)
- *
* @param timestampStr The timestamp to be parsed
* @return a Calendar with the parsed timestamp
*/
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 fa10df9c..4b5d5407 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
@@ -50,7 +50,6 @@ public abstract class RegexFTPFileEntryParserImpl extends
FTPFileEntryParserImpl
* The constructor for a RegexFTPFileEntryParserImpl object. The
expression is compiled with flags = 0.
*
* @param regex The regular expression with which this object is
initialized.
- *
* @throws IllegalArgumentException Thrown if the regular expression is
unparseable. Should not be seen in normal conditions. If it is seen, this is a
sign
* that a subclass has been created with
a bad regular expression. Since the parser must be created before use, this
means
* that any bad parser subclasses created
from this will bomb very quickly, leading to easy detection.
@@ -65,7 +64,6 @@ public abstract class RegexFTPFileEntryParserImpl extends
FTPFileEntryParserImpl
*
* @param regex The regular expression with which this object is
initialized.
* @param flags the flags to apply, see {@link Pattern#compile(String,
int)}. Use 0 for none.
- *
* @throws IllegalArgumentException Thrown if the regular expression is
unparseable. Should not be seen in normal conditions. If it is seen, this is a
sign
* that a subclass has been created with
a bad regular expression. Since the parser must be created before use, this
means
* that any bad parser subclasses created
from this will bomb very quickly, leading to easy detection.
@@ -123,7 +121,6 @@ public abstract class RegexFTPFileEntryParserImpl extends
FTPFileEntryParserImpl
* Convenience method delegates to the internal MatchResult's group()
method.
*
* @param matchNum match group number to be retrieved
- *
* @return the content of the {@code matchnum'th} group of the internal
match or null if this method is called without a match having been made.
*/
public String group(final int matchNum) {
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
b/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
index 8dfd7908..38e84f4f 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
@@ -198,7 +198,6 @@ public class VMSFTPEntryParser extends
ConfigurableFTPFileEntryParserImpl {
* implementation of simply calling BufferedReader.readLine(), because one
entry may span multiple lines.
*
* @param reader The BufferedReader object from which entries are to be
read.
- *
* @return A string representing the next ftp entry or null if none found.
* @throws IOException thrown on any IO Error reading from the reader.
*/
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/VMSVersioningFTPEntryParser.java
b/src/main/java/org/apache/commons/net/ftp/parser/VMSVersioningFTPEntryParser.java
index 486cbb61..c0865383 100644
---
a/src/main/java/org/apache/commons/net/ftp/parser/VMSVersioningFTPEntryParser.java
+++
b/src/main/java/org/apache/commons/net/ftp/parser/VMSVersioningFTPEntryParser.java
@@ -84,7 +84,6 @@ public class VMSVersioningFTPEntryParser extends
VMSFTPEntryParser {
* to remove the duplicates.
*
* @param original Original list
- *
* @return Original list purged of duplicates
*/
@Override
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 130a0e06..ccd4a4a9 100644
--- a/src/main/java/org/apache/commons/net/nntp/ArticlePointer.java
+++ b/src/main/java/org/apache/commons/net/nntp/ArticlePointer.java
@@ -22,7 +22,6 @@ package org.apache.commons.net.nntp;
* information when issuing a STAT command, implemented by {@link
NNTPClient#selectArticle selectArticle}.
*
* @see NNTPClient
- *
* @deprecated 3.0 use {@link ArticleInfo} instead
*/
@Deprecated
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 8efe6640..8b41ea80 100644
--- a/src/main/java/org/apache/commons/net/nntp/NNTPClient.java
+++ b/src/main/java/org/apache/commons/net/nntp/NNTPClient.java
@@ -417,7 +417,6 @@ public class NNTPClient extends NNTP {
* causing the server to send NNTP
reply code 400. This exception may be caught either as an IOException or
* independently as itself.
* @throws IOException If an I/O error occurs while
either sending a command to the server or receiving a reply from the server.
- *
* @see #iterateNewNews(NewGroupsOrNewsQuery)
*/
public String[] listNewNews(final NewGroupsOrNewsQuery query) throws
IOException {
@@ -542,7 +541,6 @@ public class NNTPClient extends NNTP {
*
* @param reply the reply to parse "22n nnn <aaa>"
* @param pointer the pointer to update
- *
* @throws MalformedServerReplyException if response could not be parsed
*/
private void parseArticlePointer(final String reply, final ArticleInfo
pointer) throws MalformedServerReplyException {
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 6106b353..1dc4a98c 100644
--- a/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
+++ b/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
@@ -74,7 +74,6 @@ public class TimeStamp implements Serializable,
Comparable<TimeStamp> {
* Convert NTP timestamp hexstring (e.g. "c1a089bd.fc904f6d") to the NTP
64-bit unsigned fixed-point number.
*
* @param hexString the string to convert
- *
* @return NTP 64-bit timestamp value.
* @throws NumberFormatException - if the string does not contain a
parsable timestamp.
*/
@@ -196,7 +195,6 @@ public class TimeStamp implements Serializable,
Comparable<TimeStamp> {
* fractional seconds by a decimal point; e.g. c1a089bd.fc904f6d == Tue,
Dec 10 2002 10:41:49.986
*
* @param ntpTime the 64 bit timestamp
- *
* @return NTP timestamp 64-bit long value as hexadecimal string with
seconds separated by fractional seconds.
*/
public static String toString(final long ntpTime) {
@@ -243,7 +241,6 @@ public class TimeStamp implements Serializable,
Comparable<TimeStamp> {
* Constructs a newly allocated NTP timestamp object that represents the
value represented by the string in hexdecimal form (e.g. "c1a089bd.fc904f6d").
*
* @param hexStamp the hexadecimal timestamp
- *
* @throws NumberFormatException - if the string does not contain a
parsable timestamp.
*/
public TimeStamp(final String hexStamp) throws NumberFormatException {
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 cd48cc08..7137308c 100644
--- a/src/main/java/org/apache/commons/net/pop3/POP3Command.java
+++ b/src/main/java/org/apache/commons/net/pop3/POP3Command.java
@@ -73,7 +73,6 @@ public final class POP3Command {
* Gets the POP3 protocol string command corresponding to a command code.
*
* @param command the command code
- *
* @return The POP3 protocol string command corresponding to a command
code.
*/
public static String getCommand(final int command) {
diff --git
a/src/main/java/org/apache/commons/net/smtp/AuthenticatingSMTPClient.java
b/src/main/java/org/apache/commons/net/smtp/AuthenticatingSMTPClient.java
index a8f9be55..ee0f5b99 100644
--- a/src/main/java/org/apache/commons/net/smtp/AuthenticatingSMTPClient.java
+++ b/src/main/java/org/apache/commons/net/smtp/AuthenticatingSMTPClient.java
@@ -152,7 +152,6 @@ public class AuthenticatingSMTPClient extends SMTPSClient {
* @param user the user name. If the method is XOAUTH/XOAUTH2, then this
is used as the plain text oauth protocol parameter string which is
* Base64-encoded for transmission.
* @param password the password for the username. Ignored for
XOAUTH/XOAUTH2.
- *
* @return True if successfully completed, false if not.
* @throws SMTPConnectionClosedException If the SMTP server prematurely
closes the connection as a result of the client being idle or some other reason
* causing the server to send SMTP
reply code 421. This exception may be caught either as an IOException or
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 206fa4e7..15656997 100644
--- a/src/main/java/org/apache/commons/net/telnet/Telnet.java
+++ b/src/main/java/org/apache/commons/net/telnet/Telnet.java
@@ -634,7 +634,6 @@ class Telnet extends SocketClient {
* Looks for the state of the option.
*
* @return returns true if a {@code DO} has been requested.
- *
* @param option option code to be looked up.
*/
boolean requestedDo(final int option) {
@@ -645,7 +644,6 @@ class Telnet extends SocketClient {
* Looks for the state of the option.
*
* @return returns true if a {@code DONT} has been requested
- *
* @param option option code to be looked up.
*/
boolean requestedDont(final int option) {
@@ -656,7 +654,6 @@ class Telnet extends SocketClient {
* Looks for the state of the option.
*
* @return returns true if a {@code WILL} has been requested
- *
* @param option option code to be looked up.
*/
boolean requestedWill(final int option) {
@@ -667,7 +664,6 @@ class Telnet extends SocketClient {
* Looks for the state of the option.
*
* @return returns true if a {@code WONT} has been requested
- *
* @param option option code to be looked up.
*/
boolean requestedWont(final int option) {
@@ -970,7 +966,6 @@ class Telnet extends SocketClient {
* Looks for the state of the option.
*
* @return returns true if a {@code DO} has been acknowledged.
- *
* @param option option code to be looked up.
*/
boolean stateIsDo(final int option) {
@@ -981,7 +976,6 @@ class Telnet extends SocketClient {
* Looks for the state of the option.
*
* @return returns true if a {@code DONT} has been acknowledged
- *
* @param option option code to be looked up.
*/
boolean stateIsDont(final int option) {
@@ -992,7 +986,6 @@ class Telnet extends SocketClient {
* Looks for the state of the option.
*
* @return returns true if a {@code WILL} has been acknowledged
- *
* @param option option code to be looked up.
*/
boolean stateIsWill(final int option) {
@@ -1003,7 +996,6 @@ class Telnet extends SocketClient {
* Looks for the state of the option.
*
* @return returns true if a {@code WONT} has been acknowledged
- *
* @param option option code to be looked up.
*/
boolean stateIsWont(final int option) {
diff --git a/src/main/java/org/apache/commons/net/telnet/TelnetClient.java
b/src/main/java/org/apache/commons/net/telnet/TelnetClient.java
index af3d793a..5eeba879 100644
--- a/src/main/java/org/apache/commons/net/telnet/TelnetClient.java
+++ b/src/main/java/org/apache/commons/net/telnet/TelnetClient.java
@@ -108,7 +108,6 @@ public class TelnetClient extends Telnet {
* Registers a new TelnetOptionHandler for this Telnet client to use.
*
* @param opthand option handler to be registered.
- *
* @throws InvalidTelnetOptionException on error
* @throws IOException on error
*/
@@ -133,7 +132,6 @@ public class TelnetClient extends Telnet {
* Unregisters a TelnetOptionHandler.
*
* @param optcode Code of the option to be unregistered.
- *
* @throws InvalidTelnetOptionException on error
* @throws IOException on error
*/
@@ -183,7 +181,6 @@ public class TelnetClient extends Telnet {
* Returns the state of the option on the local side.
*
* @param option Option to be checked.
- *
* @return The state of the option on the local side.
*/
public boolean getLocalOptionState(final int option) {
@@ -217,7 +214,6 @@ public class TelnetClient extends Telnet {
* Returns the state of the option on the remote side.
*
* @param option Option to be checked.
- *
* @return The state of the option on the remote side.
*/
public boolean getRemoteOptionState(final int option) {
@@ -275,7 +271,6 @@ public class TelnetClient extends Telnet {
* Sends an {@code Are You There (AYT)} sequence and waits for the result.
*
* @param timeout Time to wait for a response.
- *
* @return true if AYT received a response, false otherwise.
*
* @throws InterruptedException on error
@@ -291,7 +286,6 @@ public class TelnetClient extends Telnet {
* Sends an {@code Are You There (AYT)} sequence and waits for the result.
*
* @param timeout Time to wait for a response (millis.)
- *
* @return true if AYT received a response, false otherwise
*
* @throws InterruptedException on error
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 364a78f7..72fb01ad 100644
--- a/src/main/java/org/apache/commons/net/telnet/TelnetNotificationHandler.java
+++ b/src/main/java/org/apache/commons/net/telnet/TelnetNotificationHandler.java
@@ -56,7 +56,6 @@ public interface TelnetNotificationHandler {
* Callback method called when TelnetClient receives a command or option
negotiation command
*
* @param negotiation_code type of (negotiation) command received
(RECEIVED_DO, RECEIVED_DONT, RECEIVED_WILL, RECEIVED_WONT, RECEIVED_COMMAND)
- *
* @param option_code code of the option negotiated, or the command
code itself (e.g. NOP).
*/
void receivedNegotiation(int negotiation_code, int option_code);
diff --git a/src/main/java/org/apache/commons/net/util/Base64.java
b/src/main/java/org/apache/commons/net/util/Base64.java
index 751fc278..71314324 100644
--- a/src/main/java/org/apache/commons/net/util/Base64.java
+++ b/src/main/java/org/apache/commons/net/util/Base64.java
@@ -316,7 +316,6 @@ public class Base64 {
* @param array byte[] array which will later be encoded
* @param lineSize line-length of the output (<= 0 means no chunking)
between each chunkSeparator (e.g. CRLF).
* @param linkSeparator the sequence of bytes used to separate chunks of
output (e.g. CRLF).
- *
* @return amount of space needed to encode the supplied array. Returns a
long since a max-len array will require Integer.MAX_VALUE + 33%.
*/
static long getEncodeLength(final byte[] array, int lineSize, final byte[]
linkSeparator) {
diff --git a/src/main/java/org/apache/commons/net/util/Charsets.java
b/src/main/java/org/apache/commons/net/util/Charsets.java
index fc40743e..b4fef5c3 100644
--- a/src/main/java/org/apache/commons/net/util/Charsets.java
+++ b/src/main/java/org/apache/commons/net/util/Charsets.java
@@ -41,7 +41,6 @@ public class Charsets {
*
* @param charsetName The name of the requested charset; may be a
canonical name, an alias, or null. If null, return the default charset.
* @param defaultCharsetName the charset name to use if the requested
charset is null
- *
* @return A charset object for the named charset
*/
public static Charset toCharset(final String charsetName, final String
defaultCharsetName) {
diff --git a/src/test/java/org/apache/commons/net/ftp/AbstractFtpsTest.java
b/src/test/java/org/apache/commons/net/ftp/AbstractFtpsTest.java
index f8cd66f5..88d7553e 100644
--- a/src/test/java/org/apache/commons/net/ftp/AbstractFtpsTest.java
+++ b/src/test/java/org/apache/commons/net/ftp/AbstractFtpsTest.java
@@ -66,7 +66,6 @@ public abstract class AbstractFtpsTest {
/**
* Returns the test directory as a String.
* @param defaultHome A default value.
- *
* @return the test directory as a String
*/
protected static String getTestHomeDirectory(final String defaultHome) {
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 0b533999..f39f498d 100644
--- a/src/test/java/org/apache/commons/net/telnet/TelnetClientTest.java
+++ b/src/test/java/org/apache/commons/net/telnet/TelnetClientTest.java
@@ -104,7 +104,6 @@ public class TelnetClientTest extends TestCase implements
TelnetNotificationHand
* Callback method called when TelnetClient receives an option negotiation
command. <p>
*
* @param negotiation_code type of negotiation command received
(RECEIVED_DO, RECEIVED_DONT, RECEIVED_WILL, RECEIVED_WONT) <p>
- *
* @param option_code code of the option negotiated <p>
*/
@Override
diff --git
a/src/test/java/org/apache/commons/net/telnet/TelnetTestSimpleServer.java
b/src/test/java/org/apache/commons/net/telnet/TelnetTestSimpleServer.java
index 126c9393..3420ccdd 100644
--- a/src/test/java/org/apache/commons/net/telnet/TelnetTestSimpleServer.java
+++ b/src/test/java/org/apache/commons/net/telnet/TelnetTestSimpleServer.java
@@ -34,7 +34,6 @@ public class TelnetTestSimpleServer implements Runnable {
* test of client-driven subnegotiation. <p>
*
* @param port server port on which to listen.
- *
* @throws IOException on error
*/
public TelnetTestSimpleServer(final int port) throws IOException {
