You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2025/03/22 13:41:12 UTC
(commons-net) branch master updated: Javadoc @since tag should be after @return and @throws
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-net.git
The following commit(s) were added to refs/heads/master by this push:
new 8bbc3661 Javadoc @since tag should be after @return and @throws
8bbc3661 is described below
commit 8bbc3661776639ed37ee4626ffbe8fd2d03dab2e
Author: Gary D. Gregory <ga...@gmail.com>
AuthorDate: Sat Mar 22 09:41:06 2025 -0400
Javadoc @since tag should be after @return and @throws
---
src/main/java/org/apache/commons/net/ftp/FTPClient.java | 4 ++--
src/main/java/org/apache/commons/net/ftp/FTPSClient.java | 16 ++++++++--------
.../java/org/apache/commons/net/util/SubnetUtils.java | 2 +-
3 files changed, 11 insertions(+), 11 deletions(-)
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 fd9b44cb..821cccff 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
@@ -848,9 +848,9 @@ public class FTPClient extends FTP implements Configurable {
/**
* Parses a reply.
*
- * @since 3.1
* @param reply the reply to parse
* @throws MalformedServerReplyException if the server reply does not match (n,n,n,n),(n),(n)
+ * @since 3.1
*/
protected void _parsePassiveModeReply(final String reply) throws MalformedServerReplyException {
final Matcher m = PARMS_PAT.matcher(reply);
@@ -964,12 +964,12 @@ public class FTPClient extends FTP implements Configurable {
/**
* Stores the given stream.
*
- * @since 3.1
* @param command the command to send
* @param remote the remote file name
* @param local The local InputStream from which to read the data to be written/appended to the remote file.
* @return true if successful
* @throws IOException on error
+ * @since 3.1
*/
protected boolean _storeFile(final String command, final String remote, final InputStream local) throws IOException {
final Socket socket = _openDataConnection_(command, remote);
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 58598c62..fa40e199 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
@@ -636,8 +636,8 @@ public class FTPSClient extends FTPClient {
/**
* Gets the secure socket protocol to be used, e.g. SSL/TLS.
*
- * @since 3.11.0
* @return the protocol
+ * @since 3.11.0
*/
protected String getProtocol() {
return protocol;
@@ -647,8 +647,8 @@ 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.
*
- * @since 3.11.0
* @return a clone of the protocols, may be null
+ * @since 3.11.0
*/
protected String[] getProtocols() {
return protocols == null ? null : protocols.clone();
@@ -658,8 +658,8 @@ 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.
*
- * @since 3.11.0
* @return a clone of the suites, may be null
+ * @since 3.11.0
*/
protected String[] getSuites() {
return suites == null ? null : suites.clone();
@@ -714,8 +714,8 @@ public class FTPSClient extends FTPClient {
* Tests the use client mode flag. The {@link #getUseClientMode()} method gets the value from the socket while
* this method gets its value from this instance's config.
*
- * @since 3.11.0
* @return True If the socket should start its first handshake in "client" mode.
+ * @since 3.11.0
*/
protected boolean isClientMode() {
return isClientMode;
@@ -724,8 +724,8 @@ public class FTPSClient extends FTPClient {
/**
* Tests whether a new SSL session may be established by this socket. Default true
*
- * @since 3.11.0
* @return True if session may be established
+ * @since 3.11.0
*/
protected boolean isCreation() {
return isCreation;
@@ -746,8 +746,8 @@ public class FTPSClient extends FTPClient {
/**
* Tests the security mode. (True - Implicit Mode / False - Explicit Mode).
*
- * @since 3.11.0
* @return True if enabled, false if not.
+ * @since 3.11.0
*/
protected boolean isImplicit() {
return isImplicit;
@@ -757,8 +757,8 @@ public class FTPSClient extends FTPClient {
* Tests the need client auth flag. The {@link #getNeedClientAuth()} method gets the value from the socket while
* this method gets its value from this instance's config.
*
- * @since 3.11.0
* @return True if enabled, false if not.
+ * @since 3.11.0
*/
protected boolean isNeedClientAuth() {
return isNeedClientAuth;
@@ -768,8 +768,8 @@ public class FTPSClient extends FTPClient {
* Tests the want client auth flag. The {@link #getWantClientAuth()} method gets the value from the socket while
* this method gets its value from this instance's config.
*
- * @since 3.11.0
* @return True if enabled, false if not.
+ * @since 3.11.0
*/
protected boolean isWantClientAuth() {
return isWantClientAuth;
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 a6c07968..dab6e7c2 100644
--- a/src/main/java/org/apache/commons/net/util/SubnetUtils.java
+++ b/src/main/java/org/apache/commons/net/util/SubnetUtils.java
@@ -494,8 +494,8 @@ public class SubnetUtils {
/**
* Tests if the return value of {@link SubnetInfo#getAddressCount()} includes the network and broadcast addresses.
*
- * @since 2.2
* @return true if the host count includes the network and broadcast addresses
+ * @since 2.2
*/
public boolean isInclusiveHostCount() {
return inclusiveHostCount;