This is an automated email from the ASF dual-hosted git repository.
elecharny pushed a commit to branch 1.2.X
in repository https://gitbox.apache.org/repos/asf/mina-ftpserver.git
The following commit(s) were added to refs/heads/1.2.X by this push:
new 41b832ca Replaced true/false by <code>true/false</code> in javadoc
41b832ca is described below
commit 41b832cafd3611ededa972ded89c88de9c40f3be
Author: emmanuel lecharny <[email protected]>
AuthorDate: Mon Jan 6 14:54:13 2025 +0100
Replaced true/false by <code>true/false</code> in javadoc
---
core/src/main/java/org/apache/ftpserver/ConnectionConfig.java | 2 +-
.../java/org/apache/ftpserver/ConnectionConfigFactory.java | 2 +-
.../java/org/apache/ftpserver/DataConnectionConfiguration.java | 4 ++--
.../apache/ftpserver/DataConnectionConfigurationFactory.java | 4 ++--
core/src/main/java/org/apache/ftpserver/FtpServer.java | 4 ++--
.../org/apache/ftpserver/command/CommandFactoryFactory.java | 2 +-
.../org/apache/ftpserver/command/impl/listing/FileFilter.java | 2 +-
.../apache/ftpserver/command/impl/listing/ListArgument.java | 2 +-
core/src/main/java/org/apache/ftpserver/impl/FtpIoSession.java | 2 +-
core/src/main/java/org/apache/ftpserver/listener/Listener.java | 3 +--
.../java/org/apache/ftpserver/listener/ListenerFactory.java | 3 ++-
.../org/apache/ftpserver/listener/nio/FtpLoggingFilter.java | 2 +-
.../org/apache/ftpserver/usermanager/PasswordEncryptor.java | 2 +-
.../java/org/apache/ftpserver/usermanager/UserFactory.java | 2 +-
.../org/apache/ftpserver/usermanager/impl/DbUserManager.java | 2 +-
.../main/java/org/apache/ftpserver/util/BaseProperties.java | 2 +-
core/src/main/java/org/apache/ftpserver/util/ClassUtils.java | 2 +-
core/src/main/java/org/apache/ftpserver/util/OS.java | 10 +++++-----
core/src/main/java/org/apache/ftpserver/util/PasswordUtil.java | 4 ++--
.../src/main/java/org/apache/ftpserver/ftplet/Authority.java | 4 ++--
.../org/apache/ftpserver/ftplet/DataConnectionFactory.java | 2 +-
.../main/java/org/apache/ftpserver/ftplet/FileSystemView.java | 4 ++--
.../src/main/java/org/apache/ftpserver/ftplet/FtpFile.java | 2 +-
.../src/main/java/org/apache/ftpserver/ftplet/FtpRequest.java | 2 +-
.../src/main/java/org/apache/ftpserver/ftplet/FtpSession.java | 2 +-
ftplet-api/src/main/java/org/apache/ftpserver/ftplet/User.java | 2 +-
.../src/main/java/org/apache/ftpserver/ftplet/UserManager.java | 4 ++--
27 files changed, 39 insertions(+), 39 deletions(-)
diff --git a/core/src/main/java/org/apache/ftpserver/ConnectionConfig.java
b/core/src/main/java/org/apache/ftpserver/ConnectionConfig.java
index 3ad14c85..3d1d5e12 100644
--- a/core/src/main/java/org/apache/ftpserver/ConnectionConfig.java
+++ b/core/src/main/java/org/apache/ftpserver/ConnectionConfig.java
@@ -56,7 +56,7 @@ public interface ConnectionConfig {
/**
* Is anonymous logins allowed at the server?
- * @return true if anonymous logins are enabled
+ * @return <code>true</code> if anonymous logins are enabled
*/
boolean isAnonymousLoginEnabled();
diff --git
a/core/src/main/java/org/apache/ftpserver/ConnectionConfigFactory.java
b/core/src/main/java/org/apache/ftpserver/ConnectionConfigFactory.java
index d096e0e4..d2f38aee 100644
--- a/core/src/main/java/org/apache/ftpserver/ConnectionConfigFactory.java
+++ b/core/src/main/java/org/apache/ftpserver/ConnectionConfigFactory.java
@@ -87,7 +87,7 @@ public class ConnectionConfigFactory {
/**
* Is anonymous logins allowed at the server?
- * @return true if anonymous logins are enabled
+ * @return <code>true</code> if anonymous logins are enabled
*/
public boolean isAnonymousLoginEnabled() {
return anonymousLoginEnabled;
diff --git
a/core/src/main/java/org/apache/ftpserver/DataConnectionConfiguration.java
b/core/src/main/java/org/apache/ftpserver/DataConnectionConfiguration.java
index 7c782b5a..b7e8c8a5 100644
--- a/core/src/main/java/org/apache/ftpserver/DataConnectionConfiguration.java
+++ b/core/src/main/java/org/apache/ftpserver/DataConnectionConfiguration.java
@@ -38,13 +38,13 @@ public interface DataConnectionConfiguration {
/**
* Is active data connection enabled?
- * @return true if active data connections are enabled
+ * @return <code>true</code> if active data connections are enabled
*/
boolean isActiveEnabled();
/**
* Check the PORT IP with the client IP?
- * @return true if the PORT IP is verified
+ * @return <code>true</code> if the PORT IP is verified
*/
boolean isActiveIpCheck();
diff --git
a/core/src/main/java/org/apache/ftpserver/DataConnectionConfigurationFactory.java
b/core/src/main/java/org/apache/ftpserver/DataConnectionConfigurationFactory.java
index 016259d5..0a092efb 100644
---
a/core/src/main/java/org/apache/ftpserver/DataConnectionConfigurationFactory.java
+++
b/core/src/main/java/org/apache/ftpserver/DataConnectionConfigurationFactory.java
@@ -99,7 +99,7 @@ public class DataConnectionConfigurationFactory {
/**
* Is PORT enabled?
- * @return true if active data connections are enabled
+ * @return <code>true</code> if active data connections are enabled
*/
public boolean isActiveEnabled() {
return activeEnabled;
@@ -115,7 +115,7 @@ public class DataConnectionConfigurationFactory {
/**
* Check the PORT IP?
- * @return true if the client IP is verified against the PORT IP
+ * @return <code>true</code> if the client IP is verified against the PORT
IP
*/
public boolean isActiveIpCheck() {
return activeIpCheck;
diff --git a/core/src/main/java/org/apache/ftpserver/FtpServer.java
b/core/src/main/java/org/apache/ftpserver/FtpServer.java
index 4bfe8a0e..49da5b5e 100644
--- a/core/src/main/java/org/apache/ftpserver/FtpServer.java
+++ b/core/src/main/java/org/apache/ftpserver/FtpServer.java
@@ -44,7 +44,7 @@ public interface FtpServer {
/**
* Get the server status.
- * @return true if the server is stopped
+ * @return <code>true</code> if the server is stopped
*/
boolean isStopped();
@@ -60,7 +60,7 @@ public interface FtpServer {
/**
* Is the server suspended
- * @return true if the server is suspended
+ * @return <code>true</code> if the server is suspended
*/
boolean isSuspended();
diff --git
a/core/src/main/java/org/apache/ftpserver/command/CommandFactoryFactory.java
b/core/src/main/java/org/apache/ftpserver/command/CommandFactoryFactory.java
index eefc05b1..540de8c1 100644
--- a/core/src/main/java/org/apache/ftpserver/command/CommandFactoryFactory.java
+++ b/core/src/main/java/org/apache/ftpserver/command/CommandFactoryFactory.java
@@ -184,7 +184,7 @@ public class CommandFactoryFactory {
/**
* Are default commands used?
*
- * @return true if default commands are used
+ * @return <code>true</code> if default commands are used
*/
public boolean isUseDefaultCommands() {
return useDefaultCommands;
diff --git
a/core/src/main/java/org/apache/ftpserver/command/impl/listing/FileFilter.java
b/core/src/main/java/org/apache/ftpserver/command/impl/listing/FileFilter.java
index 00f9251b..786dce16 100644
---
a/core/src/main/java/org/apache/ftpserver/command/impl/listing/FileFilter.java
+++
b/core/src/main/java/org/apache/ftpserver/command/impl/listing/FileFilter.java
@@ -36,7 +36,7 @@ public interface FileFilter {
*
* @param file
* The {@link FtpFile}
- * @return true if the {@link FtpFile} was selected
+ * @return <code>true</code> if the {@link FtpFile} was selected
*/
boolean accept(FtpFile file);
diff --git
a/core/src/main/java/org/apache/ftpserver/command/impl/listing/ListArgument.java
b/core/src/main/java/org/apache/ftpserver/command/impl/listing/ListArgument.java
index b434231a..6370b851 100644
---
a/core/src/main/java/org/apache/ftpserver/command/impl/listing/ListArgument.java
+++
b/core/src/main/java/org/apache/ftpserver/command/impl/listing/ListArgument.java
@@ -74,7 +74,7 @@ public class ListArgument {
*
* @param option
* The option to check
- * @return true if the option is set
+ * @return <code>true</code> if the option is set
*/
public boolean hasOption(char option) {
for (int i = 0; i < options.length; i++) {
diff --git a/core/src/main/java/org/apache/ftpserver/impl/FtpIoSession.java
b/core/src/main/java/org/apache/ftpserver/impl/FtpIoSession.java
index 8e6b7035..0f7bb9ec 100644
--- a/core/src/main/java/org/apache/ftpserver/impl/FtpIoSession.java
+++ b/core/src/main/java/org/apache/ftpserver/impl/FtpIoSession.java
@@ -791,7 +791,7 @@ public class FtpIoSession implements IoSession {
* Indicates whether the control socket for this session is secure, that
is,
* running over SSL/TLS
*
- * @return true if the control socket is secured
+ * @return <code>true</code> if the control socket is secured
*/
public boolean isSecure() {
return getFilterChain().contains(SslFilter.class);
diff --git a/core/src/main/java/org/apache/ftpserver/listener/Listener.java
b/core/src/main/java/org/apache/ftpserver/listener/Listener.java
index d8aa6af6..937bd0bc 100644
--- a/core/src/main/java/org/apache/ftpserver/listener/Listener.java
+++ b/core/src/main/java/org/apache/ftpserver/listener/Listener.java
@@ -95,8 +95,7 @@ public interface Listener {
* Is this listener in SSL mode automatically or must the client explicitly
* request to use SSL
*
- * @return true is the listener is automatically in SSL mode, false
- * otherwise
+ * @return <code>true</code> is the listener is automatically in SSL mode,
<code>false</code> otherwise
*/
boolean isImplicitSsl();
diff --git
a/core/src/main/java/org/apache/ftpserver/listener/ListenerFactory.java
b/core/src/main/java/org/apache/ftpserver/listener/ListenerFactory.java
index 1a292d30..33fce6f3 100644
--- a/core/src/main/java/org/apache/ftpserver/listener/ListenerFactory.java
+++ b/core/src/main/java/org/apache/ftpserver/listener/ListenerFactory.java
@@ -120,7 +120,8 @@ public class ListenerFactory {
* Is listeners created by this factory in SSL mode automatically or must
the client explicitly
* request to use SSL
*
- * @return true is listeners created by this factory is automatically in
SSL mode, false otherwise
+ * @return <code>true</code> is listeners created by this factory is
automatically in SSL mode,
+ * <code>false</code> otherwise
*/
public boolean isImplicitSsl() {
return implicitSsl;
diff --git
a/core/src/main/java/org/apache/ftpserver/listener/nio/FtpLoggingFilter.java
b/core/src/main/java/org/apache/ftpserver/listener/nio/FtpLoggingFilter.java
index 481212c7..285da8b5 100644
--- a/core/src/main/java/org/apache/ftpserver/listener/nio/FtpLoggingFilter.java
+++ b/core/src/main/java/org/apache/ftpserver/listener/nio/FtpLoggingFilter.java
@@ -94,7 +94,7 @@ public class FtpLoggingFilter extends LoggingFilter {
/**
* Are password masked?
*
- * @return true if passwords are masked
+ * @return <code>true</code> if passwords are masked
*/
public boolean isMaskPassword() {
return maskPassword;
diff --git
a/core/src/main/java/org/apache/ftpserver/usermanager/PasswordEncryptor.java
b/core/src/main/java/org/apache/ftpserver/usermanager/PasswordEncryptor.java
index 3006580a..2f5c8512 100644
--- a/core/src/main/java/org/apache/ftpserver/usermanager/PasswordEncryptor.java
+++ b/core/src/main/java/org/apache/ftpserver/usermanager/PasswordEncryptor.java
@@ -38,7 +38,7 @@ public interface PasswordEncryptor {
* Matches an encrypted password with that stored
* @param passwordToCheck The encrypted password to check
* @param storedPassword The stored password
- * @return true if the password match
+ * @return <code>true</code> if the password match
*/
boolean matches(String passwordToCheck, String storedPassword);
}
diff --git
a/core/src/main/java/org/apache/ftpserver/usermanager/UserFactory.java
b/core/src/main/java/org/apache/ftpserver/usermanager/UserFactory.java
index f57856d8..eaa353ab 100644
--- a/core/src/main/java/org/apache/ftpserver/usermanager/UserFactory.java
+++ b/core/src/main/java/org/apache/ftpserver/usermanager/UserFactory.java
@@ -127,7 +127,7 @@ public class UserFactory {
/**
* Get the enabled status for users created by this factory
- * @return true if the user is enabled (allowed to log in)
+ * @return <code>true</code> if the user is enabled (allowed to log in)
*/
public boolean isEnabled() {
return isEnabled;
diff --git
a/core/src/main/java/org/apache/ftpserver/usermanager/impl/DbUserManager.java
b/core/src/main/java/org/apache/ftpserver/usermanager/impl/DbUserManager.java
index ceab1e30..8f3ac947 100644
---
a/core/src/main/java/org/apache/ftpserver/usermanager/impl/DbUserManager.java
+++
b/core/src/main/java/org/apache/ftpserver/usermanager/impl/DbUserManager.java
@@ -273,7 +273,7 @@ public class DbUserManager extends AbstractUserManager {
}
/**
- * @return true if user with this login is administrator
+ * @return <code>true</code> if user with this login is administrator
*/
@Override
public boolean isAdmin(String login) throws FtpException {
diff --git a/core/src/main/java/org/apache/ftpserver/util/BaseProperties.java
b/core/src/main/java/org/apache/ftpserver/util/BaseProperties.java
index 2bb448b6..fbdae09d 100644
--- a/core/src/main/java/org/apache/ftpserver/util/BaseProperties.java
+++ b/core/src/main/java/org/apache/ftpserver/util/BaseProperties.java
@@ -66,7 +66,7 @@ public class BaseProperties extends Properties {
*
* @param str The property to read
* @throws FtpException If the property is null
- * @return <code>true</code> if th property contains 'true'
+ * @return <code>true</code> if the property contains 'true'
*/
public boolean getBoolean(final String str) throws FtpException {
String prop = getProperty(str);
diff --git a/core/src/main/java/org/apache/ftpserver/util/ClassUtils.java
b/core/src/main/java/org/apache/ftpserver/util/ClassUtils.java
index d7387051..42352566 100644
--- a/core/src/main/java/org/apache/ftpserver/util/ClassUtils.java
+++ b/core/src/main/java/org/apache/ftpserver/util/ClassUtils.java
@@ -36,7 +36,7 @@ public class ClassUtils {
* The class to check
* @param className
* The class name to look for in the super classes
- * @return true if the class extends a class by the specified name.
+ * @return <code>true</code> if the class extends a class by the specified
name.
*/
public static boolean extendsClass(final Class<?> clazz, String className)
{
Class<?> superClass = clazz.getSuperclass();
diff --git a/core/src/main/java/org/apache/ftpserver/util/OS.java
b/core/src/main/java/org/apache/ftpserver/util/OS.java
index 1255fdb3..b8b1f717 100644
--- a/core/src/main/java/org/apache/ftpserver/util/OS.java
+++ b/core/src/main/java/org/apache/ftpserver/util/OS.java
@@ -86,7 +86,7 @@ public final class OS {
*
* @param family
* the family to check for
- * @return true if the OS matches
+ * @return <code>true</code> if the OS matches
*/
private static boolean isFamily(final String family) {
return isOs(family, null, null, null);
@@ -141,7 +141,7 @@ public final class OS {
*
* @param name
* the OS name to check for
- * @return true if the OS matches
+ * @return <code>true</code> if the OS matches
*/
public static boolean isName(final String name) {
return isOs(null, name, null, null);
@@ -153,7 +153,7 @@ public final class OS {
*
* @param arch
* the OS architecture to check for
- * @return true if the OS matches
+ * @return <code>true</code> if the OS matches
*/
public static boolean isArch(final String arch) {
return isOs(null, null, arch, null);
@@ -165,7 +165,7 @@ public final class OS {
*
* @param version
* the OS version to check for
- * @return true if the OS matches
+ * @return <code>true</code> if the OS matches
*/
public static boolean isVersion(final String version) {
return isOs(null, null, null, version);
@@ -183,7 +183,7 @@ public final class OS {
* The OS architecture
* @param version
* The OS version
- * @return true if the OS matches
+ * @return <code>true</code> if the OS matches
*/
public static boolean isOs(final String family, final String name,
final String arch, final String version) {
diff --git a/core/src/main/java/org/apache/ftpserver/util/PasswordUtil.java
b/core/src/main/java/org/apache/ftpserver/util/PasswordUtil.java
index abadf6fb..511cbf7c 100644
--- a/core/src/main/java/org/apache/ftpserver/util/PasswordUtil.java
+++ b/core/src/main/java/org/apache/ftpserver/util/PasswordUtil.java
@@ -30,7 +30,7 @@ public class PasswordUtil {
*
* @throws IllegalArgumentException when the limit is less than the
password length
*
- * @return true if the passwords match
+ * @return <code>true</code> if the passwords match
*/
public static boolean secureCompare(String input, String password, int
loops) {
if (loops < password.length()) {
@@ -67,7 +67,7 @@ public class PasswordUtil {
* @param password correct password
* @throws IllegalArgumentException when the limit is less than the
password length
*
- * @return true if the passwords match
+ * @return <code>true</code> if the passwords match
*/
public static boolean secureCompareFast(String input, String password) {
/*
diff --git
a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/Authority.java
b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/Authority.java
index b18cb235..ea111aba 100644
--- a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/Authority.java
+++ b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/Authority.java
@@ -42,8 +42,8 @@ public interface Authority {
* @param request
* The {@link AuthorizationRequest}
* @return Returns a populated AuthorizationRequest as long as If
- * {@link #canAuthorize(AuthorizationRequest)} returns true for the
- * AuthorizationRequest, otherwise returns null.
+ * {@link #canAuthorize(AuthorizationRequest)} returns
<code>true</code> for the
+ * AuthorizationRequest, otherwise returns <code>null</code>.
* {@link #canAuthorize(AuthorizationRequest)} should always be
checked before
* calling this method.
*/
diff --git
a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/DataConnectionFactory.java
b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/DataConnectionFactory.java
index 6785e922..7accfc2c 100644
---
a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/DataConnectionFactory.java
+++
b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/DataConnectionFactory.java
@@ -38,7 +38,7 @@ public interface DataConnectionFactory {
* Indicates whether the data socket created by this factory will be secure
* that is, running over SSL/TLS.
*
- * @return true if the data socket will be secured
+ * @return <code>true</code> if the data socket will be secured
*/
boolean isSecure();
diff --git
a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FileSystemView.java
b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FileSystemView.java
index 1a3e705a..78ef3388 100644
--- a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FileSystemView.java
+++ b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FileSystemView.java
@@ -45,7 +45,7 @@ public interface FileSystemView {
* Change directory.
*
* @param dir The path of the directory to set as the current directory
for the user
- * @return true if successful
+ * @return <code>true</code> if successful
* @throws FtpException When the change to Home Directory can't be done
*/
boolean changeWorkingDirectory(String dir) throws FtpException;
@@ -62,7 +62,7 @@ public interface FileSystemView {
/**
* Does the file system support random file access?
*
- * @return true if the file supports random access
+ * @return <code>true</code> if the file supports random access
* @throws FtpException When random file access isn't supported
*/
boolean isRandomAccessible() throws FtpException;
diff --git a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpFile.java
b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpFile.java
index 6db33e0d..c27569a4 100644
--- a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpFile.java
+++ b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpFile.java
@@ -62,7 +62,7 @@ public interface FtpFile {
/**
* Is it a file?
*
- * @return <code>true</code> if the {@link FtpFile} is a file, false if it
is a directory
+ * @return <code>true</code> if the {@link FtpFile} is a file,
<code>false</code> if it is a directory
*/
boolean isFile();
diff --git
a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpRequest.java
b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpRequest.java
index 33b18a0c..fa617acb 100644
--- a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpRequest.java
+++ b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpRequest.java
@@ -47,7 +47,7 @@ public interface FtpRequest {
/**
* Check if request contains an argument
*
- * @return true if an argument is available
+ * @return <code>true</code> if an argument is available
*/
boolean hasArgument();
diff --git
a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpSession.java
b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpSession.java
index 512b86f5..57e6bc66 100644
--- a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpSession.java
+++ b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpSession.java
@@ -207,7 +207,7 @@ public interface FtpSession {
* Indicates whether the control socket for this session is secure, that
is,
* running over SSL/TLS
*
- * @return true if the control socket is secured
+ * @return <code>true</code> if the control socket is secured
*/
boolean isSecure();
diff --git a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/User.java
b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/User.java
index a351b8d7..95f96038 100644
--- a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/User.java
+++ b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/User.java
@@ -76,7 +76,7 @@ public interface User {
/**
* Get the user enable status.
*
- * @return true if the user is enabled
+ * @return <code>true</code> if the user is enabled
*/
boolean getEnabled();
diff --git
a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/UserManager.java
b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/UserManager.java
index 94d3e115..79809671 100644
--- a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/UserManager.java
+++ b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/UserManager.java
@@ -70,7 +70,7 @@ public interface UserManager {
/**
* Check if the user exists.
* @param username the name of the user to check.
- * @return true if the user exist, false otherwise.
+ * @return <code>true</code> if the user exist, <code>false</code>
otherwise.
* @throws FtpException
*/
boolean doesExist(String username) throws FtpException;
@@ -94,7 +94,7 @@ public interface UserManager {
/**
* Check if the user is admin.
* @param username The name of the {@link User} to check
- * @return true if user with this login is administrator
+ * @return <code>true</code> if user with this login is administrator
* @throws FtpException when the UserManager can't fulfill the request.
*/
boolean isAdmin(String username) throws FtpException;
