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 2024/08/12 11:11:55 UTC
(commons-vfs) 03/06: Javadoc
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
commit ffa024643d62ee99ff61387f7531a5fb8c59fa1b
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 11 10:11:42 2024 -0400
Javadoc
---
.../org/apache/commons/vfs2/tasks/AbstractSyncTask.java | 6 ++++++
commons-vfs2-distribution/src/assembly/bin.xml | 11 +++++------
.../commons/vfs2/provider/webdav/WebdavFileObject.java | 15 +++++++++++++--
.../commons/vfs2/provider/webdav/WebdavFileSystem.java | 12 ++++++++++--
.../commons/vfs2/provider/webdav4/Webdav4FileSystem.java | 8 ++++++++
.../org/apache/commons/vfs2/FileSystemConfigBuilder.java | 2 +-
.../apache/commons/vfs2/filter/SizeRangeFileFilter.java | 9 ++++++---
.../apache/commons/vfs2/provider/http/HttpFileObject.java | 11 +++++++++--
.../apache/commons/vfs2/provider/http/HttpFileSystem.java | 15 +++++++++++----
.../commons/vfs2/provider/http4/Http4FileSystem.java | 2 +-
.../vfs2/provider/sftp/SftpFileSystemConfigBuilder.java | 4 ++++
.../apache/commons/vfs2/provider/zip/ZipFileSystem.java | 4 ++++
.../vfs2/provider/zip/ZipFileSystemConfigBuilder.java | 3 +++
13 files changed, 81 insertions(+), 21 deletions(-)
diff --git a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java
index 1be3a934..9aaaf1be 100644
--- a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java
+++ b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java
@@ -349,6 +349,12 @@ public abstract class AbstractSyncTask extends VfsTask {
return failOnError;
}
+ /**
+ * Logs a message or throws a {@link BuildException} depending on {@link #isFailonerror()}.
+ *
+ * @param message The message to using in logging or BuildException.
+ * @param level The log level.
+ */
protected void logOrDie(final String message, final int level) {
if (!isFailonerror()) {
log(message, level);
diff --git a/commons-vfs2-distribution/src/assembly/bin.xml b/commons-vfs2-distribution/src/assembly/bin.xml
index 40e6f176..e6120b9b 100644
--- a/commons-vfs2-distribution/src/assembly/bin.xml
+++ b/commons-vfs2-distribution/src/assembly/bin.xml
@@ -22,11 +22,9 @@ limitations under the License.
<format>tar.gz</format>
<format>zip</format>
</formats>
- <includeBaseDirectory>false</includeBaseDirectory>
<includeSiteDirectory>false</includeSiteDirectory>
- <moduleSets>
- <moduleSet>
- <useAllReactorProjects>false</useAllReactorProjects>
+ <dependencySets>
+ <dependencySet>
<includes>
<include>org.apache.commons:commons-vfs2</include>
<include>org.apache.commons:commons-vfs2-ant</include>
@@ -36,8 +34,9 @@ limitations under the License.
<include>org.apache.commons:commons-vfs2-jackrabbit2</include>
<include>org.apache.commons:commons-vfs2-bom</include>
</includes>
- </moduleSet>
- </moduleSets>
+ <useProjectArtifact>false</useProjectArtifact>
+ </dependencySet>
+ </dependencySets>
<fileSets>
<fileSet>
<directory>..</directory>
diff --git a/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileObject.java b/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileObject.java
index 92da12fe..c1dbc20c 100644
--- a/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileObject.java
+++ b/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileObject.java
@@ -224,12 +224,23 @@ public class WebdavFileObject extends HttpFileObject<WebdavFileSystem> {
private final WebdavFileSystem fileSystem;
- protected WebdavFileObject(final AbstractFileName name, final WebdavFileSystem fileSystem) {
- super(name, fileSystem, WebdavFileSystemConfigBuilder.getInstance());
+ /**
+ * Constructs a new instance.
+ *
+ * @param fileName the file name.
+ * @param fileSystem the file system.
+ */
+ protected WebdavFileObject(final AbstractFileName fileName, final WebdavFileSystem fileSystem) {
+ super(fileName, fileSystem, WebdavFileSystemConfigBuilder.getInstance());
this.fileSystem = fileSystem;
builder = (WebdavFileSystemConfigBuilder) WebdavFileSystemConfigBuilder.getInstance();
}
+ /**
+ * Configures the given HttpMethodBase.
+ *
+ * @param httpMethod The HttpMethodBase to configure.
+ */
protected void configureMethod(final HttpMethodBase httpMethod) {
httpMethod.getParams().setParameter(HttpMethodParams.RETRY_HANDLER, WebdavMethodRetryHandler.getInstance());
}
diff --git a/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileSystem.java b/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileSystem.java
index eabef20d..ff40765c 100644
--- a/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileSystem.java
+++ b/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileSystem.java
@@ -27,6 +27,7 @@ import org.apache.commons.vfs2.provider.AbstractFileName;
import org.apache.commons.vfs2.provider.DefaultURLStreamHandler;
import org.apache.commons.vfs2.provider.GenericFileName;
import org.apache.commons.vfs2.provider.http.HttpFileSystem;
+import org.apache.http.client.protocol.HttpClientContext;
/**
* A WebDAV file system.
@@ -35,9 +36,16 @@ import org.apache.commons.vfs2.provider.http.HttpFileSystem;
*/
public class WebdavFileSystem extends HttpFileSystem {
- protected WebdavFileSystem(final GenericFileName rootName, final HttpClient client,
+ /**
+ * Constructs a new instance.
+ *
+ * @param rootName root base name
+ * @param httpClient {@link HttpClient} instance
+ * @param fileSystemOptions Options to build this file system.
+ */
+ protected WebdavFileSystem(final GenericFileName rootName, final HttpClient httpClient,
final FileSystemOptions fileSystemOptions) {
- super(rootName, client, fileSystemOptions);
+ super(rootName, httpClient, fileSystemOptions);
}
/**
diff --git a/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileSystem.java b/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileSystem.java
index ecdffeef..e8453725 100644
--- a/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileSystem.java
+++ b/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileSystem.java
@@ -36,6 +36,14 @@ import org.apache.http.client.protocol.HttpClientContext;
*/
public class Webdav4FileSystem extends Http4FileSystem {
+ /**
+ * Constructs a new instance.
+ *
+ * @param rootName root base name
+ * @param fileSystemOptions file system options
+ * @param httpClient {@link HttpClient} instance
+ * @param httpClientContext {@link HttpClientContext} instance
+ */
protected Webdav4FileSystem(final FileName rootName, final FileSystemOptions fileSystemOptions,
final HttpClient httpClient, final HttpClientContext httpClientContext) {
super(rootName, fileSystemOptions, httpClient, httpClientContext);
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemConfigBuilder.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemConfigBuilder.java
index 45410772..ca19c824 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemConfigBuilder.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemConfigBuilder.java
@@ -24,7 +24,7 @@ import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.time.DurationUtils;
/**
- * Abstract class which has the right to fill FileSystemOptions.
+ * Abstracts configuring {@link FileSystemOptions}s.
*/
public abstract class FileSystemConfigBuilder {
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SizeRangeFileFilter.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SizeRangeFileFilter.java
index 18104f39..ecaf386b 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SizeRangeFileFilter.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SizeRangeFileFilter.java
@@ -32,7 +32,10 @@ public class SizeRangeFileFilter implements FileFilter, Serializable {
private static final long serialVersionUID = 1L;
- private final FileFilter filter;
+ /**
+ * File filter for min/max.
+ */
+ private final FileFilter fileFilter;
/**
* Constructor with sizes.
@@ -43,12 +46,12 @@ public class SizeRangeFileFilter implements FileFilter, Serializable {
public SizeRangeFileFilter(final long minSizeInclusive, final long maxSizeInclusive) {
final FileFilter minimumFilter = new SizeFileFilter(minSizeInclusive, true);
final FileFilter maximumFilter = new SizeFileFilter(maxSizeInclusive + 1L, false);
- filter = new AndFileFilter(minimumFilter, maximumFilter);
+ fileFilter = new AndFileFilter(minimumFilter, maximumFilter);
}
@Override
public boolean accept(final FileSelectInfo fileSelectInfo) throws FileSystemException {
- return filter.accept(fileSelectInfo);
+ return fileFilter.accept(fileSelectInfo);
}
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileObject.java
index 125ba18c..b10189cb 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileObject.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileObject.java
@@ -86,9 +86,16 @@ public class HttpFileObject<FS extends HttpFileSystem> extends AbstractFileObjec
this(name, fileSystem, HttpFileSystemConfigBuilder.getInstance());
}
- protected HttpFileObject(final AbstractFileName name, final FS fileSystem,
+ /**
+ * Constructs a new instance.
+ *
+ * @param fileName the file name.
+ * @param fileSystem the file system.
+ * @param builder Configuration options for HTTP.
+ */
+ protected HttpFileObject(final AbstractFileName fileName, final FS fileSystem,
final HttpFileSystemConfigBuilder builder) {
- super(name, fileSystem);
+ super(fileName, fileSystem);
final FileSystemOptions fileSystemOptions = fileSystem.getFileSystemOptions();
urlCharset = builder.getUrlCharset(fileSystemOptions);
userAgent = builder.getUserAgent(fileSystemOptions);
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystem.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystem.java
index 0acb38e2..c59a5876 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystem.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystem.java
@@ -36,12 +36,19 @@ import org.apache.commons.vfs2.provider.GenericFileName;
@Deprecated
public class HttpFileSystem extends AbstractFileSystem {
- private final HttpClient client;
+ private final HttpClient httpClient;
- protected HttpFileSystem(final GenericFileName rootName, final HttpClient client,
+ /**
+ * Constructs a new instance.
+ *
+ * @param rootName root base name
+ * @param httpClient {@link HttpClient} instance
+ * @param fileSystemOptions Options to build this file system.
+ */
+ protected HttpFileSystem(final GenericFileName rootName, final HttpClient httpClient,
final FileSystemOptions fileSystemOptions) {
super(rootName, null, fileSystemOptions);
- this.client = client;
+ this.httpClient = httpClient;
}
/**
@@ -72,6 +79,6 @@ public class HttpFileSystem extends AbstractFileSystem {
}
protected HttpClient getClient() {
- return client;
+ return httpClient;
}
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileSystem.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileSystem.java
index e3b72355..b18da8c3 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileSystem.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileSystem.java
@@ -55,7 +55,7 @@ public class Http4FileSystem extends AbstractFileSystem {
private final HttpClientContext httpClientContext;
/**
- * Constructs {@code Http4FileSystem}.
+ * Constructs a new instance.
*
* @param rootName root base name
* @param fileSystemOptions file system options
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java
index c6641c19..be4539d5 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java
@@ -39,11 +39,15 @@ public final class SftpFileSystemConfigBuilder extends FileSystemConfigBuilder {
* Proxy type.
*/
public static final class ProxyType implements Serializable, Comparable<ProxyType> {
+
/**
* serialVersionUID format is YYYYMMDD for the date of the last binary change.
*/
private static final long serialVersionUID = 20101208L;
+ /**
+ * The proxy type.
+ */
private final String proxyType;
private ProxyType(final String proxyType) {
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileSystem.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileSystem.java
index 7eb5d8bb..2389ad61 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileSystem.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileSystem.java
@@ -123,6 +123,10 @@ public class ZipFileSystem extends AbstractFileSystem {
}
}
+ /**
+ * Gets the Charset.
+ * @return the Charset.
+ */
protected Charset getCharset() {
return charset;
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileSystemConfigBuilder.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileSystemConfigBuilder.java
index f22eeae7..0c0b7c7f 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileSystemConfigBuilder.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileSystemConfigBuilder.java
@@ -23,6 +23,9 @@ import org.apache.commons.vfs2.FileSystem;
import org.apache.commons.vfs2.FileSystemConfigBuilder;
import org.apache.commons.vfs2.FileSystemOptions;
+/**
+ * Configures {@link FileSystemOptions}s.
+ */
public class ZipFileSystemConfigBuilder extends FileSystemConfigBuilder {
private static final String PREFIX = ZipFileSystemConfigBuilder.class.getName();