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 b4654a44 Javadoc
b4654a44 is described below
commit b4654a445b6f340d41a5afb0e7199705e300437e
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:09:01 2026 -0400
Javadoc
---
.../commons/net/DefaultDatagramSocketFactory.java | 6 +++---
.../net/examples/PrintCommandListeners.java | 2 +-
.../java/org/apache/commons/net/ftp/FTPClient.java | 2 +-
.../apache/commons/net/ftp/FTPClientConfig.java | 6 +++---
.../apache/commons/net/ftp/FTPListParseEngine.java | 10 +++++-----
.../org/apache/commons/net/ftp/FTPSClient.java | 4 ++--
.../parser/ConfigurableFTPFileEntryParserImpl.java | 2 +-
.../commons/net/ftp/parser/FTPTimestampParser.java | 2 +-
.../net/ftp/parser/FTPTimestampParserImpl.java | 4 ++--
.../commons/net/ftp/parser/MLSxEntryParser.java | 4 ++--
.../ftp/parser/RegexFTPFileEntryParserImpl.java | 2 +-
.../java/org/apache/commons/net/imap/IMAP.java | 2 +-
src/main/java/org/apache/commons/net/io/Util.java | 2 +-
.../java/org/apache/commons/net/nntp/Article.java | 2 +-
.../org/apache/commons/net/nntp/NNTPClient.java | 22 +++++++++++-----------
.../org/apache/commons/net/nntp/Threadable.java | 4 ++--
.../java/org/apache/commons/net/ntp/NtpV3Impl.java | 4 ++--
.../org/apache/commons/net/ntp/NtpV3Packet.java | 2 +-
.../java/org/apache/commons/net/ntp/TimeInfo.java | 2 +-
.../java/org/apache/commons/net/ntp/TimeStamp.java | 6 +++---
.../java/org/apache/commons/net/util/Base64.java | 6 +++---
.../org/apache/commons/net/util/ListenerList.java | 2 +-
.../org/apache/commons/net/util/SubnetUtils.java | 6 +++---
.../org/apache/commons/net/util/SubnetUtils6.java | 8 ++++----
.../apache/commons/net/util/TrustManagerUtils.java | 2 +-
25 files changed, 57 insertions(+), 57 deletions(-)
diff --git
a/src/main/java/org/apache/commons/net/DefaultDatagramSocketFactory.java
b/src/main/java/org/apache/commons/net/DefaultDatagramSocketFactory.java
index 2108200b..100209d6 100644
--- a/src/main/java/org/apache/commons/net/DefaultDatagramSocketFactory.java
+++ b/src/main/java/org/apache/commons/net/DefaultDatagramSocketFactory.java
@@ -41,7 +41,7 @@ public class DefaultDatagramSocketFactory implements
DatagramSocketFactory {
/**
* Creates a DatagramSocket on the local host at the first available port.
*
- * @return a new DatagramSocket
+ * @return A new DatagramSocket
* @throws SocketException If the socket could not be created.
*/
@Override
@@ -53,7 +53,7 @@ public class DefaultDatagramSocketFactory implements
DatagramSocketFactory {
* Creates a DatagramSocket on the local host at a specified port.
*
* @param port The port to use for the socket.
- * @return a new DatagramSocket
+ * @return A new DatagramSocket
* @throws SocketException If the socket could not be created.
*/
@Override
@@ -66,7 +66,7 @@ public class DefaultDatagramSocketFactory implements
DatagramSocketFactory {
*
* @param port The port to use for the socket.
* @param localAddress The local address to use.
- * @return a new DatagramSocket
+ * @return A new DatagramSocket
* @throws SocketException If the socket could not be created.
*/
@Override
diff --git
a/src/main/java/org/apache/commons/net/examples/PrintCommandListeners.java
b/src/main/java/org/apache/commons/net/examples/PrintCommandListeners.java
index 7f0e82db..b6395b15 100644
--- a/src/main/java/org/apache/commons/net/examples/PrintCommandListeners.java
+++ b/src/main/java/org/apache/commons/net/examples/PrintCommandListeners.java
@@ -28,7 +28,7 @@ public class PrintCommandListeners {
/**
* Creates a new PrintCommandListener on system out.
*
- * @return a new PrintCommandListener on system out.
+ * @return A new PrintCommandListener on system out.
*/
public static PrintCommandListener sysOutPrintCommandListener() {
return new PrintCommandListener(Util.newPrintWriter(System.out), true);
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 2665e485..77fb2a3a 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
@@ -2555,7 +2555,7 @@ public class FTPClient extends FTP implements
Configurable {
* Merge two copystream listeners, either or both of which may be null.
*
* @param local the listener used by this class, may be null
- * @return a merged listener or a single listener or null
+ * @return A merged listener or a single listener or null
* @since 3.0
*/
private CopyStreamListener mergeListeners(final CopyStreamListener local) {
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 5cebe06d..3c8694c0 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPClientConfig.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPClientConfig.java
@@ -224,7 +224,7 @@ public class FTPClientConfig {
* Gets a DateFormatSymbols object configured with short month names as in
the supplied string
*
* @param shortmonths This should be as described in {@link
#setShortMonthNames(String) shortMonthNames}
- * @return a DateFormatSymbols object configured with short month names as
in the supplied string
+ * @return A DateFormatSymbols object configured with short month names as
in the supplied string
*/
public static DateFormatSymbols getDateFormatSymbols(final String
shortmonths) {
final String[] months = splitShortMonthString(shortmonths);
@@ -237,7 +237,7 @@ public class FTPClientConfig {
* Gets a Collection of all the language codes currently supported by this
class. See {@link #setServerLanguageCode(String) serverLanguageCode} for a
* functional description of language codes within this system.
*
- * @return a Collection of all the language codes currently supported by
this class
+ * @return A Collection of all the language codes currently supported by
this class
*/
public static Collection<String> getSupportedLanguageCodes() {
return LANGUAGE_CODE_MAP.keySet();
@@ -248,7 +248,7 @@ public class FTPClientConfig {
* names corresponding to the code. If there is no corresponding entry in
the table, the object returned will be that for {@code Locale.US}
*
* @param languageCode See {@link #setServerLanguageCode(String)
serverLanguageCode}
- * @return a DateFormatSymbols object configured with short month names
corresponding to the supplied code, or with month names for {@code Locale.US}
+ * @return A DateFormatSymbols object configured with short month names
corresponding to the supplied code, or with month names for {@code Locale.US}
* if there is no corresponding entry in the internal table.
*/
public static DateFormatSymbols lookupDateFormatSymbols(final String
languageCode) {
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 96ec816a..21b3aca8 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java
@@ -106,7 +106,7 @@ 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.
+ * @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
* entry for null before referencing it, or use a filter such as
{@link FTPFileFilters#NON_NULL} which does not allow null entries.
@@ -122,7 +122,7 @@ public class FTPListParseEngine {
/**
* Gets an array of FTPFile objects containing the whole list of files
returned by the server as read by this object's parser.
*
- * @return an array of FTPFile objects containing the whole list of files
returned by the server as read by this object's parser. None of the entries will
+ * @return An array of FTPFile objects containing the whole list of files
returned by the server as read by this object's parser. None of the entries will
* be null
* @throws IOException - not ever thrown, may be removed in a later release
*/
@@ -136,7 +136,7 @@ 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.
+ * @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
* entry for null before referencing it, or use a filter such as
{@link FTPFileFilters#NON_NULL} which does not allow null entries.
@@ -156,7 +156,7 @@ 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
+ * @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>
* <strong> NOTE:</strong> This array may contain null members if
any of the individual file listings failed to parse. The caller should check
each
@@ -188,7 +188,7 @@ 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
+ * @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).
* <p>
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
b/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
index 4d925d8a..837c028b 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
@@ -647,7 +647,7 @@ public class FTPSClient extends FTPClient {
* Gets the protocol versions. The {@link #getEnabledProtocols()} method
gets the value from the socket while
* this method gets its value from this instance's config.
*
- * @return a clone of the protocols, may be null
+ * @return A clone of the protocols, may be null
* @since 3.11.0
*/
protected String[] getProtocols() {
@@ -658,7 +658,7 @@ public class FTPSClient extends FTPClient {
* Gets the cipher suites. The {@link #getEnabledCipherSuites()} method
gets the value from the socket while
* this method gets its value from this instance's config.
*
- * @return a clone of the suites, may be null
+ * @return A clone of the suites, may be null
* @since 3.11.0
*/
protected String[] getSuites() {
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 a7fa4e2d..fe52cec4 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
@@ -98,7 +98,7 @@ public abstract class ConfigurableFTPFileEntryParserImpl
extends RegexFTPFileEnt
*
* @param timestampStr the timestamp string pulled from the file listing
by the regular expression parser, to be submitted to the
* {@code timestampParser} for extracting the
timestamp.
- * @return a {@code java.util.Calendar} containing results of the
timestamp parse.
+ * @return A {@code java.util.Calendar} containing results of the
timestamp parse.
* @throws ParseException on parse error
*/
public Calendar parseTimestamp(final String timestampStr) throws
ParseException {
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParser.java
b/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParser.java
index 5f6e57e2..bb7e1899 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParser.java
@@ -41,7 +41,7 @@ public interface FTPTimestampParser {
* Parses the supplied datestamp parameter. This parameter typically would
have been pulled from a longer FTP listing via the regular expression mechanism
*
* @param timestampStr the timestamp portion of the FTP directory
listing to be parsed
- * @return a {@code java.util.Calendar} object initialized to the date
parsed by the parser
+ * @return A {@code java.util.Calendar} object initialized to the date
parsed by the parser
* @throws ParseException if none of the parser mechanisms belonging to
the implementor can parse the input.
*/
Calendar parseTimestamp(String timestampStr) throws ParseException;
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 cc05c692..5a46b76a 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
@@ -224,7 +224,7 @@ public class FTPTimestampParserImpl implements
FTPTimestampParser, Configurable
/**
* Gets an array of 12 strings representing the short month names used by
this parse.
*
- * @return an array of 12 strings representing the short month names used
by this parse.
+ * @return An array of 12 strings representing the short month names used
by this parse.
*/
public String[] getShortMonths() {
return defaultDateFormat.getDateFormatSymbols().getShortMonths();
@@ -248,7 +248,7 @@ public class FTPTimestampParserImpl implements
FTPTimestampParser, Configurable
*
* @see FTPTimestampParserImpl#parseTimestamp(String, Calendar)
* @param timestampStr The timestamp to be parsed
- * @return a Calendar with the parsed timestamp
+ * @return A Calendar with the parsed timestamp
*/
@Override
public Calendar parseTimestamp(final String timestampStr) throws
ParseException {
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 0f836aa8..cb3668f3 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
@@ -104,7 +104,7 @@ public class MLSxEntryParser extends FTPFileEntryParserImpl
{
* Parse a GMT time stamp of the form yyyyMMDDHHMMSS[.sss]
*
* @param timestamp the date-time to parse
- * @return a Calendar entry, may be {@code null}
+ * @return A Calendar entry, may be {@code null}
* @since 3.4
*/
public static Calendar parseGMTdateTime(final String timestamp) {
@@ -138,7 +138,7 @@ public class MLSxEntryParser extends FTPFileEntryParserImpl
{
* Parse a GMT time stamp of the form yyyyMMDDHHMMSS[.sss]
*
* @param timestamp the date-time to parse
- * @return a Calendar entry, may be {@code null}
+ * @return A Calendar entry, may be {@code null}
* @since 3.9.0
*/
public static Instant parseGmtInstant(final String 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 bfefd62e..3ee8d054 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
@@ -110,7 +110,7 @@ public abstract class RegexFTPFileEntryParserImpl extends
FTPFileEntryParserImpl
* For debugging purposes.
* </p>
*
- * @return a string shows each match group by number.
+ * @return A string shows each match group by number.
*/
public String getGroupsAsString() {
final StringBuilder b = new StringBuilder();
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 efc10518..4642a816 100644
--- a/src/main/java/org/apache/commons/net/imap/IMAP.java
+++ b/src/main/java/org/apache/commons/net/imap/IMAP.java
@@ -228,7 +228,7 @@ public class IMAP extends SocketClient {
/**
* Generates a new command ID (tag) for a command.
*
- * @return a new command ID (tag) for an IMAP command.
+ * @return A new command ID (tag) for an IMAP command.
*/
protected String generateCommandID() {
final String res = new String(initialID);
diff --git a/src/main/java/org/apache/commons/net/io/Util.java
b/src/main/java/org/apache/commons/net/io/Util.java
index d16dad95..49353584 100644
--- a/src/main/java/org/apache/commons/net/io/Util.java
+++ b/src/main/java/org/apache/commons/net/io/Util.java
@@ -244,7 +244,7 @@ public final class Util {
* Creates a new PrintWriter using the default encoding.
*
* @param printStream the target PrintStream.
- * @return a new PrintWriter.
+ * @return A new PrintWriter.
* @since 3.11.0
*/
public static PrintWriter newPrintWriter(final PrintStream printStream) {
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 29edc68b..70b7ad7b 100644
--- a/src/main/java/org/apache/commons/net/nntp/Article.java
+++ b/src/main/java/org/apache/commons/net/nntp/Article.java
@@ -215,7 +215,7 @@ public class Article implements Threadable<Article> {
/**
* Returns the MessageId references as an array of Strings
*
- * @return an array of message-ids
+ * @return An array of message-ids
*/
public String[] getReferences() {
if (references == null) {
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 edb3adde..dd16e916 100644
--- a/src/main/java/org/apache/commons/net/nntp/NNTPClient.java
+++ b/src/main/java/org/apache/commons/net/nntp/NNTPClient.java
@@ -248,7 +248,7 @@ public class NNTPClient extends NNTP {
* Creates a new writer or returns null if we don't have a a positive
intermediate response.
*
* @param articleId Article ID.
- * @return a new writer or null.
+ * @return A new writer or null.
* @throws IOException If an I/O error occurs while either sending the
command or receiving the server reply.
*/
public Writer forwardArticle(final String articleId) throws IOException {
@@ -263,7 +263,7 @@ public class NNTPClient extends NNTP {
*
* @param lowArticleNumber low
* @param highArticleNumber high
- * @return an Iterable of Articles
+ * @return An Iterable of Articles
* @throws IOException if the command failed
* @since 3.0
*/
@@ -1026,7 +1026,7 @@ public class NNTPClient extends NNTP {
/**
* @param lowArticleNumber to fetch
- * @return a DotTerminatedReader if successful, null otherwise
+ * @return A DotTerminatedReader if successful, null otherwise
* @throws IOException tba
* @deprecated 3.0 use {@link #retrieveArticleInfo(long)} instead
*/
@@ -1038,7 +1038,7 @@ public class NNTPClient extends NNTP {
/**
* @param lowArticleNumber to fetch
* @param highArticleNumber to fetch
- * @return a DotTerminatedReader if successful, null otherwise
+ * @return A DotTerminatedReader if successful, null otherwise
* @throws IOException on error
* @deprecated 3.0 use {@link #retrieveArticleInfo(long, long)} instead
*/
@@ -1051,7 +1051,7 @@ public class NNTPClient extends NNTP {
* Return article headers for a specified post.
*
* @param articleNumber the article to retrieve headers for
- * @return a DotTerminatedReader if successful, null otherwise
+ * @return A DotTerminatedReader if successful, null otherwise
* @throws IOException on error
*/
public BufferedReader retrieveArticleInfo(final long articleNumber) throws
IOException {
@@ -1063,7 +1063,7 @@ public class NNTPClient extends NNTP {
*
* @param lowArticleNumber low number
* @param highArticleNumber high number
- * @return a DotTerminatedReader if successful, null otherwise
+ * @return A DotTerminatedReader if successful, null otherwise
* @throws IOException on error
*/
public BufferedReader retrieveArticleInfo(final long lowArticleNumber,
final long highArticleNumber) throws IOException {
@@ -1076,7 +1076,7 @@ public class NNTPClient extends NNTP {
* See {@link NNTP#xover} for legal agument formats. Alternatively, read
RFC 2980 :-)
*
* @param articleRange
- * @return a DotTerminatedMessageReader if successful, null otherwise
+ * @return A DotTerminatedMessageReader if successful, null otherwise
* @throws IOException
*/
private BufferedReader retrieveArticleInfo(final String articleRange)
throws IOException {
@@ -1103,7 +1103,7 @@ public class NNTPClient extends NNTP {
* @param header the header
* @param lowArticleNumber to fetch
* @param highArticleNumber to fetch
- * @return a DotTerminatedReader if successful, null otherwise
+ * @return A DotTerminatedReader if successful, null otherwise
* @throws IOException on error
* @deprecated 3.0 use {@link #retrieveHeader(String, long, long)} instead
*/
@@ -1117,7 +1117,7 @@ public class NNTPClient extends NNTP {
*
* @param header the header to retrieve
* @param articleNumber the article to retrieve the header for
- * @return a DotTerminatedReader if successful, null otherwise
+ * @return A DotTerminatedReader if successful, null otherwise
* @throws IOException on error
*/
public BufferedReader retrieveHeader(final String header, final long
articleNumber) throws IOException {
@@ -1130,7 +1130,7 @@ public class NNTPClient extends NNTP {
* @param header the header
* @param lowArticleNumber to fetch
* @param highArticleNumber to fetch
- * @return a DotTerminatedReader if successful, null otherwise
+ * @return A DotTerminatedReader if successful, null otherwise
* @throws IOException on error
*/
public BufferedReader retrieveHeader(final String header, final long
lowArticleNumber, final long highArticleNumber) throws IOException {
@@ -1145,7 +1145,7 @@ public class NNTPClient extends NNTP {
*
* @param header
* @param articleRange
- * @return a {@link DotTerminatedMessageReader} if successful, {@code
null} otherwise
+ * @return A {@link DotTerminatedMessageReader} if successful, {@code
null} otherwise
* @throws IOException
*/
private BufferedReader retrieveHeader(final String header, final String
articleRange) 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 7be3076e..fc9b42a7 100644
--- a/src/main/java/org/apache/commons/net/nntp/Threadable.java
+++ b/src/main/java/org/apache/commons/net/nntp/Threadable.java
@@ -34,14 +34,14 @@ public interface Threadable<T extends Threadable<T>> {
/**
* Creates a dummy instance.
*
- * @return a dummy instance.
+ * @return A dummy instance.
*/
T makeDummy();
/**
* Gets an ID.
*
- * @return an ID.
+ * @return An ID.
*/
String messageThreadId();
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 ab1205c6..2304a1bc 100644
--- a/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
+++ b/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
@@ -101,7 +101,7 @@ public class NtpV3Impl implements NtpV3Packet {
/**
* Gets the datagram packet with the NTP details already filled in.
*
- * @return a datagram packet.
+ * @return A datagram packet.
*/
@Override
public synchronized DatagramPacket getDatagramPacket() {
@@ -361,7 +361,7 @@ public class NtpV3Impl implements NtpV3Packet {
/**
* Computes a hash code for this object. The result is the exclusive OR of
the values of this object stored as a byte array.
*
- * @return a hash code value for this object.
+ * @return A hash code value for this object.
* @since 3.4
*/
@Override
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 40fe5877..893c1519 100644
--- a/src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java
+++ b/src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java
@@ -129,7 +129,7 @@ public interface NtpV3Packet {
/**
* Gets a datagram packet with the NTP parts already filled in.
*
- * @return a datagram packet with the NTP parts already filled in.
+ * @return A datagram packet with the NTP parts already filled in.
*/
DatagramPacket getDatagramPacket();
diff --git a/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
b/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
index 92dc0e91..305cca58 100644
--- a/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
+++ b/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
@@ -289,7 +289,7 @@ public class TimeInfo {
/**
* Computes a hash code for this object. The result is the exclusive OR of
the return time and the message hash code.
*
- * @return a hash code value for this object.
+ * @return A hash code value for this object.
* @since 3.4
*/
@Override
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 4f3a9771..1cc1c59c 100644
--- a/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
+++ b/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
@@ -331,7 +331,7 @@ public class TimeStamp implements Serializable,
Comparable<TimeStamp> {
*
* </blockquote>
*
- * @return a hash code value for this object.
+ * @return A hash code value for this object.
*/
@Override
public int hashCode() {
@@ -365,7 +365,7 @@ public class TimeStamp implements Serializable,
Comparable<TimeStamp> {
*
* </blockquote> See java.text.SimpleDataFormat for code descriptions.
*
- * @return a string representation of this date.
+ * @return A string representation of this date.
*/
public String toDateString() {
if (simpleFormatter == null) {
@@ -400,7 +400,7 @@ public class TimeStamp implements Serializable,
Comparable<TimeStamp> {
*
* </blockquote> See java.text.SimpleDataFormat for code descriptions.
*
- * @return a string representation of this date in UTC.
+ * @return A string representation of this date in UTC.
*/
public String toUTCString() {
if (utcFormatter == null) {
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 67da71f5..a29f89be 100644
--- a/src/main/java/org/apache/commons/net/util/Base64.java
+++ b/src/main/java/org/apache/commons/net/util/Base64.java
@@ -408,7 +408,7 @@ public class Base64 {
* Returns a byte-array representation of a {@code BigInteger} without
sign bit.
*
* @param bigInt {@code BigInteger} to be converted
- * @return a byte array representation of the BigInteger parameter
+ * @return A byte array representation of the BigInteger parameter
*/
private static byte[] toIntegerBytes(final BigInteger bigInt) {
Objects.requireNonNull(bigInt, "bigInt");
@@ -561,7 +561,7 @@ public class Base64 {
* Decodes a byte array containing characters in the Base64 alphabet.
*
* @param source A byte array containing Base64 character data
- * @return a byte array containing binary data; will return {@code null}
if provided byte array is {@code null}.
+ * @return A byte array containing binary data; will return {@code null}
if provided byte array is {@code null}.
*/
public byte[] decode(final byte[] source) {
return isEmpty(source) ? source : getDecoder().decode(source);
@@ -571,7 +571,7 @@ public class Base64 {
* Decodes a String containing characters in the Base64 alphabet.
*
* @param source A String containing Base64 character data, must not be
{@code null}
- * @return a byte array containing binary data
+ * @return A byte array containing binary data
* @since 1.4
*/
public byte[] decode(final String source) {
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 99e710c5..f04f16c1 100644
--- a/src/main/java/org/apache/commons/net/util/ListenerList.java
+++ b/src/main/java/org/apache/commons/net/util/ListenerList.java
@@ -78,7 +78,7 @@ public class ListenerList<T extends EventListener> implements
Serializable, Iter
/**
* Return an {@link Iterator} for the {@link EventListener} instances.
*
- * @return an {@link Iterator} for the {@link EventListener} instances
+ * @return An {@link Iterator} for the {@link EventListener} instances
* @since 2.0 TODO Check that this is a good defensive strategy
*/
@Override
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 4c244b22..671272d5 100644
--- a/src/main/java/org/apache/commons/net/util/SubnetUtils.java
+++ b/src/main/java/org/apache/commons/net/util/SubnetUtils.java
@@ -111,7 +111,7 @@ public class SubnetUtils {
/**
* Gets this instance's address into a dotted decimal String.
*
- * @return a dotted decimal String.
+ * @return A dotted decimal String.
*/
public String getAddress() {
return format(toArray4(address));
@@ -278,7 +278,7 @@ public class SubnetUtils {
/**
* Creates a new Iterable of address Strings.
*
- * @return a new Iterable of address Strings
+ * @return A new Iterable of address Strings
* @see #getAllAddresses()
* @see #streamAddressStrings()
* @since 3.12.0
@@ -299,7 +299,7 @@ public class SubnetUtils {
/**
* Creates a new Stream of address Strings.
*
- * @return a new Stream of address Strings.
+ * @return A new Stream of address Strings.
* @see #getAllAddresses()
* @see #iterableAddressStrings()
* @since 3.12.0
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 0669f6ad..991fae27 100644
--- a/src/main/java/org/apache/commons/net/util/SubnetUtils6.java
+++ b/src/main/java/org/apache/commons/net/util/SubnetUtils6.java
@@ -162,7 +162,7 @@ public class SubnetUtils6 {
/**
* Returns a summary of this subnet for debugging.
*
- * @return a multi-line debug string summarizing this subnet.
+ * @return A multi-line debug string summarizing this subnet.
*/
@Override
public String toString() {
@@ -202,7 +202,7 @@ public class SubnetUtils6 {
* Converts a BigInteger to a 16-byte array, padding with leading zeros if
necessary.
*
* @param value the BigInteger to convert.
- * @return a 16-byte array.
+ * @return A 16-byte array.
*/
private static byte[] toByteArray16(final BigInteger value) {
final byte[] raw = value.toByteArray();
@@ -309,7 +309,7 @@ public class SubnetUtils6 {
/**
* Gets a {@link SubnetInfo} instance that contains subnet-specific
statistics.
*
- * @return a new SubnetInfo instance.
+ * @return A new SubnetInfo instance.
*/
public SubnetInfo getInfo() {
return new SubnetInfo();
@@ -323,7 +323,7 @@ public class SubnetUtils6 {
* {@link #SubnetUtils6(String)}.
* </p>
*
- * @return a multi-line debug string summarizing this subnet.
+ * @return A multi-line debug string summarizing this subnet.
*/
@Override
public String toString() {
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 4a20b5d3..88d2fb46 100644
--- a/src/main/java/org/apache/commons/net/util/TrustManagerUtils.java
+++ b/src/main/java/org/apache/commons/net/util/TrustManagerUtils.java
@@ -58,7 +58,7 @@ public final class TrustManagerUtils {
}
/**
- * @return an empty array of certificates
+ * @return An empty array of certificates
*/
@Override
public X509Certificate[] getAcceptedIssuers() {
