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 2021/11/28 15:00:07 UTC
[commons-vfs] branch master updated: Fix Checkstyle MissingJavadocMethod.
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 29ade6a Fix Checkstyle MissingJavadocMethod.
29ade6a is described below
commit 29ade6a30c91087b20f334a43393db979605ae5f
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Nov 28 10:00:02 2021 -0500
Fix Checkstyle MissingJavadocMethod.
---
.../vfs2/provider/mime/MimeFileProvider.java | 3 ++
.../vfs2/provider/smb/SmbFileNameParser.java | 9 ++++++
.../org/apache/commons/vfs2/FileSystemOptions.java | 2 +-
.../src/main/java/org/apache/commons/vfs2/VFS.java | 12 ++++++-
.../org/apache/commons/vfs2/impl/Resource.java | 2 +-
.../commons/vfs2/provider/GenericURLFileName.java | 13 ++++++++
.../vfs2/provider/GenericURLFileNameParser.java | 5 +++
.../commons/vfs2/provider/HostFileNameParser.java | 14 +++++++-
.../vfs2/provider/LayeredFileNameParser.java | 4 +--
.../apache/commons/vfs2/provider/URLFileName.java | 13 ++++++++
.../commons/vfs2/provider/URLFileNameParser.java | 6 ++++
.../apache/commons/vfs2/provider/UriParser.java | 9 ++++++
.../vfs2/provider/ftp/FTPClientWrapper.java | 13 ++++++++
.../vfs2/provider/ftp/FtpClientFactory.java | 32 +++++++++++++++----
.../vfs2/provider/ftp/FtpFileNameParser.java | 8 +++++
.../provider/ftp/FtpFileSystemConfigBuilder.java | 7 ++++
.../vfs2/provider/ftps/FtpsFileProvider.java | 4 +++
.../vfs2/provider/gzip/GzipFileProvider.java | 3 ++
.../vfs2/provider/http/HttpClientFactory.java | 20 +++++++++---
.../vfs2/provider/http/HttpFileNameParser.java | 8 +++++
.../vfs2/provider/http4/Http4FileNameParser.java | 8 +++++
.../vfs2/provider/http4s/Http4sFileNameParser.java | 8 +++++
.../vfs2/provider/http5/Http5FileNameParser.java | 8 +++++
.../vfs2/provider/http5s/Http5sFileNameParser.java | 8 +++++
.../vfs2/provider/https/HttpsFileNameParser.java | 9 ++++++
.../vfs2/provider/https/HttpsFileProvider.java | 3 ++
.../commons/vfs2/provider/jar/JarFileProvider.java | 3 ++
.../vfs2/provider/jar/JarURLConnectionImpl.java | 37 +++++++++++++---------
.../commons/vfs2/provider/ram/RamFileSystem.java | 15 ++++++---
.../vfs2/provider/res/ResourceFileProvider.java | 3 ++
.../res/ResourceFileSystemConfigBuilder.java | 20 +++++++++---
.../vfs2/provider/sftp/BytesIdentityInfo.java | 17 +++++++++-
.../vfs2/provider/sftp/IdentityProvider.java | 6 ++++
.../vfs2/provider/sftp/SftpFileNameParser.java | 2 +-
.../provider/sftp/UserIsOwnerPosixPermissions.java | 5 +++
.../commons/vfs2/provider/tar/TarFileProvider.java | 3 ++
.../commons/vfs2/provider/tar/TarFileSystem.java | 7 ++++
.../vfs2/provider/tar/Tbz2FileProvider.java | 3 ++
.../commons/vfs2/provider/tar/TgzFileProvider.java | 3 ++
.../vfs2/provider/temp/TemporaryFileProvider.java | 9 +++++-
.../vfs2/provider/url/UrlFileNameParser.java | 3 ++
.../commons/vfs2/provider/url/UrlFileProvider.java | 3 ++
.../commons/vfs2/provider/zip/ZipFileProvider.java | 3 ++
.../provider/zip/ZipFileSystemConfigBuilder.java | 28 +++++++++++++---
.../commons/vfs2/tasks/AbstractSyncTask.java | 5 +++
.../commons/vfs2/util/CombinedResources.java | 10 ++++++
.../vfs2/util/MonitorRandomAccessContent.java | 5 +++
.../apache/commons/vfs2/util/RandomAccessMode.java | 10 ++++++
48 files changed, 383 insertions(+), 48 deletions(-)
diff --git a/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/mime/MimeFileProvider.java b/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/mime/MimeFileProvider.java
index 2e1a52b..3a49bfc 100644
--- a/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/mime/MimeFileProvider.java
+++ b/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/mime/MimeFileProvider.java
@@ -39,6 +39,9 @@ public class MimeFileProvider extends AbstractLayeredFileProvider implements Fil
.unmodifiableCollection(Arrays.asList(Capability.GET_TYPE, Capability.GET_LAST_MODIFIED, Capability.LIST_CHILDREN,
Capability.READ_CONTENT, Capability.URI, Capability.ATTRIBUTES));
+ /**
+ * Constructs a new instance.
+ */
public MimeFileProvider() {
}
diff --git a/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileNameParser.java b/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileNameParser.java
index c5adc20..877b164 100644
--- a/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileNameParser.java
+++ b/commons-vfs2-sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileNameParser.java
@@ -28,13 +28,22 @@ import org.apache.commons.vfs2.provider.VfsComponentContext;
* Implementation for sftp. set default port to 139
*/
public class SmbFileNameParser extends URLFileNameParser {
+
private static final SmbFileNameParser INSTANCE = new SmbFileNameParser();
private static final int SMB_PORT = 139;
+ /**
+ * Creates a new instance with the default port 139.
+ */
public SmbFileNameParser() {
super(SMB_PORT);
}
+ /**
+ * Gets the singleton instance.
+ *
+ * @return the singleton instance.
+ */
public static FileNameParser getInstance() {
return INSTANCE;
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemOptions.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemOptions.java
index c90a0f1..4ba1c0e 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemOptions.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemOptions.java
@@ -50,7 +50,7 @@ public final class FileSystemOptions implements Cloneable, Comparable<FileSystem
private final Map<FileSystemOptionKey, Object> options;
/**
- * Creates a new instance.
+ * Constructs a new instance.
*/
public FileSystemOptions() {
this(new TreeMap<>());
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/VFS.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/VFS.java
index 2b71859..a3b1b97 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/VFS.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/VFS.java
@@ -78,7 +78,7 @@ public final class VFS {
}
/**
- * Returns the default {@link FileSystemManager} instance.
+ * Gets the default {@link FileSystemManager} instance.
* <p>
* Warning, if you close this instance you may affect all current and future users of this manager singleton.
* </p>
@@ -93,6 +93,11 @@ public final class VFS {
return instance;
}
+ /**
+ * TODO.
+ *
+ * @return TODO.
+ */
public static boolean isUriStyle() {
if (uriStyle == null) {
uriStyle = Boolean.FALSE;
@@ -122,6 +127,11 @@ public final class VFS {
VFS.instance = manager;
}
+ /**
+ * TODO.
+ *
+ * @param uriStyle TODO.
+ */
public static void setUriStyle(final boolean uriStyle) {
if (VFS.uriStyle != null && VFS.uriStyle.booleanValue() != uriStyle) {
throw new IllegalStateException("VFS.uriStyle was already set differently.");
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/Resource.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/Resource.java
index 9979d2f..f5248d7 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/Resource.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/Resource.java
@@ -37,7 +37,7 @@ final class Resource {
private final String packageName;
/**
- * Creates a new instance.
+ * Constructs a new instance.
*
* @param root The code source FileObject.
* @param resource The resource of the FileObject.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericURLFileName.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericURLFileName.java
index 58ababe..482244f 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericURLFileName.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericURLFileName.java
@@ -30,6 +30,19 @@ public class GenericURLFileName extends GenericFileName {
private final String queryString;
+ /**
+ * Constructs a new instance.
+ *
+ * @param scheme Host scheme.
+ * @param hostName Host name or IP address.
+ * @param port Host port.
+ * @param defaultPort Default host port.
+ * @param userName user name.
+ * @param password user password.
+ * @param path Path on the host.
+ * @param type File type on the host.
+ * @param queryString Query string for the path.
+ */
public GenericURLFileName(final String scheme, final String hostName, final int port, final int defaultPort,
final String userName, final String password, final String path, final FileType type,
final String queryString) {
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericURLFileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericURLFileNameParser.java
index 9247e84..2c43467 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericURLFileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/GenericURLFileNameParser.java
@@ -28,6 +28,11 @@ import org.apache.commons.vfs2.FileType;
*/
public class GenericURLFileNameParser extends HostFileNameParser {
+ /**
+ * Constructs a new instance.
+ *
+ * @param defaultPort The default port.
+ */
public GenericURLFileNameParser(final int defaultPort) {
super(defaultPort);
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/HostFileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/HostFileNameParser.java
index d76270a..6065d4c 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/HostFileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/HostFileNameParser.java
@@ -33,10 +33,12 @@ import org.apache.commons.vfs2.util.CryptorFactory;
* @see URLFileNameParser URLFileNameParser for the implementation which also handles the query string too.
*/
public class HostFileNameParser extends AbstractFileNameParser {
+
/**
* Parsed authority info (scheme, hostname, username/password, port).
*/
protected static class Authority {
+
private String hostName;
private String password;
private int port;
@@ -146,7 +148,12 @@ public class HostFileNameParser extends AbstractFileNameParser {
private final int defaultPort;
- public HostFileNameParser(final int defaultPort) {
+ /**
+ * Constructs a new instance.
+ *
+ * @param defaultPort The default port.
+ */
+ public HostFileNameParser(final int defaultPort) {
this.defaultPort = defaultPort;
}
@@ -323,6 +330,11 @@ public class HostFileNameParser extends AbstractFileNameParser {
return null;
}
+ /**
+ * Gets the default port.
+ *
+ * @return the default port.
+ */
public int getDefaultPort() {
return defaultPort;
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/LayeredFileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/LayeredFileNameParser.java
index 6df4a47..8647913 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/LayeredFileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/LayeredFileNameParser.java
@@ -30,9 +30,9 @@ public class LayeredFileNameParser extends AbstractFileNameParser {
private static final LayeredFileNameParser INSTANCE = new LayeredFileNameParser();
/**
- * Returns the Parser.
+ * Gets the singleton instance.
*
- * @return The Parser.
+ * @return the singleton instance.
*/
public static LayeredFileNameParser getInstance() {
return INSTANCE;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileName.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileName.java
index 893502d..880e951 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileName.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileName.java
@@ -33,6 +33,19 @@ public class URLFileName extends GenericFileName {
private final String queryString;
+ /**
+ * Constructs a new instance.
+ *
+ * @param scheme The host scheme.
+ * @param hostName The host name or IP address.
+ * @param port The host port.
+ * @param defaultPort The default host port.
+ * @param userName The user name.
+ * @param password The user password.
+ * @param path The host path.
+ * @param type The file type on the host.
+ * @param queryString The query after the path.
+ */
public URLFileName(final String scheme, final String hostName, final int port, final int defaultPort,
final String userName, final String password, final String path, final FileType type,
final String queryString) {
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileNameParser.java
index a7cc833..9d8952a 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileNameParser.java
@@ -29,6 +29,12 @@ import org.apache.commons.vfs2.FileType;
*/
@Deprecated
public class URLFileNameParser extends HostFileNameParser {
+
+ /**
+ * Constructs a new instance.
+ *
+ * @param defaultPort The default port.
+ */
public URLFileNameParser(final int defaultPort) {
super(defaultPort);
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/UriParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/UriParser.java
index 66a56c4..9ba6d8e 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/UriParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/UriParser.java
@@ -66,6 +66,15 @@ public final class UriParser {
encodeRfc2396(buffer, offset, unencodedValue.length(), allowed);
}
+ /**
+ * Canonicalizes a path.
+ *
+ * @param buffer Source data.
+ * @param offset Where to start reading.
+ * @param length How much to read.
+ * @param fileNameParser Now to encode and decode.
+ * @throws FileSystemException If an I/O error occurs.
+ */
public static void canonicalizePath(final StringBuilder buffer, final int offset, final int length,
final FileNameParser fileNameParser) throws FileSystemException {
int index = offset;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FTPClientWrapper.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FTPClientWrapper.java
index 0fb5c42..37cb1ad 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FTPClientWrapper.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FTPClientWrapper.java
@@ -42,6 +42,9 @@ public class FTPClientWrapper implements FtpClient {
private static final Log LOG = LogFactory.getLog(FTPClientWrapper.class);
+ /**
+ * Authentication options.
+ */
protected final FileSystemOptions fileSystemOptions;
private FTPClient ftpClient;
private final GenericFileName root;
@@ -138,6 +141,11 @@ public class FTPClientWrapper implements FtpClient {
}
}
+ /**
+ * Gets the FileSystemOptions.
+ *
+ * @return the FileSystemOptions.
+ */
public FileSystemOptions getFileSystemOptions() {
return fileSystemOptions;
}
@@ -160,6 +168,11 @@ public class FTPClientWrapper implements FtpClient {
return getFtpClient().getReplyString();
}
+ /**
+ * Gets the root file name.
+ *
+ * @return the root file name.
+ */
public GenericFileName getRoot() {
return root;
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClientFactory.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClientFactory.java
index 3b072ce..dcdadcd 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClientFactory.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClientFactory.java
@@ -37,25 +37,31 @@ import org.apache.commons.vfs2.FileSystemOptions;
import org.apache.commons.vfs2.util.UserAuthenticatorUtils;
/**
- * Create a FtpClient instance.
+ * Creates {@link FtpClient} instances.
*/
public final class FtpClientFactory {
/**
* Abstract Factory, used to configure different FTPClients.
*
- * @param <C>
- * The type of FTPClient.
- * @param <B>
- * The type of FtpFileSystemConfigBuilder
+ * @param <C> The type of FTPClient.
+ * @param <B> The type of FtpFileSystemConfigBuilder
*/
public abstract static class ConnectionFactory<C extends FTPClient, B extends FtpFileSystemConfigBuilder> {
private static final char[] ANON_CHAR_ARRAY = "anonymous".toCharArray();
private static final int BUFSZ = 40;
private final Log log = LogFactory.getLog(getClass());
+ /**
+ * My builder.
+ */
protected B builder;
+ /**
+ * Constructs a new instance.
+ *
+ * @param builder How to build.
+ */
protected ConnectionFactory(final B builder) {
this.builder = builder;
}
@@ -99,6 +105,18 @@ public final class FtpClientFactory {
protected abstract C createClient(FileSystemOptions fileSystemOptions) throws FileSystemException;
+ /**
+ * Creates a connection.
+ *
+ * @param hostname The host name or IP address.
+ * @param port The host port.
+ * @param username The user name.
+ * @param password The user password.
+ * @param workingDirectory The working directory.
+ * @param fileSystemOptions Options to create the connection.
+ * @return A new connection.
+ * @throws FileSystemException if an error occurs while connecting.
+ */
public C createConnection(final String hostname, final int port, char[] username, char[] password,
final String workingDirectory, final FileSystemOptions fileSystemOptions) throws FileSystemException {
// Determine the username and password to use
@@ -237,7 +255,9 @@ public final class FtpClientFactory {
protected abstract void setupOpenConnection(C client, FileSystemOptions fileSystemOptions) throws IOException;
}
- /** Connection Factory, used to configure the FTPClient. */
+ /**
+ * Connection Factory, used to configure the FTPClient.
+ */
public static final class FtpConnectionFactory extends ConnectionFactory<FTPClient, FtpFileSystemConfigBuilder> {
private FtpConnectionFactory(final FtpFileSystemConfigBuilder builder) {
super(builder);
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileNameParser.java
index 4f03fdb..8f7e17e 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileNameParser.java
@@ -28,10 +28,18 @@ public class FtpFileNameParser extends HostFileNameParser {
private static final int PORT = 21;
+ /**
+ * Gets the singleton instance.
+ *
+ * @return the singleton instance.
+ */
public static FileNameParser getInstance() {
return INSTANCE;
}
+ /**
+ * Constructs a new instance with the default port.
+ */
public FtpFileNameParser() {
super(PORT);
}
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 b26f4b2..01e6e39 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
@@ -68,6 +68,13 @@ public class FtpFileSystemConfigBuilder extends FileSystemConfigBuilder {
return BUILDER;
}
+ /**
+ * Gets special retry code.
+ *
+ * See VFS-674, its accompanying PR and https://github.com/apache/commons-vfs/pull/51 as to why 426 and 550 are here.
+ *
+ * @return special retry code.
+ */
public static List<Integer> getSaneTransferAbortedOkReplyCodes() {
// See VFS-674, its accompanying PR and https://github.com/apache/commons-vfs/pull/51 as to why 426 and 550 are here
return new ArrayList<>(Arrays.asList(FTPReply.TRANSFER_ABORTED, FTPReply.FILE_UNAVAILABLE));
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileProvider.java
index 7c26c19..d4ad7c3 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileProvider.java
@@ -33,6 +33,10 @@ import org.apache.commons.vfs2.provider.ftp.FtpFileProvider;
* @since 2.0
*/
public class FtpsFileProvider extends FtpFileProvider {
+
+ /**
+ * Constructs a new instance.
+ */
public FtpsFileProvider() {
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileProvider.java
index 9c52fbe..235b7d7 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileProvider.java
@@ -39,6 +39,9 @@ public class GzipFileProvider extends CompressedFileFileProvider {
protected static final Collection<Capability> capabilities = Collections.unmodifiableCollection(Arrays.asList(Capability.GET_LAST_MODIFIED,
Capability.GET_TYPE, Capability.LIST_CHILDREN, Capability.WRITE_CONTENT, Capability.READ_CONTENT, Capability.URI, Capability.COMPRESS));
+ /**
+ * Constructs a new instance.
+ */
public GzipFileProvider() {
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpClientFactory.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpClientFactory.java
index 517a3a8..baa9db3 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpClientFactory.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpClientFactory.java
@@ -129,11 +129,21 @@ public final class HttpClientFactory {
return client;
}
- public static HttpClient createConnection(final String scheme, final String hostname, final int port,
- final String username, final String password, final FileSystemOptions fileSystemOptions)
- throws FileSystemException {
- return createConnection(HttpFileSystemConfigBuilder.getInstance(), scheme, hostname, port, username, password,
- fileSystemOptions);
+ /**
+ * Creates an HttpClient.
+ *
+ * @param scheme The host scheme.
+ * @param hostname The host name or IP address.
+ * @param port The host port.
+ * @param username The user name.
+ * @param password The user password.
+ * @param fileSystemOptions The file system options.
+ * @return a new HttpClient connection.
+ * @throws FileSystemException if an error occurs.
+ */
+ public static HttpClient createConnection(final String scheme, final String hostname, final int port, final String username, final String password,
+ final FileSystemOptions fileSystemOptions) throws FileSystemException {
+ return createConnection(HttpFileSystemConfigBuilder.getInstance(), scheme, hostname, port, username, password, fileSystemOptions);
}
private HttpClientFactory() {
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileNameParser.java
index 27111c2..31b1e1e 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileNameParser.java
@@ -28,10 +28,18 @@ public class HttpFileNameParser extends URLFileNameParser {
private static final HttpFileNameParser INSTANCE = new HttpFileNameParser();
+ /**
+ * Gets the singleton instance.
+ *
+ * @return the singleton instance.
+ */
public static FileNameParser getInstance() {
return INSTANCE;
}
+ /**
+ * Creates a new instance with the default port 80.
+ */
public HttpFileNameParser() {
super(DEFAULT_PORT);
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileNameParser.java
index a2d5c69..0c0b39d 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4/Http4FileNameParser.java
@@ -30,10 +30,18 @@ public class Http4FileNameParser extends GenericURLFileNameParser {
private static final Http4FileNameParser INSTANCE = new Http4FileNameParser();
+ /**
+ * Gets the singleton instance.
+ *
+ * @return the singleton instance.
+ */
public static FileNameParser getInstance() {
return INSTANCE;
}
+ /**
+ * Creates a new instance with the default port 80.
+ */
public Http4FileNameParser() {
super(DEFAULT_PORT);
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4s/Http4sFileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4s/Http4sFileNameParser.java
index 0291ade..38bb2eb 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4s/Http4sFileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http4s/Http4sFileNameParser.java
@@ -30,10 +30,18 @@ public class Http4sFileNameParser extends GenericURLFileNameParser {
private static final Http4sFileNameParser INSTANCE = new Http4sFileNameParser();
+ /**
+ * Gets the singleton instance.
+ *
+ * @return the singleton instance.
+ */
public static FileNameParser getInstance() {
return INSTANCE;
}
+ /**
+ * Creates a new instance with the default port 443.
+ */
public Http4sFileNameParser() {
super(DEFAULT_PORT);
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileNameParser.java
index 9d89597..a6e31f5 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileNameParser.java
@@ -30,10 +30,18 @@ public class Http5FileNameParser extends GenericURLFileNameParser {
private static final Http5FileNameParser INSTANCE = new Http5FileNameParser();
+ /**
+ * Gets the singleton instance.
+ *
+ * @return the singleton instance.
+ */
public static FileNameParser getInstance() {
return INSTANCE;
}
+ /**
+ * Creates a new instance with the default port 80.
+ */
public Http5FileNameParser() {
super(DEFAULT_PORT);
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5s/Http5sFileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5s/Http5sFileNameParser.java
index 9d4c7d8..8fdec7c 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5s/Http5sFileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5s/Http5sFileNameParser.java
@@ -30,10 +30,18 @@ public class Http5sFileNameParser extends GenericURLFileNameParser {
private static final Http5sFileNameParser INSTANCE = new Http5sFileNameParser();
+ /**
+ * Gets the singleton instance.
+ *
+ * @return the singleton instance.
+ */
public static FileNameParser getInstance() {
return INSTANCE;
}
+ /**
+ * Creates a new instance with the default port 443.
+ */
public Http5sFileNameParser() {
super(DEFAULT_PORT);
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/https/HttpsFileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/https/HttpsFileNameParser.java
index 11fb874..a157923 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/https/HttpsFileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/https/HttpsFileNameParser.java
@@ -23,14 +23,23 @@ import org.apache.commons.vfs2.provider.URLFileNameParser;
* Implementation for https. set default port to 443.
*/
public class HttpsFileNameParser extends URLFileNameParser {
+
private static final int DEFAULT_PORT = 443;
private static final HttpsFileNameParser INSTANCE = new HttpsFileNameParser();
+ /**
+ * Gets the singleton instance.
+ *
+ * @return the singleton instance.
+ */
public static FileNameParser getInstance() {
return INSTANCE;
}
+ /**
+ * Creates a new instance with the default port 443.
+ */
public HttpsFileNameParser() {
super(DEFAULT_PORT);
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/https/HttpsFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/https/HttpsFileProvider.java
index a4165e1..05ed1df 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/https/HttpsFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/https/HttpsFileProvider.java
@@ -23,6 +23,9 @@ import org.apache.commons.vfs2.provider.http.HttpFileProvider;
*/
public class HttpsFileProvider extends HttpFileProvider {
+ /**
+ * Constructs a new instance.
+ */
public HttpsFileProvider() {
setFileNameParser(HttpsFileNameParser.getInstance());
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileProvider.java
index a2393c3..274640a 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarFileProvider.java
@@ -47,6 +47,9 @@ public class JarFileProvider extends ZipFileProvider {
CAPABILITIES = Collections.unmodifiableCollection(combined);
}
+ /**
+ * Constructs a new instance.
+ */
public JarFileProvider() {
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarURLConnectionImpl.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarURLConnectionImpl.java
index cd45d87..4fe5b0e 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarURLConnectionImpl.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/jar/JarURLConnectionImpl.java
@@ -39,21 +39,28 @@ public class JarURLConnectionImpl extends JarURLConnection {
// This is because JarURLConnection SUCKS
private static final String HACK_URL = "jar:http://somehost/somejar.jar!/";
- private final FileContent content;
+ private final FileContent fileContent;
private final URL parentURL;
- private final JarFileObject file;
+ private final JarFileObject jarFileObject;
private final String entryName;
- public JarURLConnectionImpl(final JarFileObject file, final FileContent content)
- throws MalformedURLException, FileSystemException {
+ /**
+ * Constructs a new instance.
+ *
+ * @param jarFileObject The JAR file.
+ * @param fileContent THe JAR file contents.
+ * @throws MalformedURLException Should not happen.
+ * @throws FileSystemException if an error occurs accessing the JAR file.
+ */
+ public JarURLConnectionImpl(final JarFileObject jarFileObject, final FileContent fileContent) throws MalformedURLException, FileSystemException {
// This is because JarURLConnection SUCKS!!
super(new URL(HACK_URL));
- this.url = file.getURL();
- this.content = content;
- this.parentURL = file.getURL();
- this.entryName = file.getName().getPath();
- this.file = file;
+ this.url = jarFileObject.getURL();
+ this.fileContent = fileContent;
+ this.parentURL = jarFileObject.getURL();
+ this.entryName = jarFileObject.getName().getPath();
+ this.jarFileObject = jarFileObject;
}
@Override
@@ -73,7 +80,7 @@ public class JarURLConnectionImpl extends JarURLConnection {
@Override
public Manifest getManifest() throws IOException {
- return file.getManifest();
+ return jarFileObject.getManifest();
}
@Override
@@ -83,12 +90,12 @@ public class JarURLConnectionImpl extends JarURLConnection {
@Override
public Attributes getAttributes() throws IOException {
- return file.getAttributes();
+ return jarFileObject.getAttributes();
}
@Override
public Certificate[] getCertificates() {
- return file.doGetCertificates();
+ return jarFileObject.doGetCertificates();
}
@Override
@@ -98,18 +105,18 @@ public class JarURLConnectionImpl extends JarURLConnection {
@Override
public InputStream getInputStream() throws IOException {
- return content.getInputStream();
+ return fileContent.getInputStream();
}
@Override
public OutputStream getOutputStream() throws IOException {
- return content.getOutputStream();
+ return fileContent.getOutputStream();
}
@Override
public int getContentLength() {
try {
- return (int) content.getSize();
+ return (int) fileContent.getSize();
} catch (final FileSystemException ignored) {
return -1;
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileSystem.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileSystem.java
index 7a39fd5..49dd185 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileSystem.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileSystem.java
@@ -168,15 +168,20 @@ public class RamFileSystem extends AbstractFileSystem implements Serializable {
this.delete(from);
}
- public void attach(final RamFileObject fo) {
- if (fo.getName() == null) {
+ /**
+ * Attaches this instance to the given RamFileObject.
+ *
+ * @param ramFileObject A RAM file object.
+ */
+ public void attach(final RamFileObject ramFileObject) {
+ if (ramFileObject.getName() == null) {
throw new IllegalArgumentException("Null argument");
}
- RamFileData data = this.cache.get(fo.getName());
+ RamFileData data = this.cache.get(ramFileObject.getName());
if (data == null) {
- data = new RamFileData(fo.getName());
+ data = new RamFileData(ramFileObject.getName());
}
- fo.setData(data);
+ ramFileObject.setData(data);
}
/**
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileProvider.java
index e43c2dc..0be1cda 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileProvider.java
@@ -39,6 +39,9 @@ public class ResourceFileProvider extends AbstractFileProvider {
protected static final Collection<Capability> capabilities = Collections
.unmodifiableCollection(Arrays.asList(Capability.DISPATCHER));
+ /**
+ * Constructs a new instance.
+ */
public ResourceFileProvider() {
setFileNameParser(ResourceFileNameParser.getInstance());
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileSystemConfigBuilder.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileSystemConfigBuilder.java
index 143f505..27e233b 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileSystemConfigBuilder.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/res/ResourceFileSystemConfigBuilder.java
@@ -41,12 +41,24 @@ public final class ResourceFileSystemConfigBuilder extends FileSystemConfigBuild
return BUILDER;
}
- public void setClassLoader(final FileSystemOptions opts, final ClassLoader classLoader) {
- setParam(opts, ClassLoader.class.getName(), classLoader);
+ /**
+ * Sets the class loader in the FileSystemOptions.
+ *
+ * @param fileSystemOptions Target FileSystemOptions.
+ * @param classLoader The data to set.
+ */
+ public void setClassLoader(final FileSystemOptions fileSystemOptions, final ClassLoader classLoader) {
+ setParam(fileSystemOptions, ClassLoader.class.getName(), classLoader);
}
- public ClassLoader getClassLoader(final FileSystemOptions opts) {
- return getParam(opts, ClassLoader.class.getName());
+ /**
+ * Gets the class loader from the FileSystemOptions.
+ *
+ * @param fileSystemOptions The source FileSystemOptions.
+ * @return the class loader from the FileSystemOptions.
+ */
+ public ClassLoader getClassLoader(final FileSystemOptions fileSystemOptions) {
+ return getParam(fileSystemOptions, ClassLoader.class.getName());
}
@Override
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/BytesIdentityInfo.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/BytesIdentityInfo.java
index eeeeb95..07b1794 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/BytesIdentityInfo.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/BytesIdentityInfo.java
@@ -49,7 +49,7 @@ public class BytesIdentityInfo implements IdentityProvider {
* Constructs an identity info with private and public key and passphrase for the private key.
*
* @param privateKey Private key bytes
- * @param publicKey The public key part used for connections with exchange of certificates (can be {@code null})
+ * @param publicKey The public key part used for connections with exchange of certificates (can be {@code null})
* @param passPhrase The passphrase to decrypt the private key (can be {@code null} if no passphrase is used)
*/
public BytesIdentityInfo(final byte[] privateKey, final byte[] publicKey, final byte[] passPhrase) {
@@ -63,14 +63,29 @@ public class BytesIdentityInfo implements IdentityProvider {
jsch.addIdentity("PrivateKey", privateKey, publicKey, passPhrase);
}
+ /**
+ * Gets the passphrase.
+ *
+ * @return the passphrase.
+ */
public byte[] getPassPhrase() {
return passPhrase;
}
+ /**
+ * Gets the private key.
+ *
+ * @return the private key.
+ */
public byte[] getPrivateKeyBytes() {
return privateKey;
}
+ /**
+ * Gets the public key.
+ *
+ * @return the public key.
+ */
public byte[] getPublicKeyBytes() {
return publicKey;
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/IdentityProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/IdentityProvider.java
index d90d5f3..97bd4e7 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/IdentityProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/IdentityProvider.java
@@ -27,6 +27,12 @@ import com.jcraft.jsch.JSchException;
*/
public interface IdentityProvider {
+ /**
+ * Add this identity to the given JSch.
+ *
+ * @param jsch Target JSch.
+ * @throws JSchException If I/O error occurs.
+ */
void addIdentity(JSch jsch) throws JSchException;
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileNameParser.java
index 769da95..a307b8b 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileNameParser.java
@@ -38,7 +38,7 @@ public class SftpFileNameParser extends URLFileNameParser {
}
/**
- * Creates a new instance with a the default port 22.
+ * Creates a new instance with the default port 22.
*/
public SftpFileNameParser() {
super(DEFAULT_PORT);
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/UserIsOwnerPosixPermissions.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/UserIsOwnerPosixPermissions.java
index 35c1085..caece9b 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/UserIsOwnerPosixPermissions.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/UserIsOwnerPosixPermissions.java
@@ -23,6 +23,11 @@ import org.apache.commons.vfs2.util.PosixPermissions;
*/
public class UserIsOwnerPosixPermissions extends PosixPermissions {
+ /**
+ * Constructs a new instance.
+ *
+ * @param permissions permission bits.
+ */
public UserIsOwnerPosixPermissions(final int permissions) {
super(permissions, true, true);
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileProvider.java
index 94d14d2..2d48d2a 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileProvider.java
@@ -41,6 +41,9 @@ public class TarFileProvider extends AbstractLayeredFileProvider {
.unmodifiableCollection(Arrays.asList(Capability.GET_LAST_MODIFIED, Capability.GET_TYPE, Capability.LIST_CHILDREN,
Capability.READ_CONTENT, Capability.URI, Capability.VIRTUAL));
+ /**
+ * Constructs a new instance.
+ */
public TarFileProvider() {
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileSystem.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileSystem.java
index 7f169a8..df472d4 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileSystem.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileSystem.java
@@ -135,6 +135,13 @@ public class TarFileSystem extends AbstractFileSystem {
return cache.get(name);
}
+ /**
+ * Returns the input stream for the given entry.
+ *
+ * @param entry The entry to seek.
+ * @return the input stream for the given entry.
+ * @throws FileSystemException If an I/O error occurs.
+ */
public InputStream getInputStream(final TarArchiveEntry entry) throws FileSystemException {
Objects.requireNonNull(entry, "entry");
resetTarFile();
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/Tbz2FileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/Tbz2FileProvider.java
index 3074c08..c23da1b 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/Tbz2FileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/Tbz2FileProvider.java
@@ -31,6 +31,9 @@ public class Tbz2FileProvider extends CompositeFileProvider {
private static final String[] SCHEMES = {"bz2", "tar"};
+ /**
+ * Constructs a new instance.
+ */
public Tbz2FileProvider() {
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TgzFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TgzFileProvider.java
index a526b8b..3ee0645 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TgzFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TgzFileProvider.java
@@ -31,6 +31,9 @@ public class TgzFileProvider extends CompositeFileProvider {
private static final String[] SCHEMES = {"gz", "tar"};
+ /**
+ * Constructs a new instance.
+ */
public TgzFileProvider() {
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/temp/TemporaryFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/temp/TemporaryFileProvider.java
index a057527..1bda799 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/temp/TemporaryFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/temp/TemporaryFileProvider.java
@@ -44,12 +44,19 @@ public class TemporaryFileProvider extends AbstractFileProvider implements Compa
* protected void appendRootUri(StringBuffer buffer) { } };
*/
+ /**
+ * Constructs a new instance.
+ *
+ * @param rootFile The root file.
+ */
public TemporaryFileProvider(final File rootFile) {
this();
-
this.rootFile = rootFile;
}
+ /**
+ * Constructs a new instance.
+ */
public TemporaryFileProvider() {
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileNameParser.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileNameParser.java
index 350bb7c..80046bb 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileNameParser.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileNameParser.java
@@ -34,6 +34,9 @@ public class UrlFileNameParser extends AbstractFileNameParser {
private final URLFileNameParser urlFileNameParser = new URLFileNameParser(80);
private final GenericFileNameParser genericFileNameParser = new GenericFileNameParser();
+ /**
+ * Constructs a new instance.
+ */
public UrlFileNameParser() {
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileProvider.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileProvider.java
index 237f5e8..129965c 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileProvider.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileProvider.java
@@ -39,6 +39,9 @@ public class UrlFileProvider extends AbstractFileProvider {
protected static final Collection<Capability> capabilities = Collections.unmodifiableCollection(
Arrays.asList(Capability.READ_CONTENT, Capability.URI, Capability.GET_LAST_MODIFIED));
+ /**
+ * Constructs a new instance.
+ */
public UrlFileProvider() {
setFileNameParser(new UrlFileNameParser());
}
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 c89dfd8..1d8b336 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
@@ -41,6 +41,9 @@ public class ZipFileProvider extends AbstractLayeredFileProvider {
protected static final Collection<Capability> capabilities = Collections.unmodifiableCollection(Arrays.asList(Capability.GET_LAST_MODIFIED,
Capability.GET_TYPE, Capability.LIST_CHILDREN, Capability.READ_CONTENT, Capability.URI, Capability.COMPRESS, Capability.VIRTUAL));
+ /**
+ * Constructs a new instance.
+ */
public ZipFileProvider() {
}
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 45f268e..f22eeae 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
@@ -29,16 +29,30 @@ public class ZipFileSystemConfigBuilder extends FileSystemConfigBuilder {
private static final ZipFileSystemConfigBuilder INSTANCE = new ZipFileSystemConfigBuilder();
private static final String KEY_CHARSET = PREFIX + ".charset";
+ /**
+ * Gets the singleton instance.
+ *
+ * @return the singleton instance.
+ */
public static final ZipFileSystemConfigBuilder getInstance() {
return INSTANCE;
}
+ /**
+ * Constructs a new instance.
+ */
private ZipFileSystemConfigBuilder() {
super("zip.");
}
- public Charset getCharset(final FileSystemOptions opts) {
- return getParam(opts, KEY_CHARSET);
+ /**
+ * Gets the Charset from the FileSystemOptions.
+ *
+ * @param fileSystemOptions The source FileSystemOptions.
+ * @return the Charset from the FileSystemOptions.
+ */
+ public Charset getCharset(final FileSystemOptions fileSystemOptions) {
+ return getParam(fileSystemOptions, KEY_CHARSET);
}
@Override
@@ -46,8 +60,14 @@ public class ZipFileSystemConfigBuilder extends FileSystemConfigBuilder {
return ZipFileSystem.class;
}
- public void setCharset(final FileSystemOptions opts, final Charset charset) {
- setParam(opts, KEY_CHARSET, charset);
+ /**
+ * Sets the Charset in the FileSystemOptions.
+ *
+ * @param fileSystemOptions The target FileSystemOptions.
+ * @param charset The Charset to set.
+ */
+ public void setCharset(final FileSystemOptions fileSystemOptions, final Charset charset) {
+ setParam(fileSystemOptions, KEY_CHARSET, charset);
}
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java
index a979a58..ced628b 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java
@@ -412,6 +412,11 @@ public abstract class AbstractSyncTask extends VfsTask {
public static class SourceInfo {
private String file;
+ /**
+ * Sets the file.
+ *
+ * @param file the file.
+ */
public void setFile(final String file) {
this.file = file;
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/CombinedResources.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/CombinedResources.java
index 73acaa2..d3e2d66 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/CombinedResources.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/CombinedResources.java
@@ -37,6 +37,11 @@ public class CombinedResources extends ResourceBundle {
private volatile boolean inited;
private final Properties properties = new Properties();
+ /**
+ * Constructs a new instance.
+ *
+ * @param resourceName A resource name.
+ */
public CombinedResources(final String resourceName) {
this.resourceName = resourceName;
init();
@@ -59,6 +64,11 @@ public class CombinedResources extends ResourceBundle {
};
}
+ /**
+ * Gets the resource name.
+ *
+ * @return the resource name.
+ */
public String getResourceName() {
return resourceName;
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorRandomAccessContent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorRandomAccessContent.java
index 52190e3..4438ef6 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorRandomAccessContent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorRandomAccessContent.java
@@ -29,6 +29,11 @@ public class MonitorRandomAccessContent implements RandomAccessContent {
private final RandomAccessContent content;
private boolean finished;
+ /**
+ * Constructs a new instance.
+ *
+ * @param content The contents.
+ */
public MonitorRandomAccessContent(final RandomAccessContent content) {
this.content = content;
}
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/RandomAccessMode.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/RandomAccessMode.java
index ab9c6e4..38f45f1 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/RandomAccessMode.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/RandomAccessMode.java
@@ -39,10 +39,20 @@ public enum RandomAccessMode {
this.write = write;
}
+ /**
+ * Tests read.
+ *
+ * @return true for read.
+ */
public boolean requestRead() {
return read;
}
+ /**
+ * Tests write.
+ *
+ * @return true for write.
+ */
public boolean requestWrite() {
return write;
}