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-vfs.git
The following commit(s) were added to refs/heads/master by this push:
new fad4d8a8 Normalize setter Javadoc
fad4d8a8 is described below
commit fad4d8a8db3fe97bd2e060b2b54fab1984719d25
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Oct 31 07:19:44 2023 -0400
Normalize setter Javadoc
---
.../java/org/apache/commons/vfs2/cache/LRUFilesCache.java | 4 ++--
.../org/apache/commons/vfs2/impl/DefaultFileMonitor.java | 4 ++--
.../apache/commons/vfs2/impl/DefaultFileSystemManager.java | 2 +-
.../vfs2/provider/ftp/FtpFileSystemConfigBuilder.java | 12 ++++++------
.../vfs2/provider/http4/Http4FileSystemConfigBuilder.java | 6 +++---
.../vfs2/provider/http5/Http5FileSystemConfigBuilder.java | 6 +++---
6 files changed, 17 insertions(+), 17 deletions(-)
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/LRUFilesCache.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/LRUFilesCache.java
index b66b3b8a..450497e5 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/LRUFilesCache.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/cache/LRUFilesCache.java
@@ -111,14 +111,14 @@ public class LRUFilesCache extends AbstractFilesCache {
private final ReadWriteLock rwLock = new ReentrantReadWriteLock();
/**
- * Default constructor. Uses an LRU size of 100 per file system.
+ * Constructs a new instance. Uses an LRU size of 100 per file system.
*/
public LRUFilesCache() {
this(DEFAULT_LRU_SIZE);
}
/**
- * Set the desired LRU size.
+ * Constructs a new instance with the desired LRU size.
*
* @param lruSize the LRU size
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileMonitor.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileMonitor.java
index 211f6d2e..5c053d3e 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileMonitor.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileMonitor.java
@@ -299,12 +299,12 @@ public class DefaultFileMonitor implements Runnable,
FileMonitor, AutoCloseable
private boolean recursive;
/**
- * Set the delay between checks
+ * Sets the delay between checks
*/
private Duration delay = DEFAULT_DELAY;
/**
- * Set the number of files to check until a delay will be inserted
+ * Sets the number of files to check until a delay will be inserted
*/
private int checksPerRun = DEFAULT_MAX_FILES;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java
index 2d9380b2..949c1c0f 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java
@@ -1022,7 +1022,7 @@ public class DefaultFileSystemManager implements
FileSystemManager {
}
/**
- * Set the cache strategy to use when dealing with file object data.
+ * Sets the cache strategy to use when dealing with file object data.
* <p>
* Can only be set before the FileSystemManager is initialized.
* </p>
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystemConfigBuilder.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystemConfigBuilder.java
index 2a71806b..6aa81bea 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystemConfigBuilder.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystemConfigBuilder.java
@@ -434,7 +434,7 @@ public class FtpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
/**
* Sets the control keep alive timeout for the FTP client.
* <p>
- * Set the {@code controlKeepAliveTimeout} to ensure the socket be alive
after download huge file.
+ * Sets the {@code controlKeepAliveTimeout} to ensure the socket be alive
after download huge file.
* </p>
*
* @param options The FileSystem options.
@@ -446,7 +446,7 @@ public class FtpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
}
/**
- * Set the data timeout for the FTP client.
+ * Sets the data timeout for the FTP client.
* <p>
* If you set the {@code dataTimeout} to {@code null}, no dataTimeout will
be set on the FTP client.
* </p>
@@ -460,7 +460,7 @@ public class FtpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
}
/**
- * Set the data timeout for the FTP client.
+ * Sets the data timeout for the FTP client.
* <p>
* If you set the {@code dataTimeout} to {@code null}, no dataTimeout will
be set on the FTP client.
* </p>
@@ -475,7 +475,7 @@ public class FtpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
}
/**
- * Set the default date format used by the server. See {@link
org.apache.commons.net.ftp.FTPClientConfig} for
+ * Sets the default date format used by the server. See {@link
org.apache.commons.net.ftp.FTPClientConfig} for
* details and examples.
*
* @param options The FileSystemOptions.
@@ -486,7 +486,7 @@ public class FtpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
}
/**
- * Set the FQCN of your FileEntryParser used to parse the directory
listing from your server.
+ * Sets the FQCN of your FileEntryParser used to parse the directory
listing from your server.
* <p>
* If you do not use the default commons-net FTPFileEntryParserFactory
e.g. by using {@link #setEntryParserFactory}
* this is the "key" parameter passed as argument into your custom factory.
@@ -587,7 +587,7 @@ public class FtpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
}
/**
- * Set the language code used by the server. See {@link
org.apache.commons.net.ftp.FTPClientConfig} for details and
+ * Sets the language code used by the server. See {@link
org.apache.commons.net.ftp.FTPClientConfig} for details and
* examples.
*
* @param options The FileSystemOptions.
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileSystemConfigBuilder.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileSystemConfigBuilder.java
index b38e11e8..a9b64ce6 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileSystemConfigBuilder.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileSystemConfigBuilder.java
@@ -480,7 +480,7 @@ public class Http4FileSystemConfigBuilder extends
FileSystemConfigBuilder {
}
/**
- * Set keystore file path for SSL connections.
+ * Sets keystore file path for SSL connections.
* @param opts the file system options to modify
* @param keyStoreFile keystore file path
*/
@@ -489,7 +489,7 @@ public class Http4FileSystemConfigBuilder extends
FileSystemConfigBuilder {
}
/**
- * Set keystore pass phrase for SSL connections.
+ * Sets keystore pass phrase for SSL connections.
* @param opts the file system options to modify
* @param keyStorePass keystore pass phrase for SSL connections
*/
@@ -498,7 +498,7 @@ public class Http4FileSystemConfigBuilder extends
FileSystemConfigBuilder {
}
/**
- * Set keystore type for SSL connections.
+ * Sets keystore type for SSL connections.
* @param opts the file system options to modify
* @param keyStoreType keystore type for SSL connections
* @since 2.7.0
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystemConfigBuilder.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystemConfigBuilder.java
index 5c128209..0d0c0934 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystemConfigBuilder.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystemConfigBuilder.java
@@ -513,7 +513,7 @@ public class Http5FileSystemConfigBuilder extends
FileSystemConfigBuilder {
}
/**
- * Set keystore file path for SSL connections.
+ * Sets keystore file path for SSL connections.
* @param opts the file system options to modify
* @param keyStoreFile keystore file path
*/
@@ -522,7 +522,7 @@ public class Http5FileSystemConfigBuilder extends
FileSystemConfigBuilder {
}
/**
- * Set keystore pass phrase for SSL connections.
+ * Sets keystore pass phrase for SSL connections.
* @param opts the file system options to modify
* @param keyStorePass keystore pass phrase for SSL connections
*/
@@ -531,7 +531,7 @@ public class Http5FileSystemConfigBuilder extends
FileSystemConfigBuilder {
}
/**
- * Set keystore type for SSL connections.
+ * Sets keystore type for SSL connections.
* @param opts the file system options to modify
* @param keyStoreType keystore type for SSL connections
* @since 2.7.0
