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 4b4c68d9 Javadoc
4b4c68d9 is described below
commit 4b4c68d91ed1797232c98a478ca00dcb56758094
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:51:17 2026 -0400
Javadoc
---
.../apache/commons/net/DatagramSocketClient.java | 6 ++--
.../apache/commons/net/DatagramSocketFactory.java | 6 ++--
.../java/org/apache/commons/net/SocketClient.java | 16 +++++------
.../commons/net/daytime/DaytimeUDPClient.java | 2 +-
.../org/apache/commons/net/echo/EchoUDPClient.java | 2 +-
.../commons/net/examples/mail/IMAPUtils.java | 2 +-
src/main/java/org/apache/commons/net/ftp/FTP.java | 4 +--
.../java/org/apache/commons/net/ftp/FTPClient.java | 32 +++++++++++-----------
.../apache/commons/net/ftp/FTPClientConfig.java | 14 +++++-----
.../org/apache/commons/net/ftp/FTPSClient.java | 8 +++---
.../commons/net/ftp/FTPSServerSocketFactory.java | 2 +-
.../apache/commons/net/ftp/FTPSSocketFactory.java | 8 +++---
.../parser/ConfigurableFTPFileEntryParserImpl.java | 2 +-
.../parser/DefaultFTPFileEntryParserFactory.java | 8 +++---
.../net/ftp/parser/FTPFileEntryParserFactory.java | 4 +--
.../net/ftp/parser/FTPTimestampParserImpl.java | 14 +++++-----
.../commons/net/ftp/parser/MLSxEntryParser.java | 2 +-
.../net/ftp/parser/MacOsPeterFTPEntryParser.java | 2 +-
.../commons/net/ftp/parser/NTFTPEntryParser.java | 2 +-
.../net/ftp/parser/NetwareFTPEntryParser.java | 2 +-
.../commons/net/ftp/parser/OS2FTPEntryParser.java | 2 +-
.../net/ftp/parser/OS400FTPEntryParser.java | 2 +-
.../ftp/parser/ParserInitializationException.java | 2 +-
.../ftp/parser/RegexFTPFileEntryParserImpl.java | 4 +--
.../commons/net/ftp/parser/UnixFTPEntryParser.java | 2 +-
.../commons/net/ftp/parser/VMSFTPEntryParser.java | 4 +--
.../java/org/apache/commons/net/imap/IMAP.java | 2 +-
.../org/apache/commons/net/imap/IMAPReply.java | 2 +-
.../java/org/apache/commons/net/nntp/Article.java | 16 +++++------
.../apache/commons/net/nntp/ArticleIterator.java | 2 +-
.../java/org/apache/commons/net/nntp/NNTP.java | 2 +-
.../org/apache/commons/net/nntp/NNTPClient.java | 12 ++++----
.../org/apache/commons/net/nntp/Threadable.java | 2 +-
.../org/apache/commons/net/ntp/NTPUDPClient.java | 2 +-
.../java/org/apache/commons/net/ntp/NtpUtils.java | 4 +--
.../java/org/apache/commons/net/ntp/NtpV3Impl.java | 12 ++++----
.../org/apache/commons/net/ntp/NtpV3Packet.java | 32 +++++++++++-----------
.../java/org/apache/commons/net/ntp/TimeStamp.java | 10 +++----
.../java/org/apache/commons/net/smtp/SMTP.java | 4 +--
.../net/telnet/InvalidTelnetOptionException.java | 2 +-
.../commons/net/telnet/TelnetInputStream.java | 2 +-
.../org/apache/commons/net/time/TimeUDPClient.java | 4 +--
.../apache/commons/net/util/KeyManagerUtils.java | 8 +++---
.../org/apache/commons/net/util/ListenerList.java | 2 +-
.../apache/commons/net/util/SSLContextUtils.java | 4 +--
.../org/apache/commons/net/util/SubnetUtils.java | 24 ++++++++--------
.../org/apache/commons/net/util/SubnetUtils6.java | 18 ++++++------
.../apache/commons/net/util/TrustManagerUtils.java | 6 ++--
.../java/org/apache/commons/net/MockTcpServer.java | 2 +-
.../commons/net/daytime/DaytimeTCPClientTest.java | 2 +-
.../commons/net/daytime/MockDaytimeTCPServer.java | 2 +-
.../apache/commons/net/ftp/AbstractFtpsTest.java | 2 +-
.../org/apache/commons/net/tftp/TFTPServer.java | 6 ++--
53 files changed, 170 insertions(+), 170 deletions(-)
diff --git a/src/main/java/org/apache/commons/net/DatagramSocketClient.java
b/src/main/java/org/apache/commons/net/DatagramSocketClient.java
index c0953e77..8cbec2a0 100644
--- a/src/main/java/org/apache/commons/net/DatagramSocketClient.java
+++ b/src/main/java/org/apache/commons/net/DatagramSocketClient.java
@@ -77,7 +77,7 @@ public abstract class DatagramSocketClient implements
AutoCloseable {
* This method does not allocate resources.
* </p>
*
- * @return the non-null DatagramSocket.
+ * @return The non-null DatagramSocket.
* @since 3.10.0
*/
protected DatagramSocket checkOpen() {
@@ -98,7 +98,7 @@ public abstract class DatagramSocketClient implements
AutoCloseable {
/**
* Gets the charset.
*
- * @return the charset.
+ * @return The charset.
* @since 3.3
*/
public Charset getCharset() {
@@ -108,7 +108,7 @@ public abstract class DatagramSocketClient implements
AutoCloseable {
/**
* Gets the charset name.
*
- * @return the charset name.
+ * @return The charset name.
* @since 3.3
* @deprecated Use {@link #getCharset()} instead
*/
diff --git a/src/main/java/org/apache/commons/net/DatagramSocketFactory.java
b/src/main/java/org/apache/commons/net/DatagramSocketFactory.java
index b29b9fb4..9f724533 100644
--- a/src/main/java/org/apache/commons/net/DatagramSocketFactory.java
+++ b/src/main/java/org/apache/commons/net/DatagramSocketFactory.java
@@ -31,7 +31,7 @@ public interface DatagramSocketFactory {
/**
* Creates a DatagramSocket on the local host at the first available port.
*
- * @return the socket
+ * @return The socket
* @throws SocketException If the socket could not be created.
*/
DatagramSocket createDatagramSocket() throws SocketException;
@@ -40,7 +40,7 @@ public interface DatagramSocketFactory {
* Creates a DatagramSocket on the local host at a specified port.
*
* @param port The port to use for the socket.
- * @return the socket
+ * @return The socket
* @throws SocketException If the socket could not be created.
*/
DatagramSocket createDatagramSocket(int port) throws SocketException;
@@ -50,7 +50,7 @@ public interface DatagramSocketFactory {
*
* @param port The port to use for the socket.
* @param localAddress The local address to use.
- * @return the socket
+ * @return The socket
* @throws SocketException If the socket could not be created.
*/
DatagramSocket createDatagramSocket(int port, InetAddress localAddress)
throws SocketException;
diff --git a/src/main/java/org/apache/commons/net/SocketClient.java
b/src/main/java/org/apache/commons/net/SocketClient.java
index 3c95efa2..eced32f1 100644
--- a/src/main/java/org/apache/commons/net/SocketClient.java
+++ b/src/main/java/org/apache/commons/net/SocketClient.java
@@ -211,7 +211,7 @@ public abstract class SocketClient {
* This method does not allocate resources.
* </p>
*
- * @return the non-null OutputStream.
+ * @return The non-null OutputStream.
* @since 3.11.0
*/
protected OutputStream checkOpenOutputStream() {
@@ -360,7 +360,7 @@ public abstract class SocketClient {
/**
* Gets the charset.
*
- * @return the charset.
+ * @return The charset.
* @since 3.3
*/
public Charset getCharset() {
@@ -370,7 +370,7 @@ public abstract class SocketClient {
/**
* Gets the charset name.
*
- * @return the charset.
+ * @return The charset.
* @since 3.3
* @deprecated Since the code now requires Java 1.6 as a minimum.
*/
@@ -382,7 +382,7 @@ public abstract class SocketClient {
/**
* Subclasses can override this if they need to provide their own instance
field for backwards compatibility.
*
- * @return the CommandSupport instance, may be {@code null}.
+ * @return The CommandSupport instance, may be {@code null}.
* @since 3.0
*/
protected ProtocolCommandSupport getCommandSupport() {
@@ -452,7 +452,7 @@ public abstract class SocketClient {
/**
* Gets the proxy for use with all the connections.
*
- * @return the current proxy for connections.
+ * @return The current proxy for connections.
*/
public Proxy getProxy() {
return connProxy;
@@ -461,7 +461,7 @@ public abstract class SocketClient {
/**
* Gets the current receivedBuffer size.
*
- * @return the size, or -1 if not initialized.
+ * @return The size, or -1 if not initialized.
* @since 3.0
*/
protected int getReceiveBufferSize() {
@@ -481,7 +481,7 @@ public abstract class SocketClient {
/**
* Gets the remote socket address used for the connection.
*
- * @return the remote socket address used for the connection
+ * @return The remote socket address used for the connection
* @since 3.10.0
*/
protected InetSocketAddress getRemoteInetSocketAddress() {
@@ -501,7 +501,7 @@ public abstract class SocketClient {
/**
* Gets the current sendBuffer size.
*
- * @return the size, or -1 if not initialized.
+ * @return The size, or -1 if not initialized.
* @since 3.0
*/
protected int getSendBufferSize() {
diff --git a/src/main/java/org/apache/commons/net/daytime/DaytimeUDPClient.java
b/src/main/java/org/apache/commons/net/daytime/DaytimeUDPClient.java
index a23ee901..a2fd5d54 100644
--- a/src/main/java/org/apache/commons/net/daytime/DaytimeUDPClient.java
+++ b/src/main/java/org/apache/commons/net/daytime/DaytimeUDPClient.java
@@ -60,7 +60,7 @@ public final class DaytimeUDPClient extends
DatagramSocketClient {
* </p>
*
* @param host the host
- * @return the time
+ * @return The time
* @throws IOException on error
*/
public String getTime(final InetAddress host) throws IOException {
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 d056608c..df569578 100644
--- a/src/main/java/org/apache/commons/net/echo/EchoUDPClient.java
+++ b/src/main/java/org/apache/commons/net/echo/EchoUDPClient.java
@@ -51,7 +51,7 @@ public final class EchoUDPClient extends DiscardUDPClient {
* Same as {@code receive(data, data.length)}
*
* @param data the buffer to receive the input
- * @return the number of bytes
+ * @return The number of bytes
* @throws IOException on error
*/
public int receive(final byte[] data) throws IOException {
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 d4efc628..767fe8dd 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
@@ -35,7 +35,7 @@ final class IMAPUtils {
* @param uri the URI to use, e.g.
imaps://user:[email protected]/folder or
imaps://user:[email protected]/folder
* @param defaultTimeout initial timeout (in milliseconds)
* @param listener for tracing protocol IO (may be null)
- * @return the IMAP client - connected and logged in
+ * @return The IMAP client - connected and logged in
* @throws IOException if any problems occur
*/
static IMAPClient imapLogin(final URI uri, final int defaultTimeout, final
ProtocolCommandListener listener) 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 4245387d..fc2a9aa1 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTP.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTP.java
@@ -620,7 +620,7 @@ public class FTP extends SocketClient {
* }</pre>
*
* @param reportReply whether to fire a reply received event.
- * @return the reply code.
+ * @return The reply code.
* @throws IOException If an I/O error occurs.
*/
private int getReply(final boolean reportReply) throws IOException {
@@ -813,7 +813,7 @@ public class FTP extends SocketClient {
* Sends the MDTM command for the given file.
*
* @param file name of file
- * @return the status
+ * @return The status
* @throws IOException on error
* @since 2.0
**/
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 563241b5..2665e485 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
@@ -480,7 +480,7 @@ public class FTPClient extends FTP implements Configurable {
* </p>
*
* @param reply
- * @return the path, without enclosing quotes, or the full string after
the reply code and space if the syntax is invalid (i.e. enclosing quotes are
+ * @return The path, without enclosing quotes, or the full string after
the reply code and space if the syntax is invalid (i.e. enclosing quotes are
* missing or embedded quotes are not doubled)
*/
// package protected for access by test cases
@@ -923,7 +923,7 @@ public class FTPClient extends FTP implements Configurable {
*
* @param command the command to send
* @param remote the remote file name
- * @return the stream from which to read the file
+ * @return The stream from which to read the file
* @throws IOException on error
* @since 3.1
*/
@@ -996,7 +996,7 @@ public class FTPClient extends FTP implements Configurable {
*
* @param command the command to send
* @param remote the remote file name
- * @return the output stream.
+ * @return The output stream.
* @throws IOException on error
* @since 3.1
*/
@@ -1522,7 +1522,7 @@ public class FTPClient extends FTP implements
Configurable {
* See the class Javadoc section "Control channel keep-alive feature"
* </p>
*
- * @return the number of seconds between keepalive messages.
+ * @return The number of seconds between keepalive messages.
* @since 3.0
* @deprecated Use {@link #getControlKeepAliveTimeoutDuration()}.
*/
@@ -1537,7 +1537,7 @@ public class FTPClient extends FTP implements
Configurable {
* See the class Javadoc section "Control channel keep-alive feature"
* </p>
*
- * @return the duration between keepalive messages.
+ * @return The duration between keepalive messages.
* @since 3.9.0
*/
public Duration getControlKeepAliveTimeoutDuration() {
@@ -1547,7 +1547,7 @@ public class FTPClient extends FTP implements
Configurable {
/**
* Gets the currently active listener.
*
- * @return the listener, may be {@code null}
+ * @return The listener, may be {@code null}
* @since 3.0
*/
public CopyStreamListener getCopyStreamListener() {
@@ -1569,7 +1569,7 @@ public class FTPClient extends FTP implements
Configurable {
* <li>Number of IOErrors ignored</li>
* </ul>
*
- * @return the debug array
+ * @return The debug array
* @deprecated 3.7 For testing only; may be dropped or changed at any time
*/
@Deprecated // only for use in testing
@@ -1623,7 +1623,7 @@ public class FTPClient extends FTP implements
Configurable {
* Gets the adjusted string with "-a" added if necessary.
*
* @param pathName the initial path
- * @return the adjusted string with "-a" added if necessary.
+ * @return The adjusted string with "-a" added if necessary.
* @since 2.0
*/
protected String getListArguments(final String pathName) {
@@ -1808,7 +1808,7 @@ public class FTPClient extends FTP implements
Configurable {
/**
* Gets the system name.
*
- * @return the name
+ * @return The name
* @throws IOException on error
* @deprecated Use {@link #getSystemType()} instead
*/
@@ -2127,7 +2127,7 @@ public class FTPClient extends FTP implements
Configurable {
/**
* Initiate list parsing for MLSD listings in the current working
directory.
*
- * @return the engine
+ * @return The engine
* @throws IOException on error
*/
public FTPListParseEngine initiateMListParsing() throws IOException {
@@ -2138,7 +2138,7 @@ public class FTPClient extends FTP implements
Configurable {
* Initiate list parsing for MLSD listings.
*
* @param path the path from where to MLSD.
- * @return the engine.
+ * @return The engine.
* @throws IOException on error
*/
public FTPListParseEngine initiateMListParsing(final String path) throws
IOException {
@@ -2328,7 +2328,7 @@ public class FTPClient extends FTP implements
Configurable {
*
* @param path the initial path, may be null
* @param filter the filter, non-null
- * @return the array of FTPFile entries.
+ * @return The array of FTPFile entries.
* @throws IOException on error
* @since 2.2
*/
@@ -2575,7 +2575,7 @@ public class FTPClient extends FTP implements
Configurable {
/**
* Generate a directory listing for the current directory using the MLSD
command.
*
- * @return the array of file entries
+ * @return The array of file entries
* @throws IOException on error
* @since 3.0
*/
@@ -2587,7 +2587,7 @@ public class FTPClient extends FTP implements
Configurable {
* Generate a directory listing using the MLSD command.
*
* @param path the directory name, may be {@code null}
- * @return the array of file entries
+ * @return The array of file entries
* @throws IOException on error
* @since 3.0
*/
@@ -2600,7 +2600,7 @@ public class FTPClient extends FTP implements
Configurable {
*
* @param path the directory name, may be {@code null}
* @param filter the filter to apply to the responses
- * @return the array of file entries
+ * @return The array of file entries
* @throws IOException on error
* @since 3.0
*/
@@ -2612,7 +2612,7 @@ public class FTPClient extends FTP implements
Configurable {
* Gets file details using the MLST command
*
* @param path the file or directory to list, may be {@code null}
- * @return the file details, may be {@code null}
+ * @return The file details, may be {@code null}
* @throws IOException on error
* @since 3.0
*/
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPClientConfig.java
b/src/main/java/org/apache/commons/net/ftp/FTPClientConfig.java
index 0358b050..5cebe06d 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPClientConfig.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPClientConfig.java
@@ -402,7 +402,7 @@ public class FTPClientConfig {
/**
* Gets the {@link #setDefaultDateFormatStr(String) defaultDateFormatStr}
property.
*
- * @return the defaultDateFormatStr property.
+ * @return The defaultDateFormatStr property.
*/
public String getDefaultDateFormatStr() {
return defaultDateFormatStr;
@@ -411,7 +411,7 @@ public class FTPClientConfig {
/**
* Gets the {@link #setRecentDateFormatStr(String) recentDateFormatStr}
property.
*
- * @return the recentDateFormatStr property.
+ * @return The recentDateFormatStr property.
*/
public String getRecentDateFormatStr() {
@@ -421,7 +421,7 @@ public class FTPClientConfig {
/**
* Gets the {@link #setServerLanguageCode(String) serverLanguageCode}
property.
*
- * @return the serverLanguageCode property.
+ * @return The serverLanguageCode property.
*/
public String getServerLanguageCode() {
return serverLanguageCode;
@@ -432,7 +432,7 @@ public class FTPClientConfig {
* {@code FTPClientConfig.SYST_*} codes or else the fully qualified class
name of a parser implementing both the {@code FTPFileEntryParser} and
* {@code Configurable} interfaces.
*
- * @return the serverSystemKey property.
+ * @return The serverSystemKey property.
*/
public String getServerSystemKey() {
return serverSystemKey;
@@ -441,7 +441,7 @@ public class FTPClientConfig {
/**
* Gets the {@link #setServerTimeZoneId(String) serverTimeZoneId} property.
*
- * @return the serverTimeZoneId property.
+ * @return The serverTimeZoneId property.
*/
public String getServerTimeZoneId() {
return serverTimeZoneId;
@@ -450,7 +450,7 @@ public class FTPClientConfig {
/**
* Gets the {@link #setShortMonthNames(String) shortMonthNames} property.
*
- * @return the shortMonthNames.
+ * @return The shortMonthNames.
*/
public String getShortMonthNames() {
return shortMonthNames;
@@ -473,7 +473,7 @@ public class FTPClientConfig {
/**
* Tests whether the {@link #setLenientFutureDates(boolean)
lenientFutureDates} property.
*
- * @return the lenientFutureDates (default true).
+ * @return The lenientFutureDates (default true).
* @since 1.5
*/
public boolean isLenientFutureDates() {
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 bd49af4e..4d925d8a 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
@@ -543,7 +543,7 @@ public class FTPSClient extends FTPClient {
*
* @param prefix the prefix to find
* @param reply where to find the prefix
- * @return the remainder of the string after the prefix, or null if the
prefix was not present.
+ * @return The remainder of the string after the prefix, or null if the
prefix was not present.
*/
private String extractPrefixedData(final String prefix, final String
reply) {
final int idx = reply.indexOf(prefix);
@@ -636,7 +636,7 @@ public class FTPSClient extends FTPClient {
/**
* Gets the secure socket protocol to be used, e.g. SSL/TLS.
*
- * @return the protocol
+ * @return The protocol
* @since 3.11.0
*/
protected String getProtocol() {
@@ -913,7 +913,7 @@ public class FTPSClient extends FTPClient {
* Parses the given ADAT response line and base64-decodes the data.
*
* @param reply The ADAT reply to parse.
- * @return the data in the reply, base64-decoded.
+ * @return The data in the reply, base64-decoded.
* @since 3.0
*/
public byte[] parseADATReply(final String reply) {
@@ -929,7 +929,7 @@ public class FTPSClient extends FTPClient {
* @param pbsz Protection Buffer Size.
* @throws SSLException If the server reply code does not equal "200".
* @throws IOException If an I/O error occurs while sending the command.
- * @return the negotiated value.
+ * @return The negotiated value.
* @see #execPBSZ(long)
* @since 3.0
*/
diff --git
a/src/main/java/org/apache/commons/net/ftp/FTPSServerSocketFactory.java
b/src/main/java/org/apache/commons/net/ftp/FTPSServerSocketFactory.java
index 1fc577a4..a9570f86 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPSServerSocketFactory.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPSServerSocketFactory.java
@@ -77,7 +77,7 @@ public class FTPSServerSocketFactory extends
ServerSocketFactory {
* Sets the socket so newly accepted connections will use SSL client mode.
*
* @param socket the SSLServerSocket to initialize
- * @return the socket
+ * @return The socket
* @throws ClassCastException if socket is not an instance of
SSLServerSocket
*/
public ServerSocket init(final ServerSocket socket) {
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPSSocketFactory.java
b/src/main/java/org/apache/commons/net/ftp/FTPSSocketFactory.java
index 7c2a7d87..219996da 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPSSocketFactory.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPSSocketFactory.java
@@ -46,7 +46,7 @@ public class FTPSSocketFactory extends SocketFactory {
/**
* @param port the port
- * @return the socket
+ * @return The socket
* @throws IOException on error
* @deprecated (2.2) use {@link
FTPSServerSocketFactory#createServerSocket(int)}.
*/
@@ -58,7 +58,7 @@ public class FTPSSocketFactory extends SocketFactory {
/**
* @param port the port
* @param backlog the backlog
- * @return the socket
+ * @return The socket
* @throws IOException on error
* @deprecated (2.2) use {@link
FTPSServerSocketFactory#createServerSocket(int, int)}.
*/
@@ -71,7 +71,7 @@ public class FTPSSocketFactory extends SocketFactory {
* @param port the port
* @param backlog the backlog
* @param ifAddress the interface
- * @return the socket
+ * @return The socket
* @throws IOException on error
* @deprecated (2.2) use {@link
FTPSServerSocketFactory#createServerSocket(int, int, InetAddress)}.
*/
@@ -111,7 +111,7 @@ public class FTPSSocketFactory extends SocketFactory {
/**
* @param socket the socket
- * @return the socket
+ * @return The socket
* @throws IOException on error
* @deprecated (2.2) use {@link
FTPSServerSocketFactory#init(java.net.ServerSocket)}
*/
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/ConfigurableFTPFileEntryParserImpl.java
b/src/main/java/org/apache/commons/net/ftp/parser/ConfigurableFTPFileEntryParserImpl.java
index 866883cc..a7fa4e2d 100644
---
a/src/main/java/org/apache/commons/net/ftp/parser/ConfigurableFTPFileEntryParserImpl.java
+++
b/src/main/java/org/apache/commons/net/ftp/parser/ConfigurableFTPFileEntryParserImpl.java
@@ -89,7 +89,7 @@ public abstract class ConfigurableFTPFileEntryParserImpl
extends RegexFTPFileEnt
* Each concrete subclass must define this member to create a default
configuration to be used when that subclass is instantiated without a
* {@link FTPClientConfig FTPClientConfig} parameter being specified.
*
- * @return the default configuration for the subclass.
+ * @return The default configuration for the subclass.
*/
protected abstract FTPClientConfig getDefaultConfiguration();
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 d7456afa..e08506d6 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
@@ -64,7 +64,7 @@ public class DefaultFTPFileEntryParserFactory implements
FTPFileEntryParserFacto
* </p>
*
* @param config A {@link FTPClientConfig FTPClientConfig} used to
configure the parser created
- * @return the {@link FTPFileEntryParser} so created.
+ * @return The {@link FTPFileEntryParser} so created.
* @throws ParserInitializationException Thrown on any exception in
instantiation
* @throws NullPointerException if {@code config} is {@code null}
* @since 1.4
@@ -100,7 +100,7 @@ public class DefaultFTPFileEntryParserFactory implements
FTPFileEntryParserFacto
* <li>{@link FTPClientConfig#SYST_NETWARE NETWARE}</li>
* <li>{@link FTPClientConfig#SYST_L8 TYPE:L8}</li>
* </ul>
- * @return the FTPFileEntryParser corresponding to the supplied key.
+ * @return The FTPFileEntryParser corresponding to the supplied key.
* @throws ParserInitializationException thrown if for any reason the
factory cannot resolve the supplied key into an FTPFileEntryParser.
* @see FTPFileEntryParser
*/
@@ -201,7 +201,7 @@ public class DefaultFTPFileEntryParserFactory implements
FTPFileEntryParserFacto
* otherwise a composite of {@link NTFTPEntryParser} and {@link
UnixFTPEntryParser} is used.
*
* @param config the config to use, may be {@code null}
- * @return the parser
+ * @return The parser
*/
private FTPFileEntryParser createNTFTPEntryParser(final FTPClientConfig
config) {
if (config != null &&
FTPClientConfig.SYST_NT.equals(config.getServerSystemKey())) {
@@ -236,7 +236,7 @@ public class DefaultFTPFileEntryParserFactory implements
FTPFileEntryParserFacto
* is used, otherwise a composite of {@link OS400FTPEntryParser} and
{@link UnixFTPEntryParser} is used.
*
* @param config the config to use, may be {@code null}
- * @return the parser
+ * @return The parser
*/
private FTPFileEntryParser createOS400FTPEntryParser(final FTPClientConfig
config) {
if (config != null &&
FTPClientConfig.SYST_OS400.equals(config.getServerSystemKey())) {
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 cd18437f..39898d0d 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
@@ -38,7 +38,7 @@ public interface FTPFileEntryParserFactory {
* </p>
*
* @param config A {@link FTPClientConfig FTPClientConfig} used to
configure the parser created
- * @return the {@link FTPFileEntryParser} so created.
+ * @return The {@link FTPFileEntryParser} so created.
* @throws ParserInitializationException Thrown on any exception in
instantiation
* @since 1.4
*/
@@ -48,7 +48,7 @@ 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.
+ * @return The FTPFileEntryParser created.
* @throws ParserInitializationException Thrown on any exception in
instantiation
*/
FTPFileEntryParser createFileEntryParser(String key) throws
ParserInitializationException;
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 f56c71ac..cc05c692 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
@@ -179,7 +179,7 @@ public class FTPTimestampParserImpl implements
FTPTimestampParser, Configurable
/**
* Gets the defaultDateFormat.
*
- * @return the defaultDateFormat.
+ * @return The defaultDateFormat.
*/
public SimpleDateFormat getDefaultDateFormat() {
return defaultDateFormat;
@@ -188,7 +188,7 @@ public class FTPTimestampParserImpl implements
FTPTimestampParser, Configurable
/**
* Gets the defaultDateFormat pattern string.
*
- * @return the defaultDateFormat pattern string.
+ * @return The defaultDateFormat pattern string.
*/
public String getDefaultDateFormatString() {
return defaultDateFormat.toPattern();
@@ -197,7 +197,7 @@ public class FTPTimestampParserImpl implements
FTPTimestampParser, Configurable
/**
* Gets the recentDateFormat.
*
- * @return the recentDateFormat.
+ * @return The recentDateFormat.
*/
public SimpleDateFormat getRecentDateFormat() {
return recentDateFormat;
@@ -206,7 +206,7 @@ public class FTPTimestampParserImpl implements
FTPTimestampParser, Configurable
/**
* Gets the recentDateFormat.
*
- * @return the recentDateFormat.
+ * @return The recentDateFormat.
*/
public String getRecentDateFormatString() {
return recentDateFormat.toPattern();
@@ -215,7 +215,7 @@ public class FTPTimestampParserImpl implements
FTPTimestampParser, Configurable
/**
* Gets the serverTimeZone used by this parser.
*
- * @return the serverTimeZone used by this parser.
+ * @return The serverTimeZone used by this parser.
*/
public TimeZone getServerTimeZone() {
return defaultDateFormat.getTimeZone();
@@ -231,7 +231,7 @@ public class FTPTimestampParserImpl implements
FTPTimestampParser, Configurable
}
/**
- * @return the lenientFutureDates.
+ * @return The lenientFutureDates.
*/
boolean isLenientFutureDates() {
return lenientFutureDates;
@@ -264,7 +264,7 @@ public class FTPTimestampParserImpl implements
FTPTimestampParser, Configurable
* @see FTPTimestampParser#parseTimestamp(String)
* @param timestampStr The timestamp to be parsed
* @param serverTime The current time for the server
- * @return the calendar
+ * @return The calendar
* @throws ParseException if timestamp cannot be parsed
* @since 1.5
*/
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/MLSxEntryParser.java
b/src/main/java/org/apache/commons/net/ftp/parser/MLSxEntryParser.java
index 098dfaae..0f836aa8 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/MLSxEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/MLSxEntryParser.java
@@ -82,7 +82,7 @@ public class MLSxEntryParser extends FTPFileEntryParserImpl {
/**
* Gets the singleton instance.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static MLSxEntryParser getInstance() {
return INSTANCE;
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/MacOsPeterFTPEntryParser.java
b/src/main/java/org/apache/commons/net/ftp/parser/MacOsPeterFTPEntryParser.java
index 556dc0d8..e3db876c 100644
---
a/src/main/java/org/apache/commons/net/ftp/parser/MacOsPeterFTPEntryParser.java
+++
b/src/main/java/org/apache/commons/net/ftp/parser/MacOsPeterFTPEntryParser.java
@@ -84,7 +84,7 @@ public class MacOsPeterFTPEntryParser extends
ConfigurableFTPFileEntryParserImpl
/**
* Gets a new default configuration to be used when this class is
instantiated without a {@link FTPClientConfig FTPClientConfig} parameter being
specified.
*
- * @return the default configuration for this parser.
+ * @return The default configuration for this parser.
*/
@Override
protected FTPClientConfig getDefaultConfiguration() {
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/NTFTPEntryParser.java
b/src/main/java/org/apache/commons/net/ftp/parser/NTFTPEntryParser.java
index 08de000e..2bf64a28 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/NTFTPEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/NTFTPEntryParser.java
@@ -75,7 +75,7 @@ public class NTFTPEntryParser extends
ConfigurableFTPFileEntryParserImpl {
/**
* Gets a new default configuration to be used when this class is
instantiated without a {@link FTPClientConfig FTPClientConfig} parameter being
specified.
*
- * @return the default configuration for this parser.
+ * @return The default configuration for this parser.
*/
@Override
public FTPClientConfig getDefaultConfiguration() {
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/NetwareFTPEntryParser.java
b/src/main/java/org/apache/commons/net/ftp/parser/NetwareFTPEntryParser.java
index 08282e6b..ba64c488 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/NetwareFTPEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/NetwareFTPEntryParser.java
@@ -79,7 +79,7 @@ public class NetwareFTPEntryParser extends
ConfigurableFTPFileEntryParserImpl {
/**
* Gets a new default configuration to be used when this class is
instantiated without a {@link FTPClientConfig FTPClientConfig} parameter being
specified.
*
- * @return the default configuration for this parser.
+ * @return The default configuration for this parser.
*/
@Override
protected FTPClientConfig getDefaultConfiguration() {
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 6728a2ca..a4a9640c 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
@@ -65,7 +65,7 @@ public class OS2FTPEntryParser extends
ConfigurableFTPFileEntryParserImpl {
/**
* Gets a new default configuration to be used when this class is
instantiated without a {@link FTPClientConfig FTPClientConfig} parameter being
specified.
*
- * @return the default configuration for this parser.
+ * @return The default configuration for this parser.
*/
@Override
protected FTPClientConfig getDefaultConfiguration() {
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
b/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
index dc19d474..af94be66 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
@@ -292,7 +292,7 @@ public class OS400FTPEntryParser extends
ConfigurableFTPFileEntryParserImpl {
/**
* Gets a new default configuration to be used when this class is
instantiated without a {@link FTPClientConfig FTPClientConfig} parameter being
specified.
*
- * @return the default configuration for this parser.
+ * @return The default configuration for this parser.
*/
@Override
protected FTPClientConfig getDefaultConfiguration() {
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/ParserInitializationException.java
b/src/main/java/org/apache/commons/net/ftp/parser/ParserInitializationException.java
index d50136fc..92b9b926 100644
---
a/src/main/java/org/apache/commons/net/ftp/parser/ParserInitializationException.java
+++
b/src/main/java/org/apache/commons/net/ftp/parser/ParserInitializationException.java
@@ -46,7 +46,7 @@ public class ParserInitializationException extends
RuntimeException {
/**
* Gets the root cause of this exception or null if no root cause was
specified.
*
- * @return the root cause of this exception being thrown
+ * @return The root cause of this exception being thrown
* @deprecated Use {@link #getCause()} instead
*/
@Deprecated
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 32cbcbbd..bfefd62e 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
@@ -95,7 +95,7 @@ public abstract class RegexFTPFileEntryParserImpl extends
FTPFileEntryParserImpl
/**
* Convenience method
*
- * @return the number of groups() in the internal MatchResult.
+ * @return The number of groups() in the internal MatchResult.
*/
public int getGroupCnt() {
if (result == null) {
@@ -124,7 +124,7 @@ 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.
+ * @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) {
if (result == null) {
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java
b/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java
index 059e3260..a3b2a927 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java
@@ -158,7 +158,7 @@ public class UnixFTPEntryParser extends
ConfigurableFTPFileEntryParserImpl {
/**
* Gets a new default configuration to be used when this class is
instantiated without a {@link FTPClientConfig FTPClientConfig} parameter being
specified.
*
- * @return the default configuration for this parser.
+ * @return The default configuration for this parser.
*/
@Override
protected FTPClientConfig getDefaultConfiguration() {
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 fe7f4bfb..8dda4689 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
@@ -80,7 +80,7 @@ public class VMSFTPEntryParser extends
ConfigurableFTPFileEntryParserImpl {
/**
* Gets a new default configuration to be used when this class is
instantiated without a {@link FTPClientConfig FTPClientConfig} parameter being
specified.
*
- * @return the default configuration for this parser.
+ * @return The default configuration for this parser.
*/
@Override
protected FTPClientConfig getDefaultConfiguration() {
@@ -100,7 +100,7 @@ public class VMSFTPEntryParser extends
ConfigurableFTPFileEntryParserImpl {
* DO NOT USE.
*
* @param listStream the stream
- * @return the array of files
+ * @return The array of files
* @throws IOException on error
* @deprecated (2.2) No other FTPFileEntryParser implementations have this
method.
*/
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 c100035a..efc10518 100644
--- a/src/main/java/org/apache/commons/net/imap/IMAP.java
+++ b/src/main/java/org/apache/commons/net/imap/IMAP.java
@@ -100,7 +100,7 @@ public class IMAP extends SocketClient {
* empty string, "" is returned. If it contains a space then it is
enclosed in double quotes, escaping the characters backslash and double-quote.
*
* @param input the value to be quoted, may be null
- * @return the quoted value
+ * @return The quoted value
*/
static String quoteMailboxName(final String input) {
if (input == null) { // Don't throw NPE here
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 9c83a93d..dff67e54 100644
--- a/src/main/java/org/apache/commons/net/imap/IMAPReply.java
+++ b/src/main/java/org/apache/commons/net/imap/IMAPReply.java
@@ -181,7 +181,7 @@ public final class IMAPReply {
* Checks if the line introduces a literal, i.e. ends with {dd}
*
* @param line the line to check
- * @return the literal count, or -1 if there was no literal.
+ * @return The literal count, or -1 if there was no literal.
*/
public static int literalCount(final String line) {
final Matcher m = LITERAL_PATTERN.matcher(line);
diff --git a/src/main/java/org/apache/commons/net/nntp/Article.java
b/src/main/java/org/apache/commons/net/nntp/Article.java
index 2f3689a5..29edc68b 100644
--- a/src/main/java/org/apache/commons/net/nntp/Article.java
+++ b/src/main/java/org/apache/commons/net/nntp/Article.java
@@ -149,7 +149,7 @@ public class Article implements Threadable<Article> {
/**
* Gets the article ID.
*
- * @return the article ID.
+ * @return The article ID.
*/
public String getArticleId() {
return articleId;
@@ -158,7 +158,7 @@ public class Article implements Threadable<Article> {
/**
* Gets the article number.
*
- * @return the article number.
+ * @return The article number.
*/
@Deprecated
public int getArticleNumber() {
@@ -168,7 +168,7 @@ public class Article implements Threadable<Article> {
/**
* Gets the article number.
*
- * @return the article number.
+ * @return The article number.
*/
public long getArticleNumberLong() {
return articleNumber;
@@ -177,7 +177,7 @@ public class Article implements Threadable<Article> {
/**
* Gets the child article.
*
- * @return the child article.
+ * @return The child article.
* @since 3.12.0
*/
public Article getChild() {
@@ -187,7 +187,7 @@ public class Article implements Threadable<Article> {
/**
* Gets the article date header.
*
- * @return the article date header.
+ * @return The article date header.
*/
public String getDate() {
return date;
@@ -196,7 +196,7 @@ public class Article implements Threadable<Article> {
/**
* Gets the article from header.
*
- * @return the article from header.
+ * @return The article from header.
*/
public String getFrom() {
return from;
@@ -205,7 +205,7 @@ public class Article implements Threadable<Article> {
/**
* Gets the next article.
*
- * @return the next article.
+ * @return The next article.
* @since 3.12.0
*/
public Article getNext() {
@@ -227,7 +227,7 @@ public class Article implements Threadable<Article> {
/**
* Gets the article subject.
*
- * @return the article subject.
+ * @return The article subject.
*/
public String getSubject() {
return subject;
diff --git a/src/main/java/org/apache/commons/net/nntp/ArticleIterator.java
b/src/main/java/org/apache/commons/net/nntp/ArticleIterator.java
index 11d2e6ed..d822f4e3 100644
--- a/src/main/java/org/apache/commons/net/nntp/ArticleIterator.java
+++ b/src/main/java/org/apache/commons/net/nntp/ArticleIterator.java
@@ -45,7 +45,7 @@ final class ArticleIterator implements Iterator<Article>,
Iterable<Article> {
/**
* Gets the next Article
*
- * @return the next {@link Article}, never {@code null}, if unparseable
then isDummy() will be true, and the subject will contain the raw info.
+ * @return The next {@link Article}, never {@code null}, if unparseable
then isDummy() will be true, and the subject will contain the raw info.
*/
@Override
public Article next() {
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 7130df02..aad7bad2 100644
--- a/src/main/java/org/apache/commons/net/nntp/NNTP.java
+++ b/src/main/java/org/apache/commons/net/nntp/NNTP.java
@@ -463,7 +463,7 @@ public class NNTP extends SocketClient {
* A convenience wrapper for the extended LIST command that takes an
argument, allowing us to selectively list multiple groups.
*
* @param wildmat A wildmat (pseudo-regex) pattern. See RFC 2980 for
details.
- * @return the reply code received from the server.
+ * @return The reply code received from the server.
* @throws IOException if the command fails
*/
public int listActive(final String wildmat) throws IOException {
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 a224fbdd..edb3adde 100644
--- a/src/main/java/org/apache/commons/net/nntp/NNTPClient.java
+++ b/src/main/java/org/apache/commons/net/nntp/NNTPClient.java
@@ -66,7 +66,7 @@ public class NNTPClient extends NNTP {
* Parse a response line from {@link #retrieveArticleInfo(long, long)}.
*
* @param line a response line
- * @return the parsed {@link Article}, if unparseable then isDummy() will
be true, and the subject will contain the raw info.
+ * @return The parsed {@link Article}, if unparseable then isDummy() will
be true, and the subject will contain the raw info.
* @since 3.0
*/
static Article parseArticleEntry(final String line) {
@@ -504,7 +504,7 @@ public class NNTPClient extends NNTP {
/**
* Send a "LIST OVERVIEW.FMT" command to the server.
*
- * @return the contents of the Overview format, of {@code null} if the
command failed
+ * @return The contents of the Overview format, of {@code null} if the
command failed
* @throws IOException on error
*/
public String[] listOverviewFmt() throws IOException {
@@ -802,7 +802,7 @@ public class NNTPClient extends NNTP {
* Same as {@code retrieveArticleBody(articleNumber, null)}
*
* @param articleNumber the article number
- * @return the reader
+ * @return The reader
* @throws IOException if an error occurs
*/
public BufferedReader retrieveArticleBody(final long articleNumber) throws
IOException {
@@ -896,7 +896,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
+ * @return The reader
* @throws IOException if an error occurs
*/
public Reader retrieveArticleHeader() throws IOException {
@@ -933,7 +933,7 @@ public class NNTPClient extends NNTP {
* Same as {@code retrieveArticleHeader(articleNumber, null)}
*
* @param articleNumber the article number
- * @return the reader
+ * @return The reader
* @throws IOException if an error occurs
*/
public BufferedReader retrieveArticleHeader(final long articleNumber)
throws IOException {
@@ -972,7 +972,7 @@ public class NNTPClient extends NNTP {
* Same as {@code retrieveArticleHeader(articleId, (ArticleInfo) null)}
Note: the return can be cast to a {@link BufferedReader}
*
* @param articleId the article id to fetch
- * @return the reader
+ * @return The reader
* @throws IOException if an error occurs
*/
public Reader retrieveArticleHeader(final String articleId) throws
IOException {
diff --git a/src/main/java/org/apache/commons/net/nntp/Threadable.java
b/src/main/java/org/apache/commons/net/nntp/Threadable.java
index 55197559..7be3076e 100644
--- a/src/main/java/org/apache/commons/net/nntp/Threadable.java
+++ b/src/main/java/org/apache/commons/net/nntp/Threadable.java
@@ -69,7 +69,7 @@ public interface Threadable<T extends Threadable<T>> {
/**
* Gets the simplified subject.
*
- * @return the simplified subject.
+ * @return The simplified subject.
*/
String simplifiedSubject();
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 14b79a8f..2a20f75e 100644
--- a/src/main/java/org/apache/commons/net/ntp/NTPUDPClient.java
+++ b/src/main/java/org/apache/commons/net/ntp/NTPUDPClient.java
@@ -110,7 +110,7 @@ public final class NTPUDPClient extends
DatagramSocketClient {
/**
* Gets the NTP protocol version number that client sets on request packet
that is sent to remote host (e.g. 3=NTP v3, 4=NTP v4, etc.)
*
- * @return the NTP protocol version number that client sets on request
packet.
+ * @return The NTP protocol version number that client sets on request
packet.
* @see #setVersion(int)
*/
public int getVersion() {
diff --git a/src/main/java/org/apache/commons/net/ntp/NtpUtils.java
b/src/main/java/org/apache/commons/net/ntp/NtpUtils.java
index 069748e9..17c9d7b2 100644
--- a/src/main/java/org/apache/commons/net/ntp/NtpUtils.java
+++ b/src/main/java/org/apache/commons/net/ntp/NtpUtils.java
@@ -26,7 +26,7 @@ public final class NtpUtils {
* Gets the 32-bit integer address to IPv4 address string "%d.%d.%d.%d"
format.
*
* @param address the 32-bit address
- * @return the raw IP address in a string format.
+ * @return The raw IP address in a string format.
*/
public static String getHostAddress(final int address) {
return (address >>> 24 & 0xFF) + "." + (address >>> 16 & 0xFF) + "." +
(address >>> 8 & 0xFF) + "." + (address >>> 0 & 0xFF);
@@ -65,7 +65,7 @@ public final class NtpUtils {
* Gets the NTP packet reference identifier as IP address.
*
* @param packet NTP packet
- * @return the packet reference id (as IP address) in "%d.%d.%d.%d" format.
+ * @return The packet reference id (as IP address) in "%d.%d.%d.%d" format.
*/
public static String getRefAddress(final NtpV3Packet packet) {
final int address = packet == null ? 0 : packet.getReferenceId();
diff --git a/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
b/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
index 57a66608..ab1205c6 100644
--- a/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
+++ b/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
@@ -165,7 +165,7 @@ public class NtpV3Impl implements NtpV3Packet {
/**
* Gets the {@code originate} time as defined in RFC-1305.
*
- * @return the {@code originate} time. Never returns null.
+ * @return The {@code originate} time. Never returns null.
*/
@Override
public TimeStamp getOriginateTimeStamp() {
@@ -197,7 +197,7 @@ public class NtpV3Impl implements NtpV3Packet {
/**
* Gets the {@code receive} timestamp as defined in RFC-1305.
*
- * @return the {@code receive} time. Never returns null.
+ * @return The {@code receive} time. Never returns null.
*/
@Override
public TimeStamp getReceiveTimeStamp() {
@@ -207,7 +207,7 @@ public class NtpV3Impl implements NtpV3Packet {
/**
* Gets the reference id as defined in RFC-1305, which is a 32-bit integer
whose value is dependent on several criteria.
*
- * @return the reference id as defined in RFC-1305.
+ * @return The reference id as defined in RFC-1305.
*/
@Override
public int getReferenceId() {
@@ -218,7 +218,7 @@ public class NtpV3Impl implements NtpV3Packet {
* Gets the reference id string. String cannot be null but value is
dependent on the version of the NTP spec supported and stratum level. Value can
be an
* empty string, clock type string, IP address, or a hexadecimal string.
*
- * @return the reference id string.
+ * @return The reference id string.
*/
@Override
public String getReferenceIdString() {
@@ -245,7 +245,7 @@ public class NtpV3Impl implements NtpV3Packet {
/**
* Gets the reference time as defined in RFC-1305.
*
- * @return the reference time as {@code TimeStamp} object. Never returns
null.
+ * @return The reference time as {@code TimeStamp} object. Never returns
null.
*/
@Override
public TimeStamp getReferenceTimeStamp() {
@@ -331,7 +331,7 @@ public class NtpV3Impl implements NtpV3Packet {
/**
* Gets the {@code transmit} timestamp as defined in RFC-1305.
*
- * @return the {@code transmit} timestamp as defined in RFC-1305. Never
returns a null object.
+ * @return The {@code transmit} timestamp as defined in RFC-1305. Never
returns a null object.
*/
@Override
public TimeStamp getTransmitTimeStamp() {
diff --git a/src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java
b/src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java
index b1560dda..40fe5877 100644
--- a/src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java
+++ b/src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java
@@ -136,77 +136,77 @@ public interface NtpV3Packet {
/**
* Gets the leap indicator as defined in RFC-1305.
*
- * @return the leap indicator as defined in RFC-1305.
+ * @return The leap indicator as defined in RFC-1305.
*/
int getLeapIndicator();
/**
* Gets the mode as defined in RFC-1305.
*
- * @return the mode as defined in RFC-1305.
+ * @return The mode as defined in RFC-1305.
*/
int getMode();
/**
* Gets the mode as human readable string; for example, 3=Client.
*
- * @return the mode as human readable string; for example, 3=Client.
+ * @return The mode as human readable string; for example, 3=Client.
*/
String getModeName();
/**
* Gets the {@code originate} time as defined in RFC-1305.
*
- * @return the {@code originate} time as defined in RFC-1305.
+ * @return The {@code originate} time as defined in RFC-1305.
*/
TimeStamp getOriginateTimeStamp();
/**
* Gets the poll interval as defined in RFC-1305. Field range between
NTP_MINPOLL and NTP_MAXPOLL.
*
- * @return the poll interval as defined in RFC-1305. Field range between
NTP_MINPOLL and NTP_MAXPOLL.
+ * @return The poll interval as defined in RFC-1305. Field range between
NTP_MINPOLL and NTP_MAXPOLL.
*/
int getPoll();
/**
* Gets the precision as defined in RFC-1305.
*
- * @return the precision as defined in RFC-1305.
+ * @return The precision as defined in RFC-1305.
*/
int getPrecision();
/**
* Gets the {@code receive} time as defined in RFC-1305.
*
- * @return the {@code receive} time as defined in RFC-1305.
+ * @return The {@code receive} time as defined in RFC-1305.
*/
TimeStamp getReceiveTimeStamp();
/**
* Gets the reference id (32-bit code) as defined in RFC-1305.
*
- * @return the reference id (32-bit code) as defined in RFC-1305.
+ * @return The reference id (32-bit code) as defined in RFC-1305.
*/
int getReferenceId();
/**
* Gets the reference ID string.
*
- * @return the reference ID string.
+ * @return The reference ID string.
*/
String getReferenceIdString();
/**
* Gets the reference time as defined in RFC-1305.
*
- * @return the reference time as defined in RFC-1305.
+ * @return The reference time as defined in RFC-1305.
*/
TimeStamp getReferenceTimeStamp();
/**
* Gets the root delay as defined in RFC-1305.
*
- * @return the root delay as defined in RFC-1305.
+ * @return The root delay as defined in RFC-1305.
*/
int getRootDelay();
@@ -220,35 +220,35 @@ public interface NtpV3Packet {
/**
* Gets the root dispersion as defined in RFC-1305.
*
- * @return the root dispersion as defined in RFC-1305.
+ * @return The root dispersion as defined in RFC-1305.
*/
int getRootDispersion();
/**
* Gets the root dispersion in milliseconds.
*
- * @return the root dispersion in milliseconds.
+ * @return The root dispersion in milliseconds.
*/
long getRootDispersionInMillis();
/**
* Gets the root dispersion in milliseconds.
*
- * @return the root dispersion in milliseconds.
+ * @return The root dispersion in milliseconds.
*/
double getRootDispersionInMillisDouble();
/**
* Gets the stratum as defined in RFC-1305.
*
- * @return the stratum as defined in RFC-1305.
+ * @return The stratum as defined in RFC-1305.
*/
int getStratum();
/**
* Gets the {@code transmit} timestamp as defined in RFC-1305.
*
- * @return the {@code transmit} timestamp as defined in RFC-1305.
+ * @return The {@code transmit} timestamp as defined in RFC-1305.
*/
TimeStamp getTransmitTimeStamp();
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 af752078..4f3a9771 100644
--- a/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
+++ b/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
@@ -129,7 +129,7 @@ public class TimeStamp implements Serializable,
Comparable<TimeStamp> {
* equivalent are all values ranging from c1a9ae1c.cf5c28f5 to
c1a9ae1c.cf9db22c.
*
* @param ntpTimeValue the input time
- * @return the number of milliseconds since January 1, 1970, 00:00:00 GMT
represented by this NTP timestamp value.
+ * @return The number of milliseconds since January 1, 1970, 00:00:00 GMT
represented by this NTP timestamp value.
*/
public static long getTime(final long ntpTimeValue) {
final long seconds = ntpTimeValue >>> 32 & 0xffffffffL; // high-order
32-bits
@@ -157,7 +157,7 @@ public class TimeStamp implements Serializable,
Comparable<TimeStamp> {
* Parses the string argument as a NTP hexidecimal timestamp
representation string (e.g. "c1a089bd.fc904f6d").
*
* @param s hexstring.
- * @return the Timestamp represented by the argument in hexidecimal.
+ * @return The Timestamp represented by the argument in hexidecimal.
* @throws NumberFormatException - if the string does not contain a
parsable timestamp.
*/
public static TimeStamp parseNtpString(final String s) throws
NumberFormatException {
@@ -257,7 +257,7 @@ public class TimeStamp implements Serializable,
Comparable<TimeStamp> {
* Compares two Timestamps numerically.
*
* @param anotherTimeStamp the {@code TimeStamp} to be compared.
- * @return the value {@code 0} if the argument TimeStamp is equal to this
TimeStamp; a value less than {@code 0} if this TimeStamp is numerically
+ * @return The value {@code 0} if the argument TimeStamp is equal to this
TimeStamp; a value less than {@code 0} if this TimeStamp is numerically
* less than the TimeStamp argument; and a value greater than
{@code 0} if this TimeStamp is numerically greater than the TimeStamp argument
* (signed comparison).
*/
@@ -313,7 +313,7 @@ public class TimeStamp implements Serializable,
Comparable<TimeStamp> {
/**
* Gets a Java standard time in milliseconds from the NTP timestamp.
*
- * @return the number of milliseconds since January 1, 1970, 00:00:00 GMT
represented by this NTP timestamp value.
+ * @return The number of milliseconds since January 1, 1970, 00:00:00 GMT
represented by this NTP timestamp value.
*/
public long getTime() {
return getTime(ntpTime);
@@ -341,7 +341,7 @@ public class TimeStamp implements Serializable,
Comparable<TimeStamp> {
/**
* Returns the value of this Timestamp as a long value.
*
- * @return the 64-bit long value represented by this object.
+ * @return The 64-bit long value represented by this object.
*/
public long ntpValue() {
return ntpTime;
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 9c85ea5c..f6900ddf 100644
--- a/src/main/java/org/apache/commons/net/smtp/SMTP.java
+++ b/src/main/java/org/apache/commons/net/smtp/SMTP.java
@@ -469,7 +469,7 @@ public class SMTP extends SocketClient {
* @param command the command to send (as an int defined in {@link
SMTPCommand})
* @param args the command arguments, may be {@code null}
* @param includeSpace if {@code true}, add a space between the command
and its arguments
- * @return the reply code
+ * @return The reply code
* @throws IOException
*/
private int sendCommand(final int command, final String args, final
boolean includeSpace) throws IOException {
@@ -513,7 +513,7 @@ public class SMTP extends SocketClient {
* @param command the command to send (as a plain String)
* @param args the command arguments, may be {@code null}
* @param includeSpace if {@code true}, add a space between the command
and its arguments
- * @return the reply code
+ * @return The reply code
* @throws IOException
*/
private int sendCommand(final String command, final String args, final
boolean includeSpace) throws IOException {
diff --git
a/src/main/java/org/apache/commons/net/telnet/InvalidTelnetOptionException.java
b/src/main/java/org/apache/commons/net/telnet/InvalidTelnetOptionException.java
index 38be0123..522640f9 100644
---
a/src/main/java/org/apache/commons/net/telnet/InvalidTelnetOptionException.java
+++
b/src/main/java/org/apache/commons/net/telnet/InvalidTelnetOptionException.java
@@ -49,7 +49,7 @@ public class InvalidTelnetOptionException extends Exception {
/**
* Gets the error message of the exception.
*
- * @return the error message.
+ * @return The error message.
*/
@Override
public String getMessage() {
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 5953d810..a89a5eb3 100644
--- a/src/main/java/org/apache/commons/net/telnet/TelnetInputStream.java
+++ b/src/main/java/org/apache/commons/net/telnet/TelnetInputStream.java
@@ -279,7 +279,7 @@ final class TelnetInputStream extends BufferedInputStream
implements Runnable {
* Gets the next byte of data. IAC commands are processed internally and
do not return data.
*
* @param mayBlock true if method is allowed to block
- * @return the next byte of data, or -1 (EOF) if end of stread reached, or
-2 (WOULD_BLOCK) if mayBlock is false and there is no data available
+ * @return The next byte of data, or -1 (EOF) if end of stread reached, or
-2 (WOULD_BLOCK) if mayBlock is false and there is no data available
*/
private int read(final boolean mayBlock) throws IOException {
int ch;
diff --git a/src/main/java/org/apache/commons/net/time/TimeUDPClient.java
b/src/main/java/org/apache/commons/net/time/TimeUDPClient.java
index 3c0af9f3..8b0ec48f 100644
--- a/src/main/java/org/apache/commons/net/time/TimeUDPClient.java
+++ b/src/main/java/org/apache/commons/net/time/TimeUDPClient.java
@@ -64,7 +64,7 @@ public final class TimeUDPClient extends DatagramSocketClient
{
* Gets the time from a server and returns a Java Date containing the time
converted to the local time zone.
*
* @param host the time-server
- * @return the date
+ * @return The date
* @throws IOException on error
*/
public Date getDate(final InetAddress host) throws IOException {
@@ -87,7 +87,7 @@ public final class TimeUDPClient extends DatagramSocketClient
{
* Gets the time from the specified server and default port.
*
* @param host the time-server
- * @return the time returned from the server
+ * @return The time returned from the server
* @throws IOException on error
*/
public long getTime(final InetAddress host) throws IOException {
diff --git a/src/main/java/org/apache/commons/net/util/KeyManagerUtils.java
b/src/main/java/org/apache/commons/net/util/KeyManagerUtils.java
index be8efcf8..48e9e18b 100644
--- a/src/main/java/org/apache/commons/net/util/KeyManagerUtils.java
+++ b/src/main/java/org/apache/commons/net/util/KeyManagerUtils.java
@@ -146,7 +146,7 @@ public final class KeyManagerUtils {
*
* @param storePath the path to the keyStore
* @param storePass the keyStore password
- * @return the customized KeyManager
+ * @return The customized KeyManager
* @throws IOException if there is a problem creating the
keystore
* @throws GeneralSecurityException if there is a problem creating the
keystore
*/
@@ -161,7 +161,7 @@ public final class KeyManagerUtils {
* @param storePath the path to the keyStore
* @param storePass the keyStore password
* @param keyAlias the alias of the key to use, may be {@code null} in
which case the first key entry alias is used
- * @return the customized KeyManager
+ * @return The customized KeyManager
* @throws IOException if there is a problem creating the
keystore
* @throws GeneralSecurityException if there is a problem creating the
keystore
*/
@@ -176,7 +176,7 @@ public final class KeyManagerUtils {
* @param ks the keystore to use
* @param keyAlias the alias of the key to use, may be {@code null} in
which case the first key entry alias is used
* @param keyPass the password of the key to use
- * @return the customized KeyManager
+ * @return The customized KeyManager
* @throws GeneralSecurityException if there is a problem creating the
keystore
*/
public static KeyManager createClientKeyManager(final KeyStore ks, final
String keyAlias, final String keyPass) throws GeneralSecurityException {
@@ -192,7 +192,7 @@ public final class KeyManagerUtils {
* @param storePass the keyStore password
* @param keyAlias the alias of the key to use, may be {@code null} in
which case the first key entry alias is used
* @param keyPass the password of the key to use
- * @return the customized KeyManager
+ * @return The customized KeyManager
* @throws GeneralSecurityException if there is a problem creating the
keystore
* @throws IOException if there is a problem creating the
keystore
*/
diff --git a/src/main/java/org/apache/commons/net/util/ListenerList.java
b/src/main/java/org/apache/commons/net/util/ListenerList.java
index 2ab2aa70..99e710c5 100644
--- a/src/main/java/org/apache/commons/net/util/ListenerList.java
+++ b/src/main/java/org/apache/commons/net/util/ListenerList.java
@@ -59,7 +59,7 @@ public class ListenerList<T extends EventListener> implements
Serializable, Iter
/**
* Gets the number of elements in this list.
*
- * @return the number of elements in this list
+ * @return The number of elements in this list
*/
public int getListenerCount() {
return listeners.size();
diff --git a/src/main/java/org/apache/commons/net/util/SSLContextUtils.java
b/src/main/java/org/apache/commons/net/util/SSLContextUtils.java
index 72eae621..0bbfeb90 100644
--- a/src/main/java/org/apache/commons/net/util/SSLContextUtils.java
+++ b/src/main/java/org/apache/commons/net/util/SSLContextUtils.java
@@ -37,7 +37,7 @@ public class SSLContextUtils {
* @param protocol the protocol used to instantiate the context
* @param keyManager the key manager, may be {@code null}
* @param trustManager the trust manager, may be {@code null}
- * @return the initialized context.
+ * @return The initialized context.
* @throws IOException this is used to wrap any {@link
GeneralSecurityException} that occurs
*/
public static SSLContext createSSLContext(final String protocol, final
KeyManager keyManager, final TrustManager trustManager) throws IOException {
@@ -51,7 +51,7 @@ public class SSLContextUtils {
* @param protocol the protocol used to instantiate the context
* @param keyManagers the array of key managers, may be {@code null} but
array entries must not be {@code null}
* @param trustManagers the array of trust managers, may be {@code null}
but array entries must not be {@code null}
- * @return the initialized context.
+ * @return The initialized context.
* @throws IOException this is used to wrap any {@link
GeneralSecurityException} that occurs
*/
public static SSLContext createSSLContext(final String protocol, final
KeyManager[] keyManagers, final TrustManager[] trustManagers) throws
IOException {
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 f3266fb3..4c244b22 100644
--- a/src/main/java/org/apache/commons/net/util/SubnetUtils.java
+++ b/src/main/java/org/apache/commons/net/util/SubnetUtils.java
@@ -120,7 +120,7 @@ public class SubnetUtils {
/**
* Gets the count of available addresses. Will be zero for CIDR/31 and
CIDR/32 if the inclusive flag is false.
*
- * @return the count of addresses, may be zero.
+ * @return The count of addresses, may be zero.
* @throws RuntimeException if the correct count is greater than
{@code Integer.MAX_VALUE}
* @deprecated (3.4) use {@link #getAddressCountLong()} instead
*/
@@ -137,7 +137,7 @@ public class SubnetUtils {
/**
* Gets the count of available addresses. Will be zero for CIDR/31 and
CIDR/32 if the inclusive flag is false.
*
- * @return the count of addresses, may be zero.
+ * @return The count of addresses, may be zero.
* @since 3.4
*/
public long getAddressCountLong() {
@@ -173,7 +173,7 @@ public class SubnetUtils {
/**
* Gets the broadcast address for this subnet.
*
- * @return the broadcast address for this subnet.
+ * @return The broadcast address for this subnet.
*/
public String getBroadcastAddress() {
return format(toArray4(broadcast));
@@ -182,7 +182,7 @@ public class SubnetUtils {
/**
* Gets the CIDR signature for this subnet.
*
- * @return the CIDR signature for this subnet.
+ * @return The CIDR signature for this subnet.
*/
public String getCidrSignature() {
return format(toArray4(address)) + "/" + Integer.bitCount(netmask);
@@ -191,7 +191,7 @@ public class SubnetUtils {
/**
* Gets the high address as a dotted IP address. Will be zero for
CIDR/31 and CIDR/32 if the inclusive flag is false.
*
- * @return the IP address in dotted format, may be "0.0.0.0" if there
is no valid address
+ * @return The IP address in dotted format, may be "0.0.0.0" if there
is no valid address
*/
public String getHighAddress() {
return format(toArray4(high()));
@@ -200,7 +200,7 @@ public class SubnetUtils {
/**
* Gets the low address as a dotted IP address. Will be zero for
CIDR/31 and CIDR/32 if the inclusive flag is false.
*
- * @return the IP address in dotted format, may be "0.0.0.0" if there
is no valid address
+ * @return The IP address in dotted format, may be "0.0.0.0" if there
is no valid address
*/
public String getLowAddress() {
return format(toArray4(low()));
@@ -209,7 +209,7 @@ public class SubnetUtils {
/**
* Gets the network mask for this subnet.
*
- * @return the network mask for this subnet.
+ * @return The network mask for this subnet.
*/
public String getNetmask() {
return format(toArray4(netmask));
@@ -218,7 +218,7 @@ public class SubnetUtils {
/**
* Gets the network address for this subnet.
*
- * @return the network address for this subnet.
+ * @return The network address for this subnet.
*/
public String getNetworkAddress() {
return format(toArray4(network));
@@ -227,7 +227,7 @@ public class SubnetUtils {
/**
* Gets the next address for this subnet.
*
- * @return the next address for this subnet.
+ * @return The next address for this subnet.
*/
public String getNextAddress() {
return format(toArray4(address + 1));
@@ -236,7 +236,7 @@ public class SubnetUtils {
/**
* Gets the previous address for this subnet.
*
- * @return the previous address for this subnet.
+ * @return The previous address for this subnet.
*/
public String getPreviousAddress() {
return format(toArray4(address - 1));
@@ -478,7 +478,7 @@ public class SubnetUtils {
/**
* Gets the next subnet for this instance.
*
- * @return the next subnet for this instance.
+ * @return The next subnet for this instance.
*/
public SubnetUtils getNext() {
return new SubnetUtils(getInfo().getNextAddress(),
getInfo().getNetmask());
@@ -487,7 +487,7 @@ public class SubnetUtils {
/**
* Gets the previous subnet for this instance.
*
- * @return the next previous for this instance.
+ * @return The next previous for this instance.
*/
public SubnetUtils getPrevious() {
return new SubnetUtils(getInfo().getPreviousAddress(),
getInfo().getNetmask());
diff --git a/src/main/java/org/apache/commons/net/util/SubnetUtils6.java
b/src/main/java/org/apache/commons/net/util/SubnetUtils6.java
index 6a66f126..0669f6ad 100644
--- a/src/main/java/org/apache/commons/net/util/SubnetUtils6.java
+++ b/src/main/java/org/apache/commons/net/util/SubnetUtils6.java
@@ -45,7 +45,7 @@ public class SubnetUtils6 {
/**
* Gets the address used to initialize this subnet.
*
- * @return the address as a string in standard IPv6 format.
+ * @return The address as a string in standard IPv6 format.
*/
public String getAddress() {
return format(address);
@@ -57,7 +57,7 @@ public class SubnetUtils6 {
* For IPv6, this can be astronomically large. A /64 subnet has 2^64
addresses.
* </p>
*
- * @return the count of addresses as a BigInteger.
+ * @return The count of addresses as a BigInteger.
*/
public BigInteger getAddressCount() {
// 2^(128 - prefixLength)
@@ -67,7 +67,7 @@ public class SubnetUtils6 {
/**
* Gets the CIDR notation for this subnet.
*
- * @return the CIDR signature (e.g., "2001:db8::1/64").
+ * @return The CIDR signature (e.g., "2001:db8::1/64").
*/
public String getCidrSignature() {
return format(address) + "/" + prefixLength;
@@ -76,7 +76,7 @@ public class SubnetUtils6 {
/**
* Gets the highest address in this subnet.
*
- * @return the high address as a string in standard IPv6 format.
+ * @return The high address as a string in standard IPv6 format.
*/
public String getHighAddress() {
return format(high);
@@ -85,7 +85,7 @@ public class SubnetUtils6 {
/**
* Gets the lowest address in this subnet (the network address).
*
- * @return the low address as a string in standard IPv6 format.
+ * @return The low address as a string in standard IPv6 format.
*/
public String getLowAddress() {
return format(network);
@@ -94,7 +94,7 @@ public class SubnetUtils6 {
/**
* Gets the network address for this subnet.
*
- * @return the network address as a string in standard IPv6 format.
+ * @return The network address as a string in standard IPv6 format.
*/
public String getNetworkAddress() {
return format(network);
@@ -103,7 +103,7 @@ public class SubnetUtils6 {
/**
* Gets the prefix length for this subnet.
*
- * @return the prefix length (0-128).
+ * @return The prefix length (0-128).
*/
public int getPrefixLength() {
return prefixLength;
@@ -185,7 +185,7 @@ public class SubnetUtils6 {
* Formats a BigInteger as an IPv6 address string using {@link
InetAddress#getHostAddress()}.
*
* @param addr the address as a BigInteger.
- * @return the formatted IPv6 address string.
+ * @return The formatted IPv6 address string.
* @see <a href="https://datatracker.ietf.org/doc/html/rfc5952";>RFC
5952</a>
*/
private static String format(final BigInteger addr) {
@@ -224,7 +224,7 @@ public class SubnetUtils6 {
* Parses an IPv6 address string to a byte array.
*
* @param address the IPv6 address string.
- * @return the 16-byte representation.
+ * @return The 16-byte representation.
* @throws IllegalArgumentException if the address cannot be parsed.
*/
private static byte[] toBytes(final String address) {
diff --git a/src/main/java/org/apache/commons/net/util/TrustManagerUtils.java
b/src/main/java/org/apache/commons/net/util/TrustManagerUtils.java
index e54a2c09..4a20b5d3 100644
--- a/src/main/java/org/apache/commons/net/util/TrustManagerUtils.java
+++ b/src/main/java/org/apache/commons/net/util/TrustManagerUtils.java
@@ -73,7 +73,7 @@ public final class TrustManagerUtils {
/**
* Generate a TrustManager that performs no checks.
*
- * @return the TrustManager
+ * @return The TrustManager
*/
public static X509TrustManager getAcceptAllTrustManager() {
return ACCEPT_ALL;
@@ -88,7 +88,7 @@ public final class TrustManagerUtils {
* </p>
*
* @param keyStore the KeyStore to use, may be {@code null}
- * @return the default TrustManager
+ * @return The default TrustManager
* @throws GeneralSecurityException if an error occurs
*/
public static X509TrustManager getDefaultTrustManager(final KeyStore
keyStore) throws GeneralSecurityException {
@@ -101,7 +101,7 @@ public final class TrustManagerUtils {
/**
* Generate a TrustManager that checks server certificates for validity,
but otherwise performs no checks.
*
- * @return the validating TrustManager
+ * @return The validating TrustManager
*/
public static X509TrustManager getValidateServerCertificateTrustManager() {
return CHECK_SERVER_VALIDITY;
diff --git a/src/test/java/org/apache/commons/net/MockTcpServer.java
b/src/test/java/org/apache/commons/net/MockTcpServer.java
index 63d6f5f6..8922284a 100644
--- a/src/test/java/org/apache/commons/net/MockTcpServer.java
+++ b/src/test/java/org/apache/commons/net/MockTcpServer.java
@@ -112,7 +112,7 @@ public abstract class MockTcpServer implements Runnable,
Closeable {
/**
* Gets the port number on which {@link #serverSocket} is listening
*
- * @return the port number to which this socket is listening or -1
+ * @return The port number to which this socket is listening or -1
* if the socket is not bound yet
*/
public int getPort() {
diff --git
a/src/test/java/org/apache/commons/net/daytime/DaytimeTCPClientTest.java
b/src/test/java/org/apache/commons/net/daytime/DaytimeTCPClientTest.java
index e0cb192a..a642c141 100644
--- a/src/test/java/org/apache/commons/net/daytime/DaytimeTCPClientTest.java
+++ b/src/test/java/org/apache/commons/net/daytime/DaytimeTCPClientTest.java
@@ -67,7 +67,7 @@ class DaytimeTCPClientTest {
* In order for this test to pass inside some VPNs, you cannot use the
plain old {@link InetAddress#getLocalHost()}.
* </p>
*
- * @return the InetAddress to use as the localhost.
+ * @return The InetAddress to use as the localhost.
*/
private static InetAddress getLocalHostInetAddress() {
return InetAddress.getLoopbackAddress();
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 bc60212a..4b48b9cf 100644
--- a/src/test/java/org/apache/commons/net/daytime/MockDaytimeTCPServer.java
+++ b/src/test/java/org/apache/commons/net/daytime/MockDaytimeTCPServer.java
@@ -92,7 +92,7 @@ public final class MockDaytimeTCPServer extends MockTcpServer
{
* to return Daytime data, as defined in <a
href="https://datatracker.ietf.org/doc/html/rfc867";>RFC 867</a> spec
*
* @param clock that will be used
- * @return the queued {@code clock}
+ * @return The queued {@code clock}
*/
public Clock enqueue(final Clock clock) {
responseQueue.add(clock);
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 896cc31a..ed1112bc 100644
--- a/src/test/java/org/apache/commons/net/ftp/AbstractFtpsTest.java
+++ b/src/test/java/org/apache/commons/net/ftp/AbstractFtpsTest.java
@@ -68,7 +68,7 @@ public abstract class AbstractFtpsTest {
/**
* Returns the test directory as a String.
* @param defaultHome A default value.
- * @return the test directory as a String
+ * @return The test directory as a String
*/
protected static String getTestHomeDirectory(final String defaultHome) {
return System.getProperty("test.basedir", defaultHome);
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 6e8efdad..d6b58aa3 100644
--- a/src/test/java/org/apache/commons/net/tftp/TFTPServer.java
+++ b/src/test/java/org/apache/commons/net/tftp/TFTPServer.java
@@ -606,7 +606,7 @@ public class TFTPServer implements Runnable, AutoCloseable {
/**
* Gets the current value for maxTimeoutRetries
*
- * @return the max allowed number of retries
+ * @return The max allowed number of retries
*/
public int getMaxTimeoutRetries() {
return maxTimeoutRetries;
@@ -615,7 +615,7 @@ public class TFTPServer implements Runnable, AutoCloseable {
/**
* Gets the server port number
*
- * @return the server port number
+ * @return The server port number
*/
public int getPort() {
return port;
@@ -624,7 +624,7 @@ public class TFTPServer implements Runnable, AutoCloseable {
/**
* Gets the current socket timeout used during transfers in milliseconds.
*
- * @return the timeout value
+ * @return The timeout value
*/
public int getSocketTimeout() {
return (int) socketTimeout.toMillis();
