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 c14433f4 Javadoc
c14433f4 is described below
commit c14433f4244c15a8168078ea7bcb6157e09caaf4
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Jan 17 10:18:47 2024 -0500
Javadoc
---
.../java/org/apache/commons/vfs2/provider/DelegateFileObject.java | 2 +-
.../org/apache/commons/vfs2/provider/http4/Http4FileObject.java | 6 +++---
.../org/apache/commons/vfs2/provider/http4/Http4FileSystem.java | 6 +++---
.../commons/vfs2/provider/http4/Http4FileSystemConfigBuilder.java | 4 ++--
.../org/apache/commons/vfs2/provider/http5/Http5FileObject.java | 6 +++---
.../org/apache/commons/vfs2/provider/http5/Http5FileSystem.java | 6 +++---
.../commons/vfs2/provider/http5/Http5FileSystemConfigBuilder.java | 4 ++--
.../java/org/apache/commons/vfs2/provider/jar/JarFileObject.java | 2 +-
.../java/org/apache/commons/vfs2/provider/zip/ZipFileProvider.java | 2 +-
.../src/main/java/org/apache/commons/vfs2/util/CryptorFactory.java | 2 +-
.../main/java/org/apache/commons/vfs2/util/PosixPermissions.java | 2 +-
11 files changed, 21 insertions(+), 21 deletions(-)
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java
index 2eec50ee..b1479347 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java
@@ -141,7 +141,7 @@ public class DelegateFileObject<AFS extends
AbstractFileSystem> extends Abstract
}
/**
- * Return file content info.
+ * Gets file content info.
*
* @return the file content info of the delegee.
* @throws Exception Any thrown Exception is wrapped in
FileSystemException.
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileObject.java
index c8d890c6..ae1801f0 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileObject.java
@@ -198,7 +198,7 @@ public class Http4FileObject<FS extends Http4FileSystem>
extends AbstractFileObj
}
/**
- * Return the internal {@code URI} object mapped to this file object.
+ * Gets the internal {@code URI} object mapped to this file object.
*
* @return the internal {@code URI} object mapped to this file object
*/
@@ -207,7 +207,7 @@ public class Http4FileObject<FS extends Http4FileSystem>
extends AbstractFileObj
}
/**
- * Return the last executed HEAD {@code HttpResponse} object.
+ * Gets the last executed HEAD {@code HttpResponse} object.
*
* @return the last executed HEAD {@code HttpResponse} object
* @throws IOException if IO error occurs
@@ -221,7 +221,7 @@ public class Http4FileObject<FS extends Http4FileSystem>
extends AbstractFileObj
}
/**
- * Return URL charset string.
+ * Gets URL charset string.
* @return URL charset string
*/
protected String getUrlCharset() {
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 01811f46..e3b72355 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
@@ -97,7 +97,7 @@ public class Http4FileSystem extends AbstractFileSystem {
}
/**
- * Return the internal {@link HttpClient} instance.
+ * Gets the internal {@link HttpClient} instance.
*
* @return the internal {@link HttpClient} instance
*/
@@ -106,7 +106,7 @@ public class Http4FileSystem extends AbstractFileSystem {
}
/**
- * Return the internal {@link HttpClientContext} instance.
+ * Gets the internal {@link HttpClientContext} instance.
*
* @return the internal {@link HttpClientContext} instance
*/
@@ -115,7 +115,7 @@ public class Http4FileSystem extends AbstractFileSystem {
}
/**
- * Return the internal base {@code URI} instance.
+ * Gets the internal base {@code URI} instance.
*
* @return the internal base {@code URI} instance
*/
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 1241e3b6..e5db758d 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
@@ -251,7 +251,7 @@ public class Http4FileSystemConfigBuilder extends
FileSystemConfigBuilder {
}
/**
- * Return keystore file path to be used in SSL connections.
+ * Gets keystore file path to be used in SSL connections.
* @param opts the file system options to modify
* @return keystore file path to be used in SSL connections
*/
@@ -259,7 +259,7 @@ public class Http4FileSystemConfigBuilder extends
FileSystemConfigBuilder {
return getParam(opts, KEYSTORE_FILE);
}
/**
- * Return keystore pass phrase for SSL connections.
+ * Gets keystore pass phrase for SSL connections.
* @param opts the file system options to modify
* @return keystore pass phrase for SSL connections
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java
index f98623c2..32f560de 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java
@@ -194,7 +194,7 @@ public class Http5FileObject<FS extends Http5FileSystem>
extends AbstractFileObj
}
/**
- * Return the internal {@code URI} object mapped to this file object.
+ * Gets the internal {@code URI} object mapped to this file object.
*
* @return the internal {@code URI} object mapped to this file object
*/
@@ -203,7 +203,7 @@ public class Http5FileObject<FS extends Http5FileSystem>
extends AbstractFileObj
}
/**
- * Return the last executed HEAD {@code HttpResponse} object.
+ * Gets the last executed HEAD {@code HttpResponse} object.
*
* @return the last executed HEAD {@code HttpResponse} object
* @throws IOException if IO error occurs
@@ -217,7 +217,7 @@ public class Http5FileObject<FS extends Http5FileSystem>
extends AbstractFileObj
}
/**
- * Return URL charset string.
+ * Gets URL charset string.
* @return URL charset string
*/
protected String getUrlCharset() {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystem.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystem.java
index e2f024e8..3432a1fb 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystem.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileSystem.java
@@ -95,7 +95,7 @@ public class Http5FileSystem extends AbstractFileSystem {
}
/**
- * Return the internal {@link HttpClient} instance.
+ * Gets the internal {@link HttpClient} instance.
*
* @return the internal {@link HttpClient} instance
*/
@@ -104,7 +104,7 @@ public class Http5FileSystem extends AbstractFileSystem {
}
/**
- * Return the internal {@link HttpClientContext} instance.
+ * Gets the internal {@link HttpClientContext} instance.
*
* @return the internal {@link HttpClientContext} instance
*/
@@ -113,7 +113,7 @@ public class Http5FileSystem extends AbstractFileSystem {
}
/**
- * Return the internal base {@code URI} instance.
+ * Gets the internal base {@code URI} instance.
*
* @return the internal base {@code URI} instance
*/
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 bd191bbc..4c9ce8f1 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
@@ -268,7 +268,7 @@ public class Http5FileSystemConfigBuilder extends
FileSystemConfigBuilder {
}
/**
- * Return keystore file path to be used in SSL connections.
+ * Gets keystore file path to be used in SSL connections.
* @param opts the file system options to modify
* @return keystore file path to be used in SSL connections
*/
@@ -277,7 +277,7 @@ public class Http5FileSystemConfigBuilder extends
FileSystemConfigBuilder {
}
/**
- * Return keystore pass phrase for SSL connections.
+ * Gets keystore pass phrase for SSL connections.
* @param opts the file system options to modify
* @return keystore pass phrase for SSL connections
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileObject.java
index 3dac1007..c189ee05 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileObject.java
@@ -82,7 +82,7 @@ public class JarFileObject extends ZipFileObject {
}
/**
- * Return the certificates of this JarEntry.
+ * Gets the certificates of this JarEntry.
*/
@Override
protected Certificate[] doGetCertificates() {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileProvider.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileProvider.java
index 1d8b336f..5f73f7ca 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileProvider.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileProvider.java
@@ -69,7 +69,7 @@ public class ZipFileProvider extends
AbstractLayeredFileProvider {
}
/**
- * Return config builder.
+ * Gets config builder.
*
* @return A config builder for ZipFileProvider.
* @see
org.apache.commons.vfs2.provider.AbstractFileProvider#getConfigBuilder()
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/CryptorFactory.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/CryptorFactory.java
index 2c03b551..7c8774fb 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/CryptorFactory.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/CryptorFactory.java
@@ -31,7 +31,7 @@ public final class CryptorFactory {
private static Cryptor instance;
/**
- * Return the Cryptor. If one has not been previously set, create it. The
Cryptor class can be set by setting the
+ * Gets the Cryptor. If one has not been previously set, create it. The
Cryptor class can be set by setting the
* "org.apache.commons.vfs2.cryptor" System property to the name of the
Cryptor class.
*
* @return The Cryptor.
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/PosixPermissions.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/PosixPermissions.java
index 67cf3131..ff7f88e0 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/PosixPermissions.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/PosixPermissions.java
@@ -87,7 +87,7 @@ public class PosixPermissions {
}
/**
- * Return the mask for this permission.
+ * Gets the mask for this permission.
*
* @return the mask for this permission.
*/
