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 0609145 - Close Javadoc tags - Minor formating - Remove trailing
whitespace.
0609145 is described below
commit 060914575935420a341d265b52adae0a2f19703d
Author: Gary Gregory <gardgreg...@gmail.com>
AuthorDate: Sat May 18 08:50:34 2019 -0400
- Close Javadoc tags
- Minor formating
- Remove trailing whitespace.
---
.../org/apache/commons/vfs2/AllFileSelector.java | 1 +
.../org/apache/commons/vfs2/CacheStrategy.java | 1 +
.../java/org/apache/commons/vfs2/Capability.java | 5 +-
.../org/apache/commons/vfs2/FileChangeEvent.java | 1 +
.../java/org/apache/commons/vfs2/FileContent.java | 2 +-
.../org/apache/commons/vfs2/FileContentInfo.java | 1 +
.../commons/vfs2/FileContentInfoFactory.java | 1 +
.../org/apache/commons/vfs2/FileDepthSelector.java | 1 +
.../apache/commons/vfs2/FileFilterSelector.java | 2 +
.../java/org/apache/commons/vfs2/FileListener.java | 2 +
.../java/org/apache/commons/vfs2/FileMonitor.java | 1 +
.../java/org/apache/commons/vfs2/FileName.java | 4 +
.../commons/vfs2/FileNotFolderException.java | 1 +
.../apache/commons/vfs2/FileNotFoundException.java | 1 +
.../java/org/apache/commons/vfs2/FileObject.java | 18 +++
.../org/apache/commons/vfs2/FileSelectInfo.java | 1 +
.../java/org/apache/commons/vfs2/FileSelector.java | 1 +
.../java/org/apache/commons/vfs2/FileSystem.java | 10 +-
.../commons/vfs2/FileSystemConfigBuilder.java | 79 ++++++-------
.../org/apache/commons/vfs2/FileSystemManager.java | 8 +-
.../org/apache/commons/vfs2/FileSystemOptions.java | 1 +
.../java/org/apache/commons/vfs2/FileType.java | 1 +
.../vfs2/FileTypeHasNoContentException.java | 1 +
.../org/apache/commons/vfs2/FileTypeSelector.java | 1 +
.../java/org/apache/commons/vfs2/FilesCache.java | 1 +
.../java/org/apache/commons/vfs2/NameScope.java | 4 +
.../apache/commons/vfs2/PatternFileSelector.java | 6 +
.../apache/commons/vfs2/RandomAccessContent.java | 3 +-
.../java/org/apache/commons/vfs2/Selectors.java | 1 +
.../commons/vfs2/UserAuthenticationData.java | 1 +
.../org/apache/commons/vfs2/UserAuthenticator.java | 1 +
.../src/main/java/org/apache/commons/vfs2/VFS.java | 2 +
.../main/java/org/apache/commons/vfs2/VfsLog.java | 123 +++++++++++----------
.../apache/commons/vfs2/filter/AgeFileFilter.java | 32 +++---
.../apache/commons/vfs2/filter/AndFileFilter.java | 12 +-
.../commons/vfs2/filter/CanExecuteFileFilter.java | 16 +--
.../commons/vfs2/filter/CanReadFileFilter.java | 20 ++--
.../commons/vfs2/filter/CanWriteFileFilter.java | 18 +--
.../commons/vfs2/filter/ConditionalFileFilter.java | 16 +--
.../commons/vfs2/filter/DirectoryFileFilter.java | 12 +-
.../commons/vfs2/filter/EmptyFileFilter.java | 16 +--
.../commons/vfs2/filter/FalseFileFilter.java | 10 +-
.../apache/commons/vfs2/filter/FileFileFilter.java | 12 +-
.../commons/vfs2/filter/HiddenFileFilter.java | 16 +--
.../org/apache/commons/vfs2/filter/IOCase.java | 6 +-
.../apache/commons/vfs2/filter/NameFileFilter.java | 22 ++--
.../apache/commons/vfs2/filter/NotFileFilter.java | 14 +--
.../apache/commons/vfs2/filter/OrFileFilter.java | 12 +-
.../commons/vfs2/filter/PrefixFileFilter.java | 22 ++--
.../commons/vfs2/filter/RegexFileFilter.java | 22 ++--
.../apache/commons/vfs2/filter/SizeFileFilter.java | 18 +--
.../commons/vfs2/filter/SizeRangeFileFilter.java | 8 +-
.../commons/vfs2/filter/SuffixFileFilter.java | 22 ++--
.../apache/commons/vfs2/filter/TrueFileFilter.java | 10 +-
.../commons/vfs2/filter/WildcardFileFilter.java | 28 ++---
.../commons/vfs2/provider/AbstractFileSystem.java | 2 +-
.../vfs2/provider/bzip2/Bzip2FileObject.java | 6 +-
.../commons/vfs2/provider/ftp/FtpClient.java | 4 +-
.../vfs2/provider/ftps/FtpsClientFactory.java | 2 +-
.../commons/vfs2/provider/ftps/FtpsFileSystem.java | 2 +-
.../commons/vfs2/provider/gzip/GzipFileObject.java | 4 +-
.../vfs2/provider/sftp/BytesIdentityInfo.java | 2 +-
.../vfs2/provider/sftp/IdentityProvider.java | 2 +-
.../provider/sftp/IdentityRepositoryFactory.java | 2 +-
.../vfs2/provider/sftp/SftpClientFactory.java | 6 +-
.../provider/sftp/SftpFileSystemConfigBuilder.java | 2 +-
.../vfs2/provider/sftp/SftpStreamProxy.java | 2 +-
.../commons/vfs2/provider/tar/TarFileObject.java | 2 +-
.../commons/vfs2/provider/zip/ZipFileSystem.java | 4 +-
.../provider/zip/ZipFileSystemConfigBuilder.java | 8 +-
70 files changed, 386 insertions(+), 315 deletions(-)
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/AllFileSelector.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/AllFileSelector.java
index 5163406..e0eb7c8 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/AllFileSelector.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/AllFileSelector.java
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2;
* A {@link FileSelector} that selects everything.
*/
public class AllFileSelector implements FileSelector {
+
/**
* Determines if a file or folder should be selected.
*
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/CacheStrategy.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/CacheStrategy.java
index 2e0d793..707acd0 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/CacheStrategy.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/CacheStrategy.java
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2;
* An enumerated type to deal with the various cache strategies.
*/
public enum CacheStrategy {
+
/**
* Deal with cached data manually. Call {@link FileObject#refresh()} to
refresh the object data.
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/Capability.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/Capability.java
index 32685e0..62b5fb6 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/Capability.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/Capability.java
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2;
* An enumerated type representing the capabilities of files and file systems.
*/
public enum Capability {
+
/**
* File content can be read.
*/
@@ -128,9 +129,11 @@ public enum Capability {
/**
* The provider itself do not provide a filesystem. It simply resolves a
full name and dispatches the request back
- * to the filesystemmanager.<br>
+ * to the filesystemmanager.
+ * <p>
* A provider with this capability cant tell much about the capabilities
about the finally used filesystem in
* advance.
+ * </p>
*/
DISPATCHER,
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileChangeEvent.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileChangeEvent.java
index dc6dfa8..6b08f1e 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileChangeEvent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileChangeEvent.java
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2;
* An event fired when a file is changed.
*/
public class FileChangeEvent {
+
/**
* The file object
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContent.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContent.java
index dd4a59f..4688434 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContent.java
@@ -137,7 +137,7 @@ public interface FileContent extends Closeable {
}
return buf;
}
-
+
/**
* Returns an input stream for reading the file's content.
* <p>
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContentInfo.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContentInfo.java
index f278ed8..f194f8a 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContentInfo.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContentInfo.java
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2;
* Informs on the content of a file with content type and encoding.
*/
public interface FileContentInfo {
+
/**
* Gets the content encoding.
*
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContentInfoFactory.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContentInfoFactory.java
index 18561f2..714379a 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContentInfoFactory.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContentInfoFactory.java
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2;
* Creates {@link FileContentInfo} instances to determine the content-info for
given file contents.
*/
public interface FileContentInfoFactory {
+
/**
* Creates a FileContentInfo for a the given FileContent.
*
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileDepthSelector.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileDepthSelector.java
index a77df22..2a25112 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileDepthSelector.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileDepthSelector.java
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2;
* A {@link FileSelector} that selects all files in a particular depth range.
*/
public class FileDepthSelector implements FileSelector {
+
/**
* The minimum depth
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileFilterSelector.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileFilterSelector.java
index 286c326..a4fb150 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileFilterSelector.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileFilterSelector.java
@@ -22,8 +22,10 @@ import org.apache.commons.vfs2.util.Messages;
* A {@link org.apache.commons.vfs2.FileSelector} that selects all children of
the given fileObject.
* <p>
* This is to mimic the {@link java.io.FileFilter} interface.
+ * </p>
*/
public class FileFilterSelector extends FileDepthSelector {
+
/**
* The FileFilter.
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileListener.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileListener.java
index e5daa51..981a2de 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileListener.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileListener.java
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2;
* Listens for changes to a file.
*/
public interface FileListener {
+
/**
* Called when a file is created.
*
@@ -40,6 +41,7 @@ public interface FileListener {
* Called when a file is changed.
* <p>
* This will only happen if you monitor the file using {@link FileMonitor}.
+ * </p>
*
* @param event The FileChangeEvent.
* @throws Exception if an error occurs.
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileMonitor.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileMonitor.java
index 07270fe..03ba46f 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileMonitor.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileMonitor.java
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2;
* FileMonitor interface.
*/
public interface FileMonitor {
+
/**
* Adds a file to be monitored.
*
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileName.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileName.java
index 28f7ff1..fcca329 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileName.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileName.java
@@ -22,6 +22,7 @@ package org.apache.commons.vfs2;
* @see FileObject
*/
public interface FileName extends Comparable<FileName> {
+
/**
* The separator character used in file paths.
*/
@@ -176,8 +177,10 @@ public interface FileName extends Comparable<FileName> {
* <p>
* The "requested" type is the one determined during resolving the name.
In this case the name is a
* {@link FileType#FOLDER} if it ends with an "/" else it will be a {@link
FileType#FILE}.
+ * </p>
* <p>
* Once attached it will be changed to reflect the real type of this
resource.
+ * </p>
*
* @return {@link FileType#FOLDER} or {@link FileType#FILE}
*/
@@ -187,6 +190,7 @@ public interface FileName extends Comparable<FileName> {
* Returns a "friendly path", this is a path without a password.
* <p>
* This path can not be used to resolve the path again.
+ * </p>
*
* @return the friendly URI as a String.
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileNotFolderException.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileNotFolderException.java
index a3fa00d..ddef841 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileNotFolderException.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileNotFolderException.java
@@ -22,6 +22,7 @@ package org.apache.commons.vfs2;
* @since 2.0
*/
public class FileNotFolderException extends FileSystemException {
+
/**
* serialVersionUID format is YYYYMMDD for the date of the last binary
change.
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileNotFoundException.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileNotFoundException.java
index 0cc6a77..6fbbb80 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileNotFoundException.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileNotFoundException.java
@@ -22,6 +22,7 @@ package org.apache.commons.vfs2;
* @since 2.0
*/
public class FileNotFoundException extends FileSystemException {
+
/**
* serialVersionUID format is YYYYMMDD for the date of the last binary
change.
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileObject.java
index 8eb0c35..d6ea685 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileObject.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileObject.java
@@ -27,29 +27,40 @@ import org.apache.commons.vfs2.operations.FileOperations;
* <p>
* Files are arranged in a hierarchy. Each hierarchy forms a <i>file
system</i>. A file system represents things like a
* local OS file system, a windows share, an HTTP server, or the contents of a
Zip file.
+ * </p>
* <p>
* There are two types of files: <i>Folders</i>, which contain other files,
and <i>normal files</i>, which contain data,
* or <i>content</i>. A folder may not have any content, and a normal file
cannot contain other files.
+ * </p>
*
* <h2>File Naming</h2>
*
+ * <p>
* TODO - write this.
+ * </p>
*
* <h2>Reading and Writing a File</h2>
*
+ * <p>
* Reading and writing a file, and all other operations on the file's
<i>content</i>, is done using the
* {@link FileContent} object returned by {@link #getContent}.
+ * </p>
*
* <h2>Creating and Deleting a File</h2>
*
+ * <p>
* A file is created using either {@link #createFolder}, {@link #createFile},
or by writing to the file using one of the
* {@link FileContent} methods.
+ * </p>
* <p>
* A file is deleted using {@link #delete}. Recursive deletion can be done
using {@link #delete(FileSelector)}.
+ * </p>
*
* <h2>Finding Files</h2>
*
+ * <p>
* Other files in the <i>same</i> file system as this file can be found using:
+ * </p>
* <ul>
* <li>{@link #findFiles} to find a set of matching descendants in in the same
file system.</li>
* <li>{@link #getChildren} and {@link #getChild} to find the children of this
file.</li>
@@ -57,23 +68,30 @@ import org.apache.commons.vfs2.operations.FileOperations;
* <li>{@link #getFileSystem} to find another file in the same file
system.</li>
* <li>{@link #resolveFile} to find another file relative to this file.</li>
* </ul>
+ * <p>
* To find files in another file system, use a {@link FileSystemManager}.
+ * </p>
*
* <h2>Iterating Files</h2>
*
+ * <p>
* You can iterate over a FileObject using the Java "foreach" statement, which
provides all descendants of a File
* Object.
+ * </p>
*
* <h2>Sorting Files</h2>
*
+ * <p>
* Files may be sorted using {@link java.util.Arrays#sort(Object[])
Arrays.sort()} and
* {@link java.util.Collections#sort(List) Collections.sort()}.
+ * </p>
*
* @see FileSystemManager
* @see FileContent
* @see FileName
*/
public interface FileObject extends Comparable<FileObject>,
Iterable<FileObject>, Closeable {
+
/**
* Queries the file if it is possible to rename it to newfile.
*
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSelectInfo.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSelectInfo.java
index 9f72bc6..ca9624c 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSelectInfo.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSelectInfo.java
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2;
* Information about a file, that is used to select files during the traversal
of a hierarchy.
* <p>
* TODO - Rename this interface, as it is used by both FileSelector and
FileVisitor.
+ * </p>
*/
public interface FileSelectInfo {
/**
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSelector.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSelector.java
index 6a38aca..b386ce0 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSelector.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSelector.java
@@ -38,6 +38,7 @@ public interface FileSelector {
* each of the children of the folder, and each of the child folders is
recursively traversed.
* <p>
* This method is called on a folder before {@link #includeFile} is called.
+ * </p>
*
* @param fileInfo the file or folder to select.
* @return true if the folder should be traversed.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystem.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystem.java
index 62c9950..f17a498 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystem.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystem.java
@@ -22,6 +22,7 @@ import java.io.File;
* A file system, made up of a hierarchy of files.
*/
public interface FileSystem {
+
/**
* Returns the root file of this file system.
*
@@ -48,6 +49,7 @@ public interface FileSystem {
* Determines if this file system has a particular capability.
* <p>
* TODO - Move this to another interface, so that set of capabilities can
be queried.
+ * </p>
*
* @param capability The capability to check for.
* @return true if this filesystem has the requested capability. Note that
not all files in the file system may have
@@ -66,8 +68,11 @@ public interface FileSystem {
/**
* Gets the value of an attribute of the file system.
* <p>
- * TODO - change to {@code Map getAttributes()} instead?<br>
+ * TODO - change to {@code Map getAttributes()} instead?
+ * </p>
+ * <p>
* TODO - define the standard attribute names, and define which attrs are
guaranteed to be present.
+ * </p>
*
* @param attrName The name of the attribute.
* @return The value of the attribute.
@@ -146,9 +151,11 @@ public interface FileSystem {
* made.
* <p>
* Note that the local copy may include additonal files, that were not
selected by the given selector.
+ * </p>
* <p>
* TODO - Add options to indicate whether the caller is happy to deal with
extra files being present locally (eg if
* the file has been replicated previously), or whether the caller expects
only the selected files to be present.
+ * </p>
*
* @param file The file to replicate.
* @param selector The selector to use to select the files to replicate.
@@ -176,6 +183,7 @@ public interface FileSystem {
* <p>
* The local file provider is not very smart in figuring this out, for
remote access to file systems the providers
* typically don't know the value of the underlying real file system.
+ * </p>
*
* @return the accuracy of the last modification time in milliseconds. A
value of 0 means perfectly accurate,
* anything {@literal > 0} might be off by this value. For
example, sftp has an accuracy of 1000 ms.
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 e7a4e7a..ea4f81f 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
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2;
* Abstract class which has the right to fill FileSystemOptions.
*/
public abstract class FileSystemConfigBuilder {
+
/** Default prefix to use when resolving system properties */
private static final String PREFIX = "vfs.";
@@ -30,7 +31,7 @@ public abstract class FileSystemConfigBuilder {
private final String prefix;
/**
- * Construct builder with default prefix.
+ * Constructs builder with default prefix.
*
* @since 1.0
*/
@@ -39,7 +40,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Construct builder with specified component name.
+ * Constructs builder with specified component name.
*
* @param component component name to be used in prefix
*
@@ -50,7 +51,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * The root URI of the file system.
+ * Sets the root URI of the file system.
*
* @param opts the file system options to modify
* @param rootURI The creator name to be associated with the file.
@@ -62,7 +63,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Return the root URI of the file system.
+ * Gets the root URI of the file system.
*
* @param opts file system options to work with
* @return The root URI
@@ -74,7 +75,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Set named parameter.
+ * Sets named parameter.
*
* @param opts the file system options to modify
* @param name set option with this name
@@ -87,7 +88,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Set named parameter.
+ * Sets named parameter.
*
* @param opts the file system options to modify
* @param name set option with this name
@@ -100,7 +101,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named parameter.
+ * Gets named parameter.
*
* @param opts file system options to work with
* @param name get option with this name
@@ -117,7 +118,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Check if option exists.
+ * Checks if option exists.
*
* @param opts file system options to work with
* @param name the name to look up in {@code opts}
@@ -130,7 +131,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Is named setting specified.
+ * Checks the named setting specified.
*
* @param opts file system options to work with
* @param name the option to check in {@code opts} or system properties
@@ -143,7 +144,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as boolean.
+ * Gets named option as boolean.
*
* @param opts file system options to work with
* @param name the option name
@@ -157,7 +158,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as boolean.
+ * Gets named option as boolean.
*
* @param opts file system options to work with
* @param name the option name
@@ -172,7 +173,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as boolean.
+ * Gets named option as boolean.
*
* @param opts file system options to work with
* @param name the option name
@@ -195,7 +196,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as byte.
+ * Gets named option as byte.
*
* @param opts file system options to work with
* @param name the option name
@@ -209,7 +210,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as byte.
+ * Gets named option as byte.
*
* @param opts file system options to work with
* @param name the option name
@@ -224,7 +225,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as byte.
+ * Gets named option as byte.
*
* @param opts file system options to work with
* @param name the option name
@@ -246,7 +247,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as character.
+ * Gets named option as character.
*
* @param opts file system options to work with
* @param name the option name
@@ -260,7 +261,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as character.
+ * Gets named option as character.
*
* @param opts file system options to work with
* @param name the option name
@@ -275,7 +276,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as character.
+ * Gets named option as character.
*
* @param opts file system options to work with
* @param name the option name
@@ -297,7 +298,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as double.
+ * Gets named option as double.
*
* @param opts file system options to work with
* @param name the option name
@@ -311,7 +312,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as double.
+ * Gets named option as double.
*
* @param opts file system options to work with
* @param name the option name
@@ -326,7 +327,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as double.
+ * Gets named option as double.
*
* @param opts file system options to work with
* @param name the option name
@@ -348,7 +349,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as enumeration.
+ * Gets named option as enumeration.
*
* @param <E> enumeration type
* @param enumClass class of enumeration type
@@ -365,7 +366,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as enumeration.
+ * Gets named option as enumeration.
*
* @param <E> enumeration type
* @param enumClass class of enumeration type
@@ -393,7 +394,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as float.
+ * Gets named option as float.
*
* @param opts file system options to work with
* @param name the option name
@@ -408,7 +409,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as float.
+ * Gets named option as float.
*
* @param opts file system options to work with
* @param name the option name
@@ -424,7 +425,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as float.
+ * Gets named option as float.
*
* @param opts file system options to work with
* @param name the option name
@@ -447,7 +448,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as integer.
+ * Gets named option as integer.
*
* @param opts file system options to work with
* @param name the option name
@@ -462,7 +463,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as integer.
+ * Gets named option as integer.
*
* @param opts file system options to work with
* @param name the option name
@@ -478,7 +479,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as integer.
+ * Gets named option as integer.
*
* @param opts file system options to work with
* @param name the option name
@@ -501,7 +502,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as long.
+ * Gets named option as long.
*
* @param opts file system options to work with
* @param name the option name
@@ -516,7 +517,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as long.
+ * Gets named option as long.
*
* @param opts file system options to work with
* @param name the option name
@@ -532,7 +533,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as long.
+ * Gets named option as long.
*
* @param opts file system options to work with
* @param name the option name
@@ -555,7 +556,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as short.
+ * Gets named option as short.
*
* @param opts file system options to work with
* @param name the option name
@@ -570,7 +571,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as short.
+ * Gets named option as short.
*
* @param opts file system options to work with
* @param name the option name
@@ -586,7 +587,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as short.
+ * Gets named option as short.
*
* @param opts file system options to work with
* @param name the option name
@@ -609,7 +610,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as String.
+ * Gets named option as String.
*
* @param opts file system options to work with
* @param name the option name
@@ -623,7 +624,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get named option as String.
+ * Gets named option as String.
*
* @param opts file system options to work with
* @param name the option name
@@ -644,7 +645,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get the target of this configuration.
+ * Gets the target of this configuration.
*
* @return the specific file system class
*
@@ -665,7 +666,7 @@ public abstract class FileSystemConfigBuilder {
}
/**
- * Get the system property for the given name.
+ * Gets the system property for the given name.
*
* @param name The name to lookup combined with the prefix.
* @return a system property or null
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemManager.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemManager.java
index 1eba57d..3b64f50 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemManager.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemManager.java
@@ -34,8 +34,9 @@ import
org.apache.commons.vfs2.operations.FileOperationProvider;
* </p>
*
* <h2><a name="naming">File Naming</a></h2>
- *
+ * <p>
* A file system manager can recognise several types of file names:
+ * </p>
* <ul>
* <li>Absolute URI. These must start with a scheme, such as {@code file:} or
{@code ftp:}, followed by a scheme
* dependent file name. Some examples: {@code file:/c:/somefile} or {@code
ftp://somewhere.org/somefile}.</li>
@@ -50,8 +51,7 @@ import
org.apache.commons.vfs2.operations.FileOperationProvider;
* </ul>
*/
public interface FileSystemManager {
-
- // -- OPERATIONS --
+
/**
* Adds the specified FileOperationProvider for the specified scheme.
* <p>
@@ -177,7 +177,7 @@ public interface FileSystemManager {
FilesCache getFilesCache();
/**
- * Get the configuration builder for the given scheme.
+ * Gets the configuration builder for the given scheme.
*
* @param scheme The schem to use to obtain the FileSystemConfigBuidler.
* @return A FileSystemConfigBuilder appropriate for the given scheme.
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 762695d..f54eec5 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
@@ -46,6 +46,7 @@ import java.util.TreeMap;
*
*/
public final class FileSystemOptions implements Cloneable {
+
/** The options */
private final Map<FileSystemOptionKey, Object> options;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileType.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileType.java
index 45373cf..1e3b51d 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileType.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileType.java
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2;
* An enumerated type that represents a file's type.
*/
public enum FileType {
+
/**
* A folder. May contain other files, and have attributes, but does not
have any data content.
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileTypeHasNoContentException.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileTypeHasNoContentException.java
index b185fbd..e6fc05f 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileTypeHasNoContentException.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileTypeHasNoContentException.java
@@ -23,6 +23,7 @@ package org.apache.commons.vfs2;
* @since 2.0
*/
public class FileTypeHasNoContentException extends FileSystemException {
+
/**
* serialVersionUID format is YYYYMMDD for the date of the last binary
change.
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileTypeSelector.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileTypeSelector.java
index d59e8a3..89cb302 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileTypeSelector.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileTypeSelector.java
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2;
* A {@link FileSelector} that selects files of a particular type.
*/
public class FileTypeSelector implements FileSelector {
+
/** The FileType */
private final FileType type;
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FilesCache.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FilesCache.java
index 335a19a..82771b8 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FilesCache.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FilesCache.java
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2;
* The fileCache interface. Implementations of this interface are expected to
be thread safe.
*/
public interface FilesCache {
+
/**
* Adds a FileObject to the cache.
*
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/NameScope.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/NameScope.java
index f97c3a2..6e913b6 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/NameScope.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/NameScope.java
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2;
* An enumerated type for file name scope, used when resolving a name relative
to a file.
*/
public enum NameScope {
+
/**
* Resolve against the children of the base file. The name is resolved as
described by {@link #FILE_SYSTEM}.
* However, an exception is thrown if the resolved file is not a direct
child of the base file.
@@ -44,11 +45,14 @@ public enum NameScope {
* <p>
* If the supplied name is an absolute path, then it is resolved relative
to the root of the file system that the
* base file belongs to. If a relative name is supplied, then it is
resolved relative to the base file.
+ * </p>
* <p>
* The path may use any mix of {@code /}, {@code \}, or file system
specific separators to separate elements in the
* path. It may also contain {@code .} and {@code ..} elements.
+ * </p>
* <p>
* A path is considered absolute if it starts with a separator character,
and relative if it does not.
+ * </p>
*/
FILE_SYSTEM("filesystem");
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/PatternFileSelector.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/PatternFileSelector.java
index 4512536..ea288f9 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/PatternFileSelector.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/PatternFileSelector.java
@@ -26,6 +26,7 @@ import java.util.regex.Pattern;
* {@linkplain Matcher#matches() matched} against {@link FileName#getPath()}
* of all candidate files. If you want to match only against the base filename,
* make sure to prefix the pattern with {@code ".*\\/"}.
+ * </p>
*
* @since 2.1
*/
@@ -40,6 +41,7 @@ public class PatternFileSelector implements FileSelector {
* Creates a new selector for the given pattern.
* <p>
* See {@link PatternFileSelector} for a specification how the pattern is
matched.
+ * </p>
*
* @param pattern The regular expressed used by this selector.
*/
@@ -51,6 +53,7 @@ public class PatternFileSelector implements FileSelector {
* Creates a new selector for the given pattern.
* <p>
* See {@link PatternFileSelector} for a specification how the pattern is
matched.
+ * </p>
*
* @param regex The regular expressed used by this selector.
*
@@ -64,6 +67,7 @@ public class PatternFileSelector implements FileSelector {
* Creates a new selector for the given Pattern and flags.
* <p>
* See {@link PatternFileSelector} for a specification how the pattern is
matched.
+ * </p>
*
* @param regex The expression to be compiled
* @param flags Match flags, a bit mask.
@@ -78,6 +82,7 @@ public class PatternFileSelector implements FileSelector {
* Determines if a file or folder should be selected.
* <p>
* See {@link PatternFileSelector} for a specification how the pattern is
matched.
+ * </p>
*
* @param fileInfo The file selection information.
* @return true if the file should be selected, false otherwise.
@@ -97,6 +102,7 @@ public class PatternFileSelector implements FileSelector {
* <p>
* This implementation always returns true to make sure all
* leafs are inspected.
+ * </p>
*
* @param fileInfo The file selection information.
* @return true if descendants should be traversed, false otherwise.
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java
index ab12483..a5bbcb7 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java
@@ -25,6 +25,7 @@ import java.io.InputStream;
* Provides random access over content.
*/
public interface RandomAccessContent extends DataOutput, DataInput {
+
/**
* Closes this random access file stream and releases any system resources
associated with the stream.
* <p>
@@ -32,7 +33,7 @@ public interface RandomAccessContent extends DataOutput,
DataInput {
* </p>
* <p>
* If this file has an associated channel then the channel is closed as
well.
- * <p>
+ * </p>
*
* @throws IOException if an I/O error occurs.
*/
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/Selectors.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/Selectors.java
index 7e6570d..1759692 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/Selectors.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/Selectors.java
@@ -20,6 +20,7 @@ package org.apache.commons.vfs2;
* Several standard file selectors.
*/
public final class Selectors {
+
/**
* A {@link FileSelector} that selects only the base file/folder.
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/UserAuthenticationData.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/UserAuthenticationData.java
index 378bae2..8898790 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/UserAuthenticationData.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/UserAuthenticationData.java
@@ -24,6 +24,7 @@ import java.util.TreeMap;
* Contains various authentication data.
*/
public class UserAuthenticationData {
+
/**
* Represents a user authentication item.
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/UserAuthenticator.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/UserAuthenticator.java
index ec83d58..550f581 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/UserAuthenticator.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/UserAuthenticator.java
@@ -22,6 +22,7 @@ package org.apache.commons.vfs2;
* if the FileSystem should be shared.
*/
public interface UserAuthenticator {
+
/**
* Queries the given type from the user.
*
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 523a43a..3312a3b 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
@@ -23,6 +23,7 @@ import java.lang.reflect.Method;
* The main entry point for the VFS. Used to create {@link FileSystemManager}
instances.
*/
public final class VFS {
+
/** The URI style */
private static Boolean uriStyle;
@@ -36,6 +37,7 @@ public final class VFS {
* Returns 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>
*
* @return The FileSystemManager.
* @throws FileSystemException if an error occurs creating the manager.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/VfsLog.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/VfsLog.java
index 8c14e50..4695820 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/VfsLog.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/VfsLog.java
@@ -23,6 +23,7 @@ import org.apache.commons.logging.Log;
* I hope i could remove it sometimes.
*/
public final class VfsLog {
+
// static utility class
private VfsLog() {
}
@@ -30,14 +31,14 @@ public final class VfsLog {
/**
* warning.
*
- * @param vfslog The base component Logger to use.
+ * @param vfsLog The base component Logger to use.
* @param commonslog The class specific Logger
* @param message The message to log.
* @param t The exception, if any.
*/
- public static void warn(final Log vfslog, final Log commonslog, final
String message, final Throwable t) {
- if (vfslog != null) {
- vfslog.warn(message, t);
+ public static void warn(final Log vfsLog, final Log commonslog, final
String message, final Throwable t) {
+ if (vfsLog != null) {
+ vfsLog.warn(message, t);
} else if (commonslog != null) {
commonslog.warn(message, t);
}
@@ -46,13 +47,13 @@ public final class VfsLog {
/**
* warning.
*
- * @param vfslog The base component Logger to use.
+ * @param vfsLog The base component Logger to use.
* @param commonslog The class specific Logger
* @param message The message to log.
*/
- public static void warn(final Log vfslog, final Log commonslog, final
String message) {
- if (vfslog != null) {
- vfslog.warn(message);
+ public static void warn(final Log vfsLog, final Log commonslog, final
String message) {
+ if (vfsLog != null) {
+ vfsLog.warn(message);
} else if (commonslog != null) {
commonslog.warn(message);
}
@@ -61,13 +62,13 @@ public final class VfsLog {
/**
* debug.
*
- * @param vfslog The base component Logger to use.
+ * @param vfsLog The base component Logger to use.
* @param commonslog The class specific Logger
* @param message The message to log.
*/
- public static void debug(final Log vfslog, final Log commonslog, final
String message) {
- if (vfslog != null) {
- vfslog.debug(message);
+ public static void debug(final Log vfsLog, final Log commonslog, final
String message) {
+ if (vfsLog != null) {
+ vfsLog.debug(message);
} else if (commonslog != null) {
commonslog.debug(message);
}
@@ -76,109 +77,109 @@ public final class VfsLog {
/**
* debug.
*
- * @param vfslog The base component Logger to use.
- * @param commonslog The class specific Logger
+ * @param vfsLog The base component Logger to use.
+ * @param commonsLog The class specific Logger
* @param message The message to log.
* @param t The exception, if any.
*/
- public static void debug(final Log vfslog, final Log commonslog, final
String message, final Throwable t) {
- if (vfslog != null) {
- vfslog.debug(message, t);
- } else if (commonslog != null) {
- commonslog.debug(message, t);
+ public static void debug(final Log vfsLog, final Log commonsLog, final
String message, final Throwable t) {
+ if (vfsLog != null) {
+ vfsLog.debug(message, t);
+ } else if (commonsLog != null) {
+ commonsLog.debug(message, t);
}
}
/**
* info.
*
- * @param vfslog The base component Logger to use.
- * @param commonslog The class specific Logger
+ * @param vfsLog The base component Logger to use.
+ * @param commonsLog The class specific Logger
* @param message The message to log.
* @param t The exception, if any.
*/
- public static void info(final Log vfslog, final Log commonslog, final
String message, final Throwable t) {
- if (vfslog != null) {
- vfslog.info(message, t);
- } else if (commonslog != null) {
- commonslog.info(message, t);
+ public static void info(final Log vfsLog, final Log commonsLog, final
String message, final Throwable t) {
+ if (vfsLog != null) {
+ vfsLog.info(message, t);
+ } else if (commonsLog != null) {
+ commonsLog.info(message, t);
}
}
/**
* info.
*
- * @param vfslog The base component Logger to use.
- * @param commonslog The class specific Logger
+ * @param vfsLog The base component Logger to use.
+ * @param commonsLog The class specific Logger
* @param message The message to log.
*/
- public static void info(final Log vfslog, final Log commonslog, final
String message) {
- if (vfslog != null) {
- vfslog.info(message);
- } else if (commonslog != null) {
- commonslog.info(message);
+ public static void info(final Log vfsLog, final Log commonsLog, final
String message) {
+ if (vfsLog != null) {
+ vfsLog.info(message);
+ } else if (commonsLog != null) {
+ commonsLog.info(message);
}
}
/**
* error.
*
- * @param vfslog The base component Logger to use.
- * @param commonslog The class specific Logger
+ * @param vfsLog The base component Logger to use.
+ * @param commonsLog The class specific Logger
* @param message The message to log.
* @param t The exception, if any.
*/
- public static void error(final Log vfslog, final Log commonslog, final
String message, final Throwable t) {
- if (vfslog != null) {
- vfslog.error(message, t);
- } else if (commonslog != null) {
- commonslog.error(message, t);
+ public static void error(final Log vfsLog, final Log commonsLog, final
String message, final Throwable t) {
+ if (vfsLog != null) {
+ vfsLog.error(message, t);
+ } else if (commonsLog != null) {
+ commonsLog.error(message, t);
}
}
/**
* error.
*
- * @param vfslog The base component Logger to use.
- * @param commonslog The class specific Logger
+ * @param vfsLog The base component Logger to use.
+ * @param commonsLog The class specific Logger
* @param message The message to log.
*/
- public static void error(final Log vfslog, final Log commonslog, final
String message) {
- if (vfslog != null) {
- vfslog.error(message);
- } else if (commonslog != null) {
- commonslog.error(message);
+ public static void error(final Log vfsLog, final Log commonsLog, final
String message) {
+ if (vfsLog != null) {
+ vfsLog.error(message);
+ } else if (commonsLog != null) {
+ commonsLog.error(message);
}
}
/**
* fatal.
*
- * @param vfslog The base component Logger to use.
- * @param commonslog The class specific Logger
+ * @param vfsLog The base component Logger to use.
+ * @param commonsLog The class specific Logger
* @param message The message to log.
* @param t The exception, if any.
*/
- public static void fatal(final Log vfslog, final Log commonslog, final
String message, final Throwable t) {
- if (vfslog != null) {
- vfslog.fatal(message, t);
- } else if (commonslog != null) {
- commonslog.fatal(message, t);
+ public static void fatal(final Log vfsLog, final Log commonsLog, final
String message, final Throwable t) {
+ if (vfsLog != null) {
+ vfsLog.fatal(message, t);
+ } else if (commonsLog != null) {
+ commonsLog.fatal(message, t);
}
}
/**
* fatal.
*
- * @param vfslog The base component Logger to use.
- * @param commonslog The class specific Logger
+ * @param vfsLog The base component Logger to use.
+ * @param commonsLog The class specific Logger
* @param message The message to log.
*/
- public static void fatal(final Log vfslog, final Log commonslog, final
String message) {
- if (vfslog != null) {
- vfslog.fatal(message);
- } else if (commonslog != null) {
- commonslog.fatal(message);
+ public static void fatal(final Log vfsLog, final Log commonsLog, final
String message) {
+ if (vfsLog != null) {
+ vfsLog.fatal(message);
+ } else if (commonsLog != null) {
+ commonsLog.fatal(message);
}
}
}
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AgeFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AgeFileFilter.java
index 5e31398..698f56f 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AgeFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AgeFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -31,7 +31,7 @@ import org.apache.commons.vfs2.FileSystemException;
* <p>
* For example, to print all files and directories in the current directory
* older than one day:
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -43,7 +43,7 @@ import org.apache.commons.vfs2.FileSystemException;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
@@ -61,7 +61,7 @@ public class AgeFileFilter implements FileFilter,
Serializable {
/**
* Tests if the specified <code>File</code> is newer than the specified
time
* reference.
- *
+ *
* @param fileObject the <code>File</code> of which the modification date
must
* be compared, must not be {@code null}
* @param timeMillis the time reference measured in milliseconds since the
epoch
@@ -87,7 +87,7 @@ public class AgeFileFilter implements FileFilter,
Serializable {
/**
* Constructs a new age file filter for files older than (at or before) a
* certain cutoff date.
- *
+ *
* @param cutoffDate the threshold age of the files
*/
public AgeFileFilter(final Date cutoffDate) {
@@ -97,7 +97,7 @@ public class AgeFileFilter implements FileFilter,
Serializable {
/**
* Constructs a new age file filter for files on any one side of a certain
* cutoff date.
- *
+ *
* @param cutoffDate the threshold age of the files
* @param acceptOlder if true, older files (at or before the cutoff) are
* accepted, else newer ones (after the cutoff).
@@ -109,10 +109,10 @@ public class AgeFileFilter implements FileFilter,
Serializable {
/**
* Constructs a new age file filter for files older than (at or before) a
* certain File (whose last modification time will be used as reference).
- *
+ *
* @param cutoffReference the file whose last modification time is usesd
as the
* threshold age of the files
- *
+ *
* @throws FileSystemException Error reading the last modification time
from the
* reference file object.
*/
@@ -123,12 +123,12 @@ public class AgeFileFilter implements FileFilter,
Serializable {
/**
* Constructs a new age file filter for files on any one side of a certain
File
* (whose last modification time will be used as reference).
- *
+ *
* @param cutoffReference the file whose last modification time is usesd
as the
* threshold age of the files
* @param acceptOlder if true, older files (at or before the cutoff)
are
* accepted, else newer ones (after the cutoff).
- *
+ *
* @throws FileSystemException Error reading the last modification time
from the
* reference file object.
*/
@@ -139,7 +139,7 @@ public class AgeFileFilter implements FileFilter,
Serializable {
/**
* Constructs a new age file filter for files equal to or older than a
certain
* cutoff.
- *
+ *
* @param cutoff the threshold age of the files
*/
public AgeFileFilter(final long cutoff) {
@@ -149,7 +149,7 @@ public class AgeFileFilter implements FileFilter,
Serializable {
/**
* Constructs a new age file filter for files on any one side of a certain
* cutoff.
- *
+ *
* @param cutoff the threshold age of the files
* @param acceptOlder if true, older files (at or before the cutoff) are
* accepted, else newer ones (after the cutoff).
@@ -165,9 +165,9 @@ public class AgeFileFilter implements FileFilter,
Serializable {
* If last modification time equals cutoff and newer files are required,
file
* <b>IS NOT</b> selected. If last modification time equals cutoff and
older
* files are required, file <b>IS</b> selected.
- *
+ *
* @param fileInfo the File to check
- *
+ *
* @return true if the filename matches
* @throws FileSystemException Thrown for file system errors.
*/
@@ -179,7 +179,7 @@ public class AgeFileFilter implements FileFilter,
Serializable {
/**
* Provide a String representaion of this file filter.
- *
+ *
* @return a String representaion
*/
@Override
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AndFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AndFileFilter.java
index 42129de..556e0b5 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AndFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/AndFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -31,7 +31,7 @@ import org.apache.commons.vfs2.FileSystemException;
* filter returns {@code true} if all filters in the list return {@code true}.
* Otherwise, it returns {@code false}. Checking of the file filter list stops
* when the first filter returns {@code false}.
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
@@ -52,7 +52,7 @@ public class AndFileFilter implements FileFilter,
ConditionalFileFilter, Seriali
/**
* Constructs a new file filter that ANDs the result of other filters.
- *
+ *
* @param filters array of filters, must not be null or empty
*/
public AndFileFilter(final FileFilter... filters) {
@@ -70,7 +70,7 @@ public class AndFileFilter implements FileFilter,
ConditionalFileFilter, Seriali
/**
* Constructs a new instance of <code>AndFileFilter</code> with the
specified
* list of filters.
- *
+ *
* @param fileFilters a List of FileFilter instances, copied, null ignored
*/
public AndFileFilter(final List<FileFilter> fileFilters) {
@@ -117,7 +117,7 @@ public class AndFileFilter implements FileFilter,
ConditionalFileFilter, Seriali
/**
* Provide a String representation of this file filter.
- *
+ *
* @return a String representation
*/
@Override
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanExecuteFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanExecuteFileFilter.java
index 786d806..3fec2fd 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanExecuteFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanExecuteFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -27,7 +27,7 @@ import org.apache.commons.vfs2.FileSystemException;
* <p>
* Example, showing how to print out a list of the current directory's
* <i>executable</i> files:
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -36,11 +36,11 @@ import org.apache.commons.vfs2.FileSystemException;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* <p>
* Example, showing how to print out a list of the current directory's
* <i>un-executable</i> files:
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -49,7 +49,7 @@ import org.apache.commons.vfs2.FileSystemException;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
*/
@@ -71,9 +71,9 @@ public class CanExecuteFileFilter implements FileFilter,
Serializable {
/**
* Checks to see if the file can be executed.
- *
+ *
* @param fileInfo the File to check.
- *
+ *
* @return {@code true} if the file can be executed, otherwise {@code
false}.
* @throws FileSystemException Thrown for file system errors.
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanReadFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanReadFileFilter.java
index dfcd739..47b11d4 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanReadFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanReadFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -27,7 +27,7 @@ import org.apache.commons.vfs2.FileSystemException;
* <p>
* Example, showing how to print out a list of the current directory's
* <i>readable</i> files:
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -36,11 +36,11 @@ import org.apache.commons.vfs2.FileSystemException;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* <p>
* Example, showing how to print out a list of the current directory's
* <i>un-readable</i> files:
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -49,11 +49,11 @@ import org.apache.commons.vfs2.FileSystemException;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* <p>
* Example, showing how to print out a list of the current directory's
* <i>read-only</i> files:
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -62,7 +62,7 @@ import org.apache.commons.vfs2.FileSystemException;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
@@ -88,9 +88,9 @@ public class CanReadFileFilter implements FileFilter,
Serializable {
/**
* Checks to see if the file can be read.
- *
+ *
* @param fileInfo the File to check.
- *
+ *
* @return {@code true} if the file can be read, otherwise {@code false}.
* @throws FileSystemException Thrown for file system errors.
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanWriteFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanWriteFileFilter.java
index 3ad1a02..e1d2905 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanWriteFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/CanWriteFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -29,7 +29,7 @@ import org.apache.commons.vfs2.FileSystemException;
* <p>
* Example, showing how to print out a list of the current directory's
* <i>writable</i> files:
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -38,11 +38,11 @@ import org.apache.commons.vfs2.FileSystemException;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* <p>
* Example, showing how to print out a list of the current directory's
* <i>un-writable</i> files:
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -51,11 +51,11 @@ import org.apache.commons.vfs2.FileSystemException;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* <p>
* <b>N.B.</b> For read-only files, use
* <code>CanReadFileFilter.READ_ONLY</code>.
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
@@ -78,9 +78,9 @@ public class CanWriteFileFilter implements FileFilter,
Serializable {
/**
* Checks to see if the file can be written to.
- *
+ *
* @param fileInfo the File to check
- *
+ *
* @return {@code true} if the file can be written to, otherwise {@code
false}.
* @throws FileSystemException Thrown for file system errors.
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/ConditionalFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/ConditionalFileFilter.java
index 90fb919..c839011 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/ConditionalFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/ConditionalFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -22,7 +22,7 @@ import org.apache.commons.vfs2.FileFilter;
/**
* Defines operations for conditional file filters.
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
@@ -32,23 +32,23 @@ public interface ConditionalFileFilter {
/**
* Adds the specified file filter to the list of file filters at the end
of the
* list.
- *
+ *
* @param fileFilter the filter to be added
*/
void addFileFilter(FileFilter fileFilter);
/**
* Returns this conditional file filter's list of file filters.
- *
+ *
* @return the file filter list
*/
List<FileFilter> getFileFilters();
/**
* Removes the specified file filter.
- *
+ *
* @param fileFilter filter to be removed
- *
+ *
* @return {@code true} if the filter was found in the list, {@code false}
* otherwise
*/
@@ -57,7 +57,7 @@ public interface ConditionalFileFilter {
/**
* Sets the list of file filters, replacing any previously configured file
* filters on this filter.
- *
+ *
* @param fileFilters the list of filters
*/
void setFileFilters(List<FileFilter> fileFilters);
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/DirectoryFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/DirectoryFileFilter.java
index 36f2194..7aed4fe 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/DirectoryFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/DirectoryFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -28,7 +28,7 @@ import org.apache.commons.vfs2.FileType;
* <p>
* For example, here is how to print out a list of the current directory's sub
* directories:
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -37,7 +37,7 @@ import org.apache.commons.vfs2.FileType;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
@@ -59,9 +59,9 @@ public class DirectoryFileFilter implements FileFilter,
Serializable {
/**
* Checks to see if the file is a directory.
- *
+ *
* @param fileInfo the File to check
- *
+ *
* @return {@code true} if the file is a directory
* @throws FileSystemException Thrown for file system errors.
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/EmptyFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/EmptyFileFilter.java
index ecac827..1b22360 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/EmptyFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/EmptyFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -31,7 +31,7 @@ import org.apache.commons.vfs2.FileType;
* If the <code>File</code> is a directory it checks that it contains no files.
* <p>
* Example, showing how to print out a list of the current directory's empty
files/directories:
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -40,10 +40,10 @@ import org.apache.commons.vfs2.FileType;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* <p>
* Example, showing how to print out a list of the current directory's
non-empty files/directories:
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -52,7 +52,7 @@ import org.apache.commons.vfs2.FileType;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
@@ -75,9 +75,9 @@ public class EmptyFileFilter implements FileFilter,
Serializable {
/**
* Checks to see if the file is empty. A non-existing file is also
considered empty.
- *
+ *
* @param fileInfo the file or directory to check
- *
+ *
* @return {@code true} if the file or directory is <i>empty</i>,
otherwise {@code false}.
* @throws FileSystemException Thrown for file system errors.
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FalseFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FalseFileFilter.java
index 50efbdd..754331a 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FalseFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FalseFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -23,7 +23,7 @@ import org.apache.commons.vfs2.FileSelectInfo;
/**
* A file filter that always returns false.
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
@@ -45,9 +45,9 @@ public class FalseFileFilter implements FileFilter,
Serializable {
/**
* Returns false.
- *
+ *
* @param fileInfo the file to check (ignored)
- *
+ *
* @return Always {@code false}
*/
@Override
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FileFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FileFileFilter.java
index fe0ecdd..f3e1393 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FileFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/FileFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -28,7 +28,7 @@ import org.apache.commons.vfs2.FileType;
* <p>
* For example, here is how to print out a list of the real files within the
* current directory:
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -37,7 +37,7 @@ import org.apache.commons.vfs2.FileType;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
@@ -57,9 +57,9 @@ public class FileFileFilter implements FileFilter,
Serializable {
/**
* Checks to see if the file is a file.
- *
+ *
* @param fileInfo the File to check
- *
+ *
* @return true if the file is a file
* @throws FileSystemException Thrown for file system errors.
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/HiddenFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/HiddenFileFilter.java
index 420000a..98ecc91 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/HiddenFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/HiddenFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -27,7 +27,7 @@ import org.apache.commons.vfs2.FileSystemException;
* <p>
* Example, showing how to print out a list of the current directory's
* <i>hidden</i> files:
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -36,11 +36,11 @@ import org.apache.commons.vfs2.FileSystemException;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* <p>
* Example, showing how to print out a list of the current directory's
* <i>visible</i> (i.e. not hidden) files:
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -49,7 +49,7 @@ import org.apache.commons.vfs2.FileSystemException;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
@@ -72,9 +72,9 @@ public class HiddenFileFilter implements FileFilter,
Serializable {
/**
* Checks to see if the file is hidden. Non existing files won't be
accepted.
- *
+ *
* @param fileInfo the File to check
- *
+ *
* @return {@code true} if the file is <i>hidden</i>, otherwise {@code
false}.
* @throws FileSystemException Thrown for file system errors.
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/IOCase.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/IOCase.java
index 72fe846..744f11c 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/IOCase.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/IOCase.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -33,7 +33,7 @@ import java.io.File;
* Wherever possible, you should use the <code>check</code> methods in this
* class to compare filenames.
* </p>
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NameFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NameFileFilter.java
index d54f4a0..0f09d88 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NameFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NameFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -29,7 +29,7 @@ import org.apache.commons.vfs2.FileSelectInfo;
* <p>
* For example, to print all files and directories in the current directory
* whose name is <code>Test</code>:
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -38,7 +38,7 @@ import org.apache.commons.vfs2.FileSelectInfo;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
@@ -55,7 +55,7 @@ public class NameFileFilter implements FileFilter,
Serializable {
/**
* Constructs a new case-sensitive name file filter for a list of names.
- *
+ *
* @param names the names to allow, must not be null
*/
public NameFileFilter(final List<String> names) {
@@ -65,7 +65,7 @@ public class NameFileFilter implements FileFilter,
Serializable {
/**
* Constructs a new name file filter for a list of names specifying
* case-sensitivity.
- *
+ *
* @param caseSensitivity how to handle case sensitivity, null means
* case-sensitive
* @param names the names to allow, must not be null
@@ -83,7 +83,7 @@ public class NameFileFilter implements FileFilter,
Serializable {
* <p>
* The array is not cloned, so could be changed after constructing the
instance.
* This would be inadvisable however.
- *
+ *
* @param names the names to allow, must not be null
*/
public NameFileFilter(final String... names) {
@@ -93,7 +93,7 @@ public class NameFileFilter implements FileFilter,
Serializable {
/**
* Constructs a new name file filter for an array of names specifying
* case-sensitivity.
- *
+ *
* @param caseSensitivity how to handle case sensitivity, null means
* case-sensitive
* @param names the names to allow, must not be null
@@ -108,9 +108,9 @@ public class NameFileFilter implements FileFilter,
Serializable {
/**
* Checks to see if the filename matches.
- *
+ *
* @param fileInfo the File to check
- *
+ *
* @return true if the filename matches
*/
@Override
@@ -126,7 +126,7 @@ public class NameFileFilter implements FileFilter,
Serializable {
/**
* Provide a String representation of this file filter.
- *
+ *
* @return a String representation
*/
@Override
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NotFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NotFileFilter.java
index 6dd9413..b455fec 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NotFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/NotFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -24,7 +24,7 @@ import org.apache.commons.vfs2.FileSystemException;
/**
* This filter produces a logical NOT of the filters specified.
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
@@ -38,7 +38,7 @@ public class NotFileFilter implements FileFilter,
Serializable {
/**
* Constructs a new file filter that NOTs the result of another filter.
- *
+ *
* @param filter the filter, must not be null
*/
public NotFileFilter(final FileFilter filter) {
@@ -51,9 +51,9 @@ public class NotFileFilter implements FileFilter,
Serializable {
/**
* Returns the logical NOT of the underlying filter's return value for the
same
* File.
- *
+ *
* @param fileInfo the File to check
- *
+ *
* @return {@code true} if the filter returns {@code false}
* @throws FileSystemException Thrown for file system errors.
*/
@@ -64,7 +64,7 @@ public class NotFileFilter implements FileFilter,
Serializable {
/**
* Provide a String representation of this file filter.
- *
+ *
* @return a String representation
*/
@Override
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/OrFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/OrFileFilter.java
index 708e1eb..6c8b438 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/OrFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/OrFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -31,7 +31,7 @@ import org.apache.commons.vfs2.FileSystemException;
* file filters. This filter returns {@code true} if any filters in the list
* return {@code true}. Otherwise, it returns {@code false}. Checking of the
* file filter list stops when the first filter returns {@code true}.
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
@@ -52,7 +52,7 @@ public class OrFileFilter implements FileFilter,
ConditionalFileFilter, Serializ
/**
* Constructs a new file filter that ORs the result of other filters.
- *
+ *
* @param filters array of filters, must not be null or empty
*/
public OrFileFilter(final FileFilter... filters) {
@@ -70,7 +70,7 @@ public class OrFileFilter implements FileFilter,
ConditionalFileFilter, Serializ
/**
* Constructs a new instance of <code>OrFileFilter</code> with the
specified
* filters.
- *
+ *
* @param fileFilters the file filters for this filter, copied, null
ignored
*/
public OrFileFilter(final List<FileFilter> fileFilters) {
@@ -114,7 +114,7 @@ public class OrFileFilter implements FileFilter,
ConditionalFileFilter, Serializ
/**
* Provide a String representation of this file filter.
- *
+ *
* @return a String representation
*/
@Override
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/PrefixFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/PrefixFileFilter.java
index 2b184d4..c3e2578 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/PrefixFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/PrefixFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -29,7 +29,7 @@ import org.apache.commons.vfs2.FileSelectInfo;
* <p>
* For example, to print all files and directories in the current directory
* whose name starts with a <code>.</code>:
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -38,7 +38,7 @@ import org.apache.commons.vfs2.FileSelectInfo;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
@@ -55,7 +55,7 @@ public class PrefixFileFilter implements FileFilter,
Serializable {
/**
* Constructs a new Prefix file filter for a list of prefixes.
- *
+ *
* @param prefixes the prefixes to allow, must not be null
*/
public PrefixFileFilter(final List<String> prefixes) {
@@ -65,7 +65,7 @@ public class PrefixFileFilter implements FileFilter,
Serializable {
/**
* Constructs a new Prefix file filter for a list of prefixes specifying
* case-sensitivity.
- *
+ *
* @param caseSensitivity how to handle case sensitivity, null means
* case-sensitive
* @param prefixes the prefixes to allow, must not be null
@@ -83,7 +83,7 @@ public class PrefixFileFilter implements FileFilter,
Serializable {
* <p>
* The array is not cloned, so could be changed after constructing the
instance.
* This would be inadvisable however.
- *
+ *
* @param prefixes the prefixes to allow, must not be null
*/
public PrefixFileFilter(final String... prefixes) {
@@ -93,7 +93,7 @@ public class PrefixFileFilter implements FileFilter,
Serializable {
/**
* Constructs a new Prefix file filter for any of an array of prefixes
* specifying case-sensitivity.
- *
+ *
* @param prefixes the prefixes to allow, must not be null
* @param caseSensitivity how to handle case sensitivity, null means
* case-sensitive
@@ -108,9 +108,9 @@ public class PrefixFileFilter implements FileFilter,
Serializable {
/**
* Checks to see if the filename starts with the prefix.
- *
+ *
* @param fileInfo the File to check
- *
+ *
* @return true if the filename starts with one of our prefixes
*/
@Override
@@ -126,7 +126,7 @@ public class PrefixFileFilter implements FileFilter,
Serializable {
/**
* Provide a String representation of this file filter.
- *
+ *
* @return a String representation
*/
@Override
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/RegexFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/RegexFileFilter.java
index f93268f..086955f 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/RegexFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/RegexFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -27,12 +27,12 @@ import org.apache.commons.vfs2.FileSelectInfo;
* <p>
* See java.util.regex.Pattern for regex matching rules.
* </p>
- *
+ *
* <p>
* For example, to retrieve and print all java files where the name matched the
* regular expression in the current directory:
* </p>
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -41,7 +41,7 @@ import org.apache.commons.vfs2.FileSelectInfo;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
@@ -58,7 +58,7 @@ public class RegexFileFilter implements FileFilter,
Serializable {
/**
* Construct a new regular expression filter for a compiled regular
expression.
- *
+ *
* @param pattern regular expression to match - Cannot be null
*/
public RegexFileFilter(final Pattern pattern) {
@@ -71,7 +71,7 @@ public class RegexFileFilter implements FileFilter,
Serializable {
/**
* Construct a new regular expression filter.
- *
+ *
* @param pattern regular string expression to match - Cannot be null
*/
public RegexFileFilter(final String pattern) {
@@ -84,7 +84,7 @@ public class RegexFileFilter implements FileFilter,
Serializable {
/**
* Construct a new regular expression filter with the specified flags.
- *
+ *
* @param pattern regular string expression to match
* @param flags pattern flags - e.g. {@link Pattern#CASE_INSENSITIVE}
*/
@@ -98,7 +98,7 @@ public class RegexFileFilter implements FileFilter,
Serializable {
/**
* Construct a new regular expression filter with the specified flags case
* sensitivity.
- *
+ *
* @param pattern regular string expression to match - Cannot be
null
* @param caseSensitivity how to handle case sensitivity, null means
* case-sensitive
@@ -116,9 +116,9 @@ public class RegexFileFilter implements FileFilter,
Serializable {
/**
* Checks to see if the filename matches one of the regular expressions.
- *
+ *
* @param fileInfo the File to check
- *
+ *
* @return true if the file matches one of the regular expressions
*/
@Override
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SizeFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SizeFileFilter.java
index 8bb9d8d..ba275b3 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SizeFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SizeFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -30,7 +30,7 @@ import org.apache.commons.vfs2.FileSystemException;
* <p>
* For example, to print all files and directories in the current directory
* whose size is greater than 1 MB:
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -40,7 +40,7 @@ import org.apache.commons.vfs2.FileSystemException;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
@@ -58,7 +58,7 @@ public class SizeFileFilter implements FileFilter,
Serializable {
/**
* Constructs a new size file filter for files equal to or larger than a
certain
* size.
- *
+ *
* @param size the threshold size of the files - Must be non-negative.
*/
public SizeFileFilter(final long size) {
@@ -68,7 +68,7 @@ public class SizeFileFilter implements FileFilter,
Serializable {
/**
* Constructs a new size file filter for files based on a certain size
* threshold.
- *
+ *
* @param size the threshold size of the files - Must be
non-negative.
* @param acceptLarger if true, files equal to or larger are accepted,
otherwise
* smaller ones (but not equal to)
@@ -89,9 +89,9 @@ public class SizeFileFilter implements FileFilter,
Serializable {
* <b>IS</b> selected.
* <p>
* Non-existing files return always false (will never be accepted).
- *
+ *
* @param fileInfo the File to check
- *
+ *
* @return true if the filename matches
* @throws FileSystemException Thrown for file system errors.
*/
@@ -110,7 +110,7 @@ public class SizeFileFilter implements FileFilter,
Serializable {
/**
* Provide a String representation of this file filter.
- *
+ *
* @return a String representation
*/
@Override
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 a207c3f..7ae0fd8 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
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -25,7 +25,7 @@ import org.apache.commons.vfs2.FileSystemException;
/**
* Filter that accepts files whose size is >= minimum size and <= maximum
* size.
- *
+ *
* @since 2.4
*/
public class SizeRangeFileFilter implements FileFilter, Serializable {
@@ -36,7 +36,7 @@ public class SizeRangeFileFilter implements FileFilter,
Serializable {
/**
* Constructor with sizes.
- *
+ *
* @param minSizeInclusive the minimum file size (inclusive)
* @param maxSizeInclusive the maximum file size (inclusive)
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SuffixFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SuffixFileFilter.java
index a650119..fb1e3da 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SuffixFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/SuffixFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -30,7 +30,7 @@ import org.apache.commons.vfs2.FileSelectInfo;
* <p>
* For example, to retrieve and print all <code>*.java</code> files in the
* current directory:
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -39,7 +39,7 @@ import org.apache.commons.vfs2.FileSelectInfo;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
@@ -56,7 +56,7 @@ public class SuffixFileFilter implements FileFilter,
Serializable {
/**
* Constructs a new Suffix file filter for a list of suffixes.
- *
+ *
* @param suffixes the suffixes to allow, must not be null
*/
public SuffixFileFilter(final List<String> suffixes) {
@@ -66,7 +66,7 @@ public class SuffixFileFilter implements FileFilter,
Serializable {
/**
* Constructs a new Suffix file filter for a list of suffixes specifying
* case-sensitivity.
- *
+ *
* @param suffixes the suffixes to allow, must not be null
* @param caseSensitivity how to handle case sensitivity, null means
* case-sensitive
@@ -81,7 +81,7 @@ public class SuffixFileFilter implements FileFilter,
Serializable {
/**
* Constructs a new Suffix file filter for an array of suffixes.
- *
+ *
* @param suffixes the suffixes to allow, must not be null
*/
public SuffixFileFilter(final String... suffixes) {
@@ -91,7 +91,7 @@ public class SuffixFileFilter implements FileFilter,
Serializable {
/**
* Constructs a new Suffix file filter for an array of suffixs specifying
* case-sensitivity.
- *
+ *
* @param suffixes the suffixes to allow, must not be null
* @param caseSensitivity how to handle case sensitivity, null means
* case-sensitive
@@ -106,9 +106,9 @@ public class SuffixFileFilter implements FileFilter,
Serializable {
/**
* Checks to see if the filename ends with the suffix.
- *
+ *
* @param fileInfo the File to check
- *
+ *
* @return true if the filename ends with one of our suffixes
*/
@Override
@@ -124,7 +124,7 @@ public class SuffixFileFilter implements FileFilter,
Serializable {
/**
* Provide a String representation of this file filter.
- *
+ *
* @return a String representation
*/
@Override
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/TrueFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/TrueFileFilter.java
index f6e3b36..f87c62e 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/TrueFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/TrueFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -23,7 +23,7 @@ import org.apache.commons.vfs2.FileSelectInfo;
/**
* A file filter that always returns true.
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
@@ -45,9 +45,9 @@ public class TrueFileFilter implements FileFilter,
Serializable {
/**
* Returns true.
- *
+ *
* @param fileInfo the file to check (ignored)
- *
+ *
* @return Always {@code true}
*/
@Override
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/WildcardFileFilter.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/WildcardFileFilter.java
index b4a39e2..eb54025 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/WildcardFileFilter.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/filter/WildcardFileFilter.java
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -40,7 +40,7 @@ import org.apache.commons.vfs2.FileSelectInfo;
* For example, to retrieve and print all java files that have the expression
* test in the name in the current directory:
* </p>
- *
+ *
* <pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject dir = fsManager.toFileObject(new File("."));
@@ -50,7 +50,7 @@ import org.apache.commons.vfs2.FileSelectInfo;
* System.out.println(files[i]);
* }
* </pre>
- *
+ *
* @author This code was originally ported from Apache Commons IO File Filter
* @see "http://commons.apache.org/proper/commons-io/";
* @since 2.4
@@ -67,7 +67,7 @@ public class WildcardFileFilter implements FileFilter,
Serializable {
/**
* Construct a new case-sensitive wildcard filter for a list of wildcards.
- *
+ *
* @param wildcards the list of wildcards to match, not null
*/
public WildcardFileFilter(final List<String> wildcards) {
@@ -77,7 +77,7 @@ public class WildcardFileFilter implements FileFilter,
Serializable {
/**
* Construct a new wildcard filter for a list of wildcards specifying
* case-sensitivity.
- *
+ *
* @param caseSensitivity how to handle case sensitivity, null means
* case-sensitive
* @param wildcards the list of wildcards to match, not null
@@ -95,7 +95,7 @@ public class WildcardFileFilter implements FileFilter,
Serializable {
* <p>
* The array is not cloned, so could be changed after constructing the
instance.
* This would be inadvisable however.
- *
+ *
* @param wildcards the array of wildcards to match
*/
public WildcardFileFilter(final String... wildcards) {
@@ -105,7 +105,7 @@ public class WildcardFileFilter implements FileFilter,
Serializable {
/**
* Construct a new wildcard filter for an array of wildcards specifying
* case-sensitivity.
- *
+ *
* @param caseSensitivity how to handle case sensitivity, null means
* case-sensitive
* @param wildcards the array of wildcards to match, not null
@@ -120,9 +120,9 @@ public class WildcardFileFilter implements FileFilter,
Serializable {
/**
* Checks to see if the filename matches one of the wildcards.
- *
+ *
* @param fileInfo the file to check
- *
+ *
* @return true if the filename matches one of the wildcards
*/
@Override
@@ -138,7 +138,7 @@ public class WildcardFileFilter implements FileFilter,
Serializable {
/**
* Provide a String representation of this file filter.
- *
+ *
* @return a String representation
*/
@Override
@@ -161,7 +161,7 @@ public class WildcardFileFilter implements FileFilter,
Serializable {
/**
* Splits a string into a number of tokens. The text is split by '?' and
'*'.
* Where multiple '*' occur consecutively they are collapsed into a single
'*'.
- *
+ *
* @param text the text to split
* @return the array of tokens, never null
*/
@@ -209,12 +209,12 @@ public class WildcardFileFilter implements FileFilter,
Serializable {
* multiple (zero or more) wildcard characters. N.B. the sequence "*?"
does not
* work properly at present in match strings.
* </p>
- *
+ *
* @param filename the filename to match on
* @param wildcardMatcher the wildcard string to match against
* @param caseSensitivity what case sensitivity rule to use, null means
* case-sensitive
- *
+ *
* @return true if the filename matches the wilcard string
*/
// CHECKSTYLE:OFF TODO xxx Cyclomatic complexity of 19 should be refactored
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileSystem.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileSystem.java
index f1c19b7..a19e97e 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileSystem.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileSystem.java
@@ -54,7 +54,7 @@ import org.apache.commons.vfs2.util.Messages;
* A partial {@link org.apache.commons.vfs2.FileSystem} implementation.
*/
public abstract class AbstractFileSystem extends AbstractVfsComponent
implements FileSystem {
-
+
private static final Log LOG = LogFactory.getLog(AbstractFileSystem.class);
/**
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.java
index 82feb3d..ca0c814 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.java
@@ -31,14 +31,14 @@ import
org.apache.commons.vfs2.provider.compressed.CompressedFileFileSystem;
* the bzip2 file.
*/
public class Bzip2FileObject extends CompressedFileFileObject<Bzip2FileSystem>
{
-
+
/**
* Deprecated since 2.1.
- *
+ *
* @param name Abstract file name.
* @param container My container.
* @param container My file system.
- *
+ *
* @deprecated Use {@link #Bzip2FileObject(AbstractFileName, FileObject,
Bzip2FileSystem)} instead.
*/
@Deprecated
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClient.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClient.java
index 549fe1e..90c6c91 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClient.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClient.java
@@ -28,7 +28,7 @@ import org.apache.commons.vfs2.FileSystemException;
* What VFS expects from an FTP client to provide.
*/
public interface FtpClient {
-
+
boolean isConnected() throws FileSystemException;
void disconnect() throws IOException;
@@ -56,7 +56,7 @@ public interface FtpClient {
boolean abort() throws IOException;
String getReplyString() throws IOException;
-
+
default int getReplyCode() throws IOException {
return FTPReply.COMMAND_OK;
}
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsClientFactory.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsClientFactory.java
index 5ecb4b6..dd3affc 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsClientFactory.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsClientFactory.java
@@ -33,7 +33,7 @@ import org.apache.commons.vfs2.provider.ftp.FtpClientFactory;
* @since 2.0
*/
public final class FtpsClientFactory {
-
+
private FtpsClientFactory() {
// empty
}
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileSystem.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileSystem.java
index 3ce58f8..520fb47 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileSystem.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileSystem.java
@@ -28,7 +28,7 @@ import org.apache.commons.vfs2.provider.ftp.FtpFileSystem;
* @since 2.1
*/
public class FtpsFileSystem extends FtpFileSystem {
-
+
/**
* Creates a new FtpsFileSystem.
*
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileObject.java
index 463df0f..13d96c8 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/gzip/GzipFileObject.java
@@ -33,11 +33,11 @@ public class GzipFileObject extends
CompressedFileFileObject<GzipFileSystem> {
/**
* Deprecated since 2.1.
- *
+ *
* @param name Abstract file name.
* @param container My container.
* @param container My file system.
- *
+ *
* @deprecated Use {@link #GzipFileObject(AbstractFileName, FileObject,
GzipFileSystem)} instead.
*/
@Deprecated
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 aaa833f..f0eae7a 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
@@ -22,7 +22,7 @@ import com.jcraft.jsch.JSchException;
/**
* Structure for an identity based on byte arrays.
- *
+ *
* @since 2.4
*/
public class BytesIdentityInfo implements IdentityProvider {
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 a5690a2..fa58800 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
@@ -22,7 +22,7 @@ import com.jcraft.jsch.JSchException;
/**
* Provides identity to a {@link JSch}.
- *
+ *
* @since 2.4
*/
public interface IdentityProvider {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/IdentityRepositoryFactory.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/IdentityRepositoryFactory.java
index 79f0339..d9ecfc2 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/IdentityRepositoryFactory.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/IdentityRepositoryFactory.java
@@ -24,7 +24,7 @@ import com.jcraft.jsch.JSch;
*
*/
public interface IdentityRepositoryFactory {
-
+
/**
* Creates an Identity repository for a given JSch instance.
*
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpClientFactory.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpClientFactory.java
index df43f91..3fdfdba 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpClientFactory.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpClientFactory.java
@@ -125,7 +125,7 @@ public final class SftpClientFactory {
config.setProperty("compression.s2c", compression);
config.setProperty("compression.c2s", compression);
}
-
+
final String keyExchangeAlgorithm =
builder.getKeyExchangeAlgorithm(fileSystemOptions);
if (keyExchangeAlgorithm != null) {
config.setProperty("kex", keyExchangeAlgorithm);
@@ -260,13 +260,13 @@ public final class SftpClientFactory {
* <li>On Windows only: {@code C:\cygwin\home[user.name]\.ssh}</li>
* <li>The current directory, as a last resort.</li>
* </ol>
- *
+ *
* <h2>Windows Notes</h2>
* <p>
* The default installation directory for Cygwin is {@code C:\cygwin}. On
my set up (Gary here), I have Cygwin in
* {@code C:\bin\cygwin}, not the default. Also, my .ssh directory was
created in the {@code user.home} directory.
* </p>
- *
+ *
* @return The {@code .ssh} directory
*/
private static File findSshDir() {
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 28be938..c180c68 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
@@ -689,7 +689,7 @@ public final class SftpFileSystemConfigBuilder extends
FileSystemConfigBuilder {
/**
** Configure Key exchange algoritm explicitly e.g
*
diffie-hellman-group14-sha1,diffie-hellman-group-exchange-sha256,diffie-hellman-group-exchange-sha1,diffie-hellman-group1-sha1
- *
+ *
* @param opts The FileSystem options.
* @param keyExchangeAlgoritm The key exchange algoritm picked.
**/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpStreamProxy.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpStreamProxy.java
index 8106653..38392b1 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpStreamProxy.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpStreamProxy.java
@@ -106,7 +106,7 @@ public class SftpStreamProxy implements Proxy {
* @param commandFormat A format string that will be used to create the
command to execute on the proxy host using
* {@linkplain String#format(String, Object...)}. Two
parameters are given to the format command, the
* target host name (String) and port (Integer).
- *
+ *
* @param proxyUser The proxy user
* @param proxyPassword The proxy password
* @param proxyHost The proxy host
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileObject.java
index aa43659..c7bc20d 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileObject.java
@@ -48,7 +48,7 @@ public class TarFileObject extends
AbstractFileObject<TarFileSystem> {
* Sets the details for this file object.
*
* Consider this method package private. TODO Might be made package
private in the next major version.
- *
+ *
* @param entry Tar archive entry.
*/
protected void setTarEntry(final TarArchiveEntry entry) {
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 82f67c8..77174ef 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
@@ -59,11 +59,11 @@ public class ZipFileSystem extends AbstractFileSystem {
public ZipFileSystem(final AbstractFileName rootName, final FileObject
parentLayer,
final FileSystemOptions fileSystemOptions) throws
FileSystemException {
super(rootName, parentLayer, fileSystemOptions);
-
+
// Make a local copy of the file
file = parentLayer.getFileSystem().replicateFile(parentLayer,
Selectors.SELECT_SELF);
this.charset =
ZipFileSystemConfigBuilder.getInstance().getCharset(fileSystemOptions);
-
+
// Open the Zip file
if (!file.exists()) {
// Don't need to do anything
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 3eb4229..6bee81c 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
@@ -28,19 +28,19 @@ public class ZipFileSystemConfigBuilder extends
FileSystemConfigBuilder {
private static final String _PREFIX =
ZipFileSystemConfigBuilder.class.getName();
private static final ZipFileSystemConfigBuilder INSTANCE = new
ZipFileSystemConfigBuilder();
private static final String KEY_CHARSET = _PREFIX + ".charset";
-
+
public static final ZipFileSystemConfigBuilder getInstance() {
return INSTANCE;
}
-
+
private ZipFileSystemConfigBuilder() {
super("zip.");
}
-
+
public Charset getCharset(final FileSystemOptions opts) {
return (Charset) getParam(opts, KEY_CHARSET);
}
-
+
@Override
protected Class<? extends FileSystem> getConfigClass() {
return ZipFileSystem.class;
