You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ec...@apache.org on 2014/05/01 02:33:44 UTC
svn commit: r1591516 [1/2] - in /commons/proper/vfs/trunk:
core/src/main/java/org/apache/commons/vfs2/
core/src/main/java/org/apache/commons/vfs2/impl/
core/src/main/java/org/apache/commons/vfs2/provider/
core/src/main/java/org/apache/commons/vfs2/prov...
Author: ecki
Date: Thu May 1 00:33:43 2014
New Revision: 1591516
URL: http://svn.apache.org/r1591516
Log:
[VFS-520] Make javadoc compatible with javadoc tool from java 8. (there are still 100 warnings mostly about missing @return and @param)
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileContent.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileFilterSelector.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileListener.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileName.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileObject.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSelectInfo.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSelector.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystem.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystemManager.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/NameScope.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/DefaultFileMonitor.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/DefaultFileReplicator.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/StandardFileSystemManager.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/VirtualFileSystem.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileName.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileSystem.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/DefaultFileContent.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/FileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/FileReplicator.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/HostFileNameParser.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/LayeredFileNameParser.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/LocalFileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/URLFileNameParser.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftp/FTPClientWrapper.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystemConfigBuilder.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsClientWrapper.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileObject.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpClientFactory.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileObject.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpStreamProxy.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileNameParser.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileObject.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileObject.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavMethodRetryHandler.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileObject.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/tasks/CopyTask.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/tasks/DeleteTask.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/tasks/MoveTask.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/util/MonitorOutputStream.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/util/WeakRefFileListener.java
commons/proper/vfs/trunk/core/src/test/java/org/apache/commons/vfs2/provider/local/test/ConversionTestCase.java
commons/proper/vfs/trunk/core/src/test/java/org/apache/commons/vfs2/test/AbstractProviderTestCase.java
commons/proper/vfs/trunk/core/src/test/java/org/apache/commons/vfs2/test/NamingTests.java
commons/proper/vfs/trunk/core/src/test/java/org/apache/commons/vfs2/test/ProviderReadTests.java
commons/proper/vfs/trunk/core/src/test/java/org/apache/commons/vfs2/test/UrlTests.java
commons/proper/vfs/trunk/sandbox/src/main/java/org/apache/commons/vfs2/provider/mime/MimeFileObject.java
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileContent.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileContent.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileContent.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileContent.java Thu May 1 00:33:43 2014
@@ -145,8 +145,8 @@ public interface FileContent extends Clo
/**
* Returns an input stream for reading the file's content.
- * <p/>
- * <p>There may only be a single input or output stream open for the
+ * <p>
+ * There may only be a single input or output stream open for the
* file at any time.
*
* @return An input stream to read the file's content from. The input
@@ -159,12 +159,12 @@ public interface FileContent extends Clo
/**
* Returns an output stream for writing the file's content.
- * <p/>
+ * <p>
* If the file does not exist, this method creates it, and the parent
* folder, if necessary. If the file does exist, it is replaced with
* whatever is written to the output stream.
- * <p/>
- * <p>There may only be a single input or output stream open for the
+ * <p>
+ * There may only be a single input or output stream open for the
* file at any time.
*
* @return An output stream to write the file's content to. The stream is
@@ -177,13 +177,13 @@ public interface FileContent extends Clo
/**
* Returns an stream for reading/writing the file's content.
- * <p/>
+ * <p>
* If the file does not exist, and you use one of the write* methods,
* this method creates it, and the parent folder, if necessary.
* If the file does exist, parts of the file are replaced with whatever is written
* at a given position.
- * <p/>
- * <p>There may only be a single input or output stream open for the
+ * <p>
+ * There may only be a single input or output stream open for the
* file at any time.
*
* @param mode The mode to use to access the file.
@@ -195,12 +195,12 @@ public interface FileContent extends Clo
/**
* Returns an output stream for writing the file's content.
- * <p/>
+ * <p>
* If the file does not exist, this method creates it, and the parent
* folder, if necessary. If the file does exist, it is replaced with
* whatever is written to the output stream.
- * <p/>
- * <p>There may only be a single input or output stream open for the
+ * <p>
+ * There may only be a single input or output stream open for the
* file at any time.
*
* @param bAppend true if you would like to append to the file.
@@ -217,10 +217,11 @@ public interface FileContent extends Clo
/**
* Closes all resources used by the content, including any open stream.
* Commits pending changes to the file.
- * <p/>
- * <p>This method is a hint to the implementation that it can release
+ * <p>
+ * This method is a hint to the implementation that it can release
* resources. This object can continue to be used after calling this
* method.
+ *
* @throws FileSystemException if an error occurs closing the file.
*/
@Override
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileFilterSelector.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileFilterSelector.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileFilterSelector.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileFilterSelector.java Thu May 1 00:33:43 2014
@@ -19,8 +19,9 @@ package org.apache.commons.vfs2;
import org.apache.commons.vfs2.util.Messages;
/**
- * A {@link org.apache.commons.vfs2.FileSelector} that selects all children of the given fileObject.<br />
- * This is to mimic the {@link java.io.FileFilter} interface
+ * 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.
*/
public class FileFilterSelector extends FileDepthSelector
{
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileListener.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileListener.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileListener.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileListener.java Thu May 1 00:33:43 2014
@@ -23,6 +23,7 @@ public interface FileListener
{
/**
* Called when a file is created.
+ *
* @param event The FileChangeEvent.
* @throws Exception if an error occurs.
*/
@@ -30,14 +31,17 @@ public interface FileListener
/**
* Called when a file is deleted.
+ *
* @param event The FileChangeEvent.
* @throws Exception if an error occurs.
*/
void fileDeleted(FileChangeEvent event) throws Exception;
/**
- * Called when a file is changed.<br />
+ * Called when a file is changed.
+ * <p>
* This will only happen if you monitor the file using {@link FileMonitor}.
+ *
* @param event The FileChangeEvent.
* @throws Exception if an error occurs.
*/
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileName.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileName.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileName.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileName.java Thu May 1 00:33:43 2014
@@ -204,15 +204,13 @@ public interface FileName extends Compar
boolean isFile() throws FileSystemException;
/**
- * Returns the requested or current type of this name. <br />
+ * Returns the requested or current type of this name.
* <p>
- * The "requested" type is the one determined during resolving the name. <br/>
+ * 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}<br/>
- * </p>
+ * it will be a {@link FileType#FILE}.
* <p>
* Once attached it will be changed to reflect the real type of this resource.
- * </p>
*
* @return {@link FileType#FOLDER} or {@link FileType#FILE}
*/
@@ -221,8 +219,7 @@ public interface FileName extends Compar
/**
* Returns a "friendly path", this is a path without a password.
* <p>
- * This path can not be used to resolve the path again
- * </p>
+ * This path can not be used to resolve the path again.
*
* @return the friendly URI as a String.
*/
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileObject.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileObject.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileObject.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileObject.java Thu May 1 00:33:43 2014
@@ -27,52 +27,54 @@ import org.apache.commons.vfs2.operation
/**
* Represents a file, and is used to access the content and
* structure of the file.
- * <p/>
- * <p>Files are arranged in a hierarchy. Each hierarchy forms a
+ * <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,
+ * <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/>
- * <h4>File Naming</h4>
- * <p/>
- * <p>TODO - write this.
- * <p/>
- * <h4>Reading and Writing a File</h4>
- * <p/>
- * <p>Reading and writing a file, and all other operations on the file's
+ *
+ * <h2>File Naming</h2>
+ *
+ * TODO - write this.
+ *
+ * <h2>Reading and Writing a File</h2>
+ *
+ * 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/>
- * <h4>Creating and Deleting a File</h4>
- * <p/>
- * <p>A file is created using either {@link #createFolder}, {@link #createFile},
+
+ * <h2>Creating and Deleting a File</h2>
+ *
+ * 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
+ * <p>
+ * A file is deleted using {@link #delete}. Recursive deletion can be
* done using {@link #delete(FileSelector)}.
- * <p/>
- * <h4>Finding Files</h4>
- * <p/>
- * <p>Other files in the <i>same</i> file system as this file can be found
+ *
+ * <h2>Finding Files</h2>
+ *
+ * Other files in the <i>same</i> file system as this file can be found
* using:
* <ul>
- * <li>{@link #findFiles} to find a set of matching descendants in in the same file system.
- * <li>{@link #getChildren} and {@link #getChild} to find the children of this file.
- * <li>{@link #getParent} to find the folder containing this file.
- * <li>{@link #getFileSystem} to find another file in the same file system.
- * <li>{@link #resolveFile} to find another file relative to this file.
+ * <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>
+ * <li>{@link #getParent} to find the folder containing this file.</li>
+ * <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/>
- * <p>To find files in another file system, use a {@link FileSystemManager}.
- * <h4>Iterating Files</h4>
- *<p>You can iterate over a FileObject using the Java "foreach" statement, which provides all descendants of a File
- * Object.</p>
+ * To find files in another file system, use a {@link FileSystemManager}.
+ *
+ * <h2>Iterating Files</h2>
*
- * <h4>Sorting Files</h4>
- *<p>Files may be sorted using {@link Arrays#sort(Object[])} and {@link Collections#sort(List)}.</p>
+ * You can iterate over a FileObject using the Java "foreach" statement, which provides all descendants of a File
+ * Object.
+ *
+ * <h2>Sorting Files</h2>
+ *
+ * Files may be sorted using {@link Arrays#sort(Object[])} and {@link Collections#sort(List)}.
*
* @see FileSystemManager
* @see FileContent
@@ -276,7 +278,7 @@ public interface FileObject extends Comp
/**
* Returns the receiver as a URI String for public display, like, without a
* password.
- *
+ *
* @return A URI String without a password, never {@code null}.
*/
String getPublicURIString();
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSelectInfo.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSelectInfo.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSelectInfo.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSelectInfo.java Thu May 1 00:33:43 2014
@@ -19,8 +19,8 @@ package org.apache.commons.vfs2;
/**
* Information about a file, that is used to select files during the
* traversal of a hierarchy.
- *
- * @todo Rename this interface, as it is used by both FileSelector and FileVisitor.
+ * <p>
+ * TODO - Rename this interface, as it is used by both FileSelector and FileVisitor.
*/
public interface FileSelectInfo
{
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSelector.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSelector.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSelector.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSelector.java Thu May 1 00:33:43 2014
@@ -39,8 +39,8 @@ public interface FileSelector
* Determines whether a folder should be traversed. If this method returns
* true, {@link #includeFile} is called for each of the children of
* the folder, and each of the child folders is recursively traversed.
- * <p/>
- * <p>This method is called on a folder before {@link #includeFile}
+ * <p>
+ * This method is called on a folder before {@link #includeFile}
* is called.
*
* @param fileInfo the file or folder to select.
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystem.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystem.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystem.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystem.java Thu May 1 00:33:43 2014
@@ -45,12 +45,13 @@ 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.
*
* @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 the
* capability.
- * @todo Move this to another interface, so that set of capabilities can be queried.
*/
boolean hasCapability(Capability capability);
@@ -64,10 +65,9 @@ public interface FileSystem
/**
* Gets the value of an attribute of the file system.
- * <p/>
- * <p>TODO - change to {@code Map getAttributes()} instead?
- * <p/>
- * <p>TODO - define the standard attribute names, and define which attrs
+ * <p>
+ * TODO - change to {@code Map getAttributes()} instead?<br>
+ * TODO - define the standard attribute names, and define which attrs
* are guaranteed to be present.
*
* @param attrName The name of the attribute.
@@ -151,18 +151,19 @@ public interface FileSystem
/**
* Creates a temporary local copy of a file and its descendants. If
* this file is already a local file, a copy is not made.
- * <p/>
- * <p>Note that the local copy may include additonal files, that were
+ * <p>
+ * Note that the local copy may include additonal files, that were
* not selected by the given selector.
+ * <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.
*
* @param file The file to replicate.
* @param selector The selector to use to select the files to replicate.
* @return The local copy of this file.
* @throws FileSystemException If this file does not exist, or on error replicating the file.
- * @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.
*/
File replicateFile(FileObject file, FileSelector selector)
throws FileSystemException;
@@ -182,7 +183,7 @@ public interface FileSystem
/**
* Returns the accuracy of the last modification time.
*
- * @return ms 0 perfectly accurate, >0 might be off by this value e.g. sftp 1000ms.
+ * @return ms 0 perfectly accurate, {@literal >0} might be off by this value e.g. sftp 1000ms.
*/
double getLastModTimeAccuracy();
}
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystemManager.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystemManager.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystemManager.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystemManager.java Thu May 1 00:33:43 2014
@@ -29,48 +29,38 @@ import org.apache.commons.vfs2.operation
/**
* A FileSystemManager manages a set of file systems. This interface is
* used to locate a {@link FileObject} by name from one of those file systems.
- * <p/>
- * <p>To locate a {@link FileObject}, use one of the {@code resolveFile()}
- * methods.</p>
- * <p/>
- * <h4><a name="naming">File Naming</a></h4>
- * <p/>
- * <p>A file system manager can recognise several types of file names:
- * <p/>
+ * <p>
+ * To locate a {@link FileObject}, use one of the {@code resolveFile()}
+ * methods.
+ *
+ * <h2><a name="naming">File Naming</a></h2>
+ *
+ * A file system manager can recognise several types of file names:
* <ul>
- * <p/>
- * <li><p>Absolute URI. These must start with a scheme, such as
+ * <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:</p>
- * <pre>
- * file:/c:/somefile
- * ftp://somewhere.org/somefile
- * </pre>
- * <p/>
- * <li><p>Absolute local file name. For example,
+ * file name. Some examples: {@code file:/c:/somefile} or
+ * {@code ftp://somewhere.org/somefile}.</li>
+ * <li>Absolute local file name. For example,
* {@code /home/someuser/a-file} or {@code c:\dir\somefile.html}.
* Elements in the name can be separated using any of the following
* characters: {@code /}, {@code \}, or the native file separator
- * character. For example, the following file names are the same:</p>
- * <pre>
- * c:\somedir\somefile.xml
- * c:/somedir/somefile.xml
- * </pre>
- * <p/>
- * <li><p>Relative path. For example: {@code ../somefile} or
- * {@code somedir/file.txt}. The file system manager resolves relative
+ * character. For example, the following file names are the same:
+ * {@code c:\somedir\somefile.xml} and {@code c:/somedir/somefile.xml}.</li>
+ * <li>Relative path. For example: {@code ../somefile} or
+ * {@code somedir/file.txt}. The file system manager resolves relative
* paths against its <i>base file</i>. Elements in the relative path can be
* separated using {@code /}, {@code \}, or file system specific
- * separator characters. Relative paths may also contain {@code ..} and
- * {@code .} elements. See {@link FileObject#resolveFile} for more
- * details.</p>
- * <p/>
+ * separator characters. Relative paths may also contain {@code ..} and
+ * {@code .} elements. See {@link FileObject#resolveFile} for more
+ * details.</li>
* </ul>
*/
public interface FileSystemManager
{
/**
* Returns the base file used to resolve relative paths.
+ *
* @return The base FileObject.
* @throws FileSystemException if an error occurs.
*/
@@ -103,8 +93,8 @@ public interface FileSystemManager
* <a href="#naming">above</a>. That is, the name can be either
* an absolute URI, an absolute file name, or a relative path to
* be resolved against {@code baseFile}.
- * <p/>
- * <p>Note that the file does not have to exist when this method is called.
+ * <p>
+ * Note that the file does not have to exist when this method is called.
*
* @param name The name of the file.
* @param baseFile The base file to use to resolve relative paths.
@@ -174,8 +164,10 @@ public interface FileSystemManager
throws FileSystemException;
/**
- * Closes the given filesystem.<br />
+ * Closes the given filesystem.
+ * <P>
* If you use VFS as singleton it is VERY dangerous to call this method.
+ *
* @param filesystem The FileSystem to close.
*/
void closeFileSystem(FileSystem filesystem);
@@ -213,6 +205,7 @@ public interface FileSystemManager
/**
* Returns a streamhandler factory to enable URL lookup using this
* FileSystemManager.
+ *
* @return the URLStreamHandlerFactory.
*/
URLStreamHandlerFactory getURLStreamHandlerFactory();
@@ -228,18 +221,21 @@ public interface FileSystemManager
/**
* Get the cache used to cache fileobjects.
+ *
* @return The FilesCache.
*/
FilesCache getFilesCache();
/**
* Get the cache strategy used.
+ *
* @return the CacheStrategy.
*/
CacheStrategy getCacheStrategy();
/**
* Get the file object decorator used.
+ *
* @return the file object decorator Class.
*/
Class<?> getFileObjectDecorator();
@@ -247,18 +243,21 @@ public interface FileSystemManager
/**
* The constructor associated to the fileObjectDecorator.
* We cache it here for performance reasons.
+ *
* @return the Constructor associated with the FileObjectDecorator.
*/
Constructor<?> getFileObjectDecoratorConst();
/**
* The class to use to determine the content-type (mime-type).
+ *
* @return the FileContentInfoFactory.
*/
FileContentInfoFactory getFileContentInfoFactory();
/**
* Returns true if this manager has a provider for a particular scheme.
+ *
* @param scheme The scheme for which a provider should be checked.
* @return true if a provider for the scheme is available.
*/
@@ -266,6 +265,7 @@ public interface FileSystemManager
/**
* Get the schemes currently available.
+ *
* @return An array of available scheme names that are supported.
*/
String[] getSchemes();
@@ -281,6 +281,7 @@ public interface FileSystemManager
/**
* Sets the logger to use.
+ *
* @param log The logger to use.
*/
void setLogger(final Log log);
@@ -306,9 +307,10 @@ public interface FileSystemManager
// -- OPERATIONS --
/**
* Adds the specified FileOperationProvider for the specified scheme.
+ * <p>
* Several FileOperationProvider's might be registered for the same scheme.
- * For example, for "file" scheme we can register SvnWsOperationProvider and
- * CvsOperationProvider.
+ * For example, for {@code "file"} scheme we can register {@code SvnWsOperationProvider} and
+ * {@code CvsOperationProvider.}
*
* @param scheme The scheme assoicated with this provider.
* @param operationProvider The FileOperationProvider to add.
@@ -329,6 +331,8 @@ public interface FileSystemManager
/**
+ * Get Providers for file operations.
+ *
* @param scheme the scheme for wich we want to get the list af registered providers.
*
* @return the registered FileOperationProviders for the specified scheme.
@@ -337,7 +341,7 @@ public interface FileSystemManager
* @throws FileSystemException if an error occurs.
*/
FileOperationProvider[] getOperationProviders(final String scheme) throws FileSystemException;
-
+
/**
* Resolves a URI into a {@link FileObject}.
*
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/NameScope.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/NameScope.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/NameScope.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/NameScope.java Thu May 1 00:33:43 2014
@@ -46,17 +46,17 @@ public enum NameScope
/**
* Resolve against files in the same file system as the base file.
- * <p/>
- * <p>If the supplied name is an absolute path, then it is resolved
+ * <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
+ * <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,
+ * <p>
+ * A path is considered absolute if it starts with a separator character,
* and relative if it does not.
*/
FILE_SYSTEM("filesystem");
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/DefaultFileMonitor.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/DefaultFileMonitor.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/DefaultFileMonitor.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/DefaultFileMonitor.java Thu May 1 00:33:43 2014
@@ -30,18 +30,16 @@ import org.apache.commons.vfs2.FileSyste
import org.apache.commons.vfs2.provider.AbstractFileSystem;
/**
- * A polling {@link FileMonitor} implementation.<br />
- * <br />
- * The DefaultFileMonitor is a Thread based polling file system monitor with a 1
- * second delay.<br />
- * <br />
- * <b>Design:</b>
+ * A polling {@link FileMonitor} implementation.
* <p>
+ * The DefaultFileMonitor is a Thread based polling file system monitor with a 1
+ * second delay.
+ *
+ * <h2>Design:</h2>
+ *
* There is a Map of monitors known as FileMonitorAgents. With the thread running,
* each FileMonitorAgent object is asked to "check" on the file it is
- * responsible for.
- * To do this check, the cache is cleared.
- * </p>
+ * responsible for. To do this check, the cache is cleared.
* <ul>
* <li>If the file existed before the refresh and it no longer exists, a delete
* event is fired.</li>
@@ -49,31 +47,28 @@ import org.apache.commons.vfs2.provider.
* last modified timestamp to see if that has changed.</li>
* <li>If it has, fire a change event.</li>
* </ul>
- * <p>
* With each file delete, the FileMonitorAgent of the parent is asked to
* re-build its
* list of children, so that they can be accurately checked when there are new
- * children.<br/>
+ * children.
+ * <p>
* New files are detected during each "check" as each file does a check for new
* children.
* If new children are found, create events are fired recursively if recursive
- * descent is
- * enabled.
- * </p>
+ * descent is enabled.
* <p>
* For performance reasons, added a delay that increases as the number of files
* monitored
* increases. The default is a delay of 1 second for every 1000 files processed.
- * </p>
- * <br /><b>Example usage:</b><br /><pre>
+ *
+ * <h2>Example usage:</h2><pre>
* FileSystemManager fsManager = VFS.getManager();
* FileObject listendir = fsManager.resolveFile("/home/username/monitored/");
- * <p/>
+ *
* DefaultFileMonitor fm = new DefaultFileMonitor(new CustomFileListener());
* fm.setRecursive(true);
* fm.addFile(listendir);
- * fm.start();
- * </pre>
+ * fm.start();</pre>
* <i>(where CustomFileListener is a class that implements the FileListener
* interface.)</i>
*/
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/DefaultFileReplicator.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/DefaultFileReplicator.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/DefaultFileReplicator.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/DefaultFileReplicator.java Thu May 1 00:33:43 2014
@@ -41,7 +41,7 @@ public class DefaultFileReplicator
{
private static final Log log = LogFactory.getLog(DefaultFileReplicator.class);
private static final int MASK = 0xffff;
-
+
private static final Random random = new Random();
private static final char[] TMP_RESERVED_CHARS = new char[]
@@ -59,7 +59,7 @@ public class DefaultFileReplicator
}
/**
- * constructor to set the location of the temporary directory.
+ * Constructor to set the location of the temporary directory.
*
* @param tempDir The temporary directory.
*/
@@ -78,6 +78,7 @@ public class DefaultFileReplicator
/**
* Allocates a new temporary file.
+ *
* @param baseName the base file name.
* @return The created File.
* @throws FileSystemException if an error occurs.
@@ -130,7 +131,8 @@ public class DefaultFileReplicator
}
/**
- * create the temporary file
+ * Create the temporary file.
+ *
* @param parent The file to use as the parent of the file being created.
* @param name The name of the file to create.
* @return The File that was created.
@@ -142,7 +144,8 @@ public class DefaultFileReplicator
}
/**
- * create the temporary file name
+ * Create the temporary file name.
+ *
* @param baseName The base to prepend to the file name being created.
* @return the name of the File.
*/
@@ -158,7 +161,8 @@ public class DefaultFileReplicator
}
/**
- * physically deletes the file from the filesystem
+ * Physically deletes the file from the filesystem.
+ *
* @param file The File to delete.
*/
protected void deleteFile(final File file)
@@ -182,6 +186,7 @@ public class DefaultFileReplicator
/**
* Initializes this component.
+ *
* @throws FileSystemException if an error occurs.
*/
@Override
@@ -206,8 +211,10 @@ public class DefaultFileReplicator
}
/**
- * removes a file from the copies list. Will be used for cleanup. <br/>
- * Notice: The system awaits that the returning object can be cast to a java.io.File
+ * Removes a file from the copies list. Will be used for cleanup.
+ * <p>
+ * Notice: The system awaits that the returning object can be cast to a {@link java.io.File}.
+ *
* @return the File that was removed.
*/
protected Object removeFile()
@@ -219,7 +226,8 @@ public class DefaultFileReplicator
}
/**
- * removes a instance from the list of copies
+ * Removes a instance from the list of copies.
+ *
* @param file The File to remove.
*/
protected void removeFile(final Object file)
@@ -232,6 +240,7 @@ public class DefaultFileReplicator
/**
* Creates a local copy of the file, and all its descendants.
+ *
* @param srcFile The file to copy.
* @param selector The FileSelector.
* @return the created File.
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemManager.java Thu May 1 00:33:43 2014
@@ -59,8 +59,6 @@ import org.apache.commons.vfs2.provider.
/**
* The default file system manager implementation.
- *
- * @version $Id$
*/
public class DefaultFileSystemManager implements FileSystemManager
{
@@ -270,13 +268,10 @@ public class DefaultFileSystemManager im
}
/**
- * <p>
* Set the cache strategy to use when dealing with file object data. You can
* set it only once before the FileSystemManager is initialized.
- * <p />
* <p>
* The default is {@link CacheStrategy#ON_RESOLVE}
- * </p>
*
* @param fileCacheStrategy The CacheStrategy to use.
* @throws FileSystemException
@@ -1009,8 +1004,10 @@ public class DefaultFileSystemManager im
}
/**
- * Closes the given filesystem.<br />
- * If you use VFS as singleton it is VERY dangerous to call this method
+ * Closes the given filesystem.
+ * <p>
+ * If you use VFS as singleton it is VERY dangerous to call this method.
+ *
* @param filesystem The FileSystem to close.
*/
@Override
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/StandardFileSystemManager.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/StandardFileSystemManager.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/StandardFileSystemManager.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/StandardFileSystemManager.java Thu May 1 00:33:43 2014
@@ -128,8 +128,10 @@ public class StandardFileSystemManager
}
/**
- * Scans the classpath to find any droped plugin.<br />
- * The plugin-description has to be in /META-INF/vfs-providers.xml
+ * Scans the classpath to find any droped plugin.
+ * <p>
+ * The plugin-description has to be in {@code /META-INF/vfs-providers.xml}.
+ *
* @throws FileSystemException if an error occurs.
*/
protected void configurePlugins() throws FileSystemException
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/VirtualFileSystem.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/VirtualFileSystem.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/VirtualFileSystem.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/VirtualFileSystem.java Thu May 1 00:33:43 2014
@@ -34,8 +34,8 @@ import org.apache.commons.vfs2.provider.
/**
* A logical file system, made up of set of junctions, or links, to files from
* other file systems.
- *
- * @todo Handle nested junctions.
+ * <p>
+ * TODO - Handle nested junctions.
*/
public class VirtualFileSystem extends AbstractFileSystem
{
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileName.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileName.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileName.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileName.java Thu May 1 00:33:43 2014
@@ -270,7 +270,7 @@ public abstract class AbstractFileName i
/**
* Returns the URI without a password.
- *
+ *
* @return Returns the URI without a password.
*/
@Override
@@ -477,15 +477,13 @@ public abstract class AbstractFileName i
}
/**
- * Returns the requested or current type of this name. <br />
+ * Returns the requested or current type of this name.
* <p>
- * The "requested" type is the one determined during resolving the name. <br/>
- * In this case the name is a {@link FileType#FOLDER} if it ends with an "/" else
- * it will be a {@link FileType#FILE}<br/>
- * </p>
+ * The "requested" type is the one determined during resolving the name.
+ * n this case the name is a {@link FileType#FOLDER} if it ends with an "/" else
+ * it will be a {@link FileType#FILE}.
* <p>
* Once attached it will be changed to reflect the real type of this resource.
- * </p>
*
* @return {@link FileType#FOLDER} or {@link FileType#FILE}
*/
@@ -496,7 +494,7 @@ public abstract class AbstractFileName i
}
/**
- * sets the type of this file e.g. when it will be attached.
+ * Sets the type of this file e.g. when it will be attached.
*
* @param type {@link FileType#FOLDER} or {@link FileType#FILE}
* @throws FileSystemException if an error occurs.
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java Thu May 1 00:33:43 2014
@@ -55,15 +55,19 @@ import org.apache.commons.vfs2.util.Rand
/**
* A partial file object implementation.
- * @param <AFS> An AbstractFileSystem subclass
*
- * @todo Chop this class up - move all the protected methods to several
- * interfaces, so that structure and content can be separately overridden.
- * @todo Check caps in methods like getChildren(), etc, and give better error messages
- * (eg 'this file type does not support listing children', vs 'this is not a folder')
+ * @param <AFS> An AbstractFileSystem subclass
*/
public abstract class AbstractFileObject<AFS extends AbstractFileSystem> implements FileObject
{
+ /*
+ * TODO - Chop this class up - move all the protected methods to several
+ * interfaces, so that structure and content can be separately overridden.
+ *
+ * TODO - Check caps in methods like getChildren(), etc, and give better error messages
+ * (eg 'this file type does not support listing children', vs 'this is not a folder')
+ */
+
// private static final FileObject[] EMPTY_FILE_ARRAY = {};
private static final FileName[] EMPTY_FILE_ARRAY = {};
@@ -278,7 +282,7 @@ public abstract class AbstractFileObject
/**
* Compares two FileObjects (ignores case).
- *
+ *
* @param file
* the object to compare.
* @return a negative integer, zero, or a positive integer when this object is less than, equal to, or greater than
@@ -447,9 +451,10 @@ public abstract class AbstractFileObject
/**
* Deletes this file.
+ * <p>
+ * TODO - This will not fail if this is a non-empty folder.
*
* @return true if this object has been deleted
- * @todo This will not fail if this is a non-empty folder.
* @throws FileSystemException if an error occurs.
*/
@Override
@@ -599,11 +604,13 @@ public abstract class AbstractFileObject
}
/**
- * Attaches this file object to its file resource. This method is called
- * before any of the doBlah() or onBlah() methods. Sub-classes can use
- * this method to perform lazy initialisation.
- * <p/>
+ * Attaches this file object to its file resource.
+ * <p>
+ * This method is called before any of the doBlah() or onBlah() methods.
+ * Sub-classes can use this method to perform lazy initialisation.
+ * <p>
* This implementation does nothing.
+ *
* @throws Exception if an error occurs.
*/
protected void doAttach() throws Exception
@@ -624,12 +631,12 @@ public abstract class AbstractFileObject
/**
* Creates this file as a folder. Is only called when:
* <ul>
- * <li>{@link #doGetType} returns {@link FileType#IMAGINARY}.
+ * <li>{@link #doGetType} returns {@link FileType#IMAGINARY}.</li>
* <li>The parent folder exists and is writeable, or this file is the
- * root of the file system.
+ * root of the file system.</li>
* </ul>
- * <p/>
* This implementation throws an exception.
+ *
* @throws Exception if an error occurs.
*/
protected void doCreateFolder() throws Exception
@@ -640,12 +647,12 @@ public abstract class AbstractFileObject
/**
* Deletes the file. Is only called when:
* <ul>
- * <li>{@link #doGetType} does not return {@link FileType#IMAGINARY}.
- * <li>{@link #doIsWriteable} returns true.
- * <li>This file has no children, if a folder.
+ * <li>{@link #doGetType} does not return {@link FileType#IMAGINARY}.</li>
+ * <li>{@link #doIsWriteable} returns true.</li>
+ * <li>This file has no children, if a folder.</li>
* </ul>
- * <p/>
* This implementation throws an exception.
+
* @throws Exception if an error occurs.
*/
protected void doDelete() throws Exception
@@ -655,11 +662,12 @@ public abstract class AbstractFileObject
/**
* Detaches this file object from its file resource.
- * <p/>
- * <p>Called when this file is closed. Note that the file object may be
+ * <p>
+ * Called when this file is closed. Note that the file object may be
* reused later, so should be able to be reattached.
- * <p/>
+ * <p>
* This implementation does nothing.
+ *
* @throws Exception if an error occurs.
*/
protected void doDetach() throws Exception
@@ -669,8 +677,9 @@ public abstract class AbstractFileObject
/**
* Returns the attributes of this file. Is only called if {@link #doGetType}
* does not return {@link FileType#IMAGINARY}.
- * <p/>
+ * <p>
* This implementation always returns an empty map.
+ *
* @return The attributes of the file.
* @throws Exception if an error occurs.
*/
@@ -682,8 +691,9 @@ public abstract class AbstractFileObject
/**
* Returns the certificates used to sign this file. Is only called if
* {@link #doGetType} does not return {@link FileType#IMAGINARY}.
- * <p/>
+ * <p>
* This implementation always returns null.
+ *
* @return The certificates used to sign the file.
* @throws Exception if an error occurs.
*/
@@ -703,11 +713,12 @@ public abstract class AbstractFileObject
/**
* Creates an input stream to read the file content from. Is only called
* if {@link #doGetType} returns {@link FileType#FILE}.
- * <p/>
- * <p>It is guaranteed that there are no open output streams for this file
+ * <p>
+ * It is guaranteed that there are no open output streams for this file
* when this method is called.
- * <p/>
- * <p>The returned stream does not have to be buffered.
+ * <p>
+ * The returned stream does not have to be buffered.
+ *
* @return An InputStream to read the file content.
* @throws Exception if an error occurs.
*/
@@ -716,8 +727,9 @@ public abstract class AbstractFileObject
/**
* Returns the last modified time of this file. Is only called if
* {@link #doGetType} does not return {@link FileType#IMAGINARY}.
- * <p/>
+ * <p>
* This implementation throws an exception.
+ *
* @return The last modification time.
* @throws Exception if an error occurs.
*/
@@ -735,13 +747,13 @@ public abstract class AbstractFileObject
* {@link #doGetType} returns {@link FileType#IMAGINARY}, and the file's
* parent exists and is a folder.
* </ul>
- * <p/>
- * <p>It is guaranteed that there are no open stream (input or output) for
+ * It is guaranteed that there are no open stream (input or output) for
* this file when this method is called.
- * <p/>
- * <p>The returned stream does not have to be buffered.
- * <p/>
+ * <p>
+ * The returned stream does not have to be buffered.
+ * <p>
* This implementation throws an exception.
+ *
* @param bAppend true if the file should be appended to, false if it should be overwritten.
* @return An OutputStream to write to the file.
* @throws Exception if an error occurs.
@@ -754,10 +766,10 @@ public abstract class AbstractFileObject
/**
* Creates access to the file for random i/o. Is only called
* if {@link #doGetType} returns {@link FileType#FILE}.
- * <p/>
- * <p>It is guaranteed that there are no open output streams for this file
+ * <p>
+ * It is guaranteed that there are no open output streams for this file
* when this method is called.
- * <p/>
+ *
* @param mode The mode to access the file.
* @return The RandomAccessContext.
* @throws Exception if an error occurs.
@@ -778,8 +790,9 @@ public abstract class AbstractFileObject
/**
* Determines if this file is executable. Is only called if {@link #doGetType}
* does not return {@link FileType#IMAGINARY}.
- * <p/>
+ * <p>
* This implementation always returns false.
+ *
* @return true if the file is executable, false otherwise.
* @throws Exception if an error occurs.
*/
@@ -787,12 +800,13 @@ public abstract class AbstractFileObject
{
return false;
}
-
+
/**
* Determines if this file is hidden. Is only called if {@link #doGetType}
* does not return {@link FileType#IMAGINARY}.
- * <p/>
+ * <p>
* This implementation always returns false.
+ *
* @return true if the file is hidden, false otherwise.
* @throws Exception if an error occurs.
*/
@@ -804,8 +818,9 @@ public abstract class AbstractFileObject
/**
* Determines if this file can be read. Is only called if {@link #doGetType}
* does not return {@link FileType#IMAGINARY}.
- * <p/>
+ * <p>
* This implementation always returns true.
+ *
* @return true if the file is readable, false otherwise.
* @throws Exception if an error occurs.
*/
@@ -816,8 +831,8 @@ public abstract class AbstractFileObject
/**
* Checks if this fileObject is the same file as {@code destFile} just with a different
- * name.<br />
- * E.g. for case insensitive filesystems like windows.
+ * name. E.g. for case insensitive filesystems like windows.
+ *
* @param destFile The file to compare to.
* @return true if the FileObjects are the same.
* @throws FileSystemException if an error occurs.
@@ -830,8 +845,9 @@ public abstract class AbstractFileObject
/**
* Determines if this file can be written to. Is only called if
* {@link #doGetType} does not return {@link FileType#IMAGINARY}.
- * <p/>
+ * <p>
* This implementation always returns true.
+ *
* @return true if the file is writable.
* @throws Exception if an error occurs.
*/
@@ -841,9 +857,10 @@ public abstract class AbstractFileObject
}
/**
- * Lists the children of this file. Is only called if {@link #doGetType}
- * returns {@link FileType#FOLDER}. The return value of this method
- * is cached, so the implementation can be expensive.<br />
+ * Lists the children of this file. Is only called if {@link #doGetType}
+ * returns {@link FileType#FOLDER}. The return value of this method
+ * is cached, so the implementation can be expensive.
+ *
* @return a possible empty String array if the file is a directory or null or an exception if the
* file is not a directory or can't be read.
* @throws Exception if an error occurs.
@@ -868,8 +885,9 @@ public abstract class AbstractFileObject
/**
* Removes an attribute of this file. Is only called if {@link #doGetType}
* does not return {@link FileType#IMAGINARY}.
- * <p/>
+ * <p>
* This implementation throws an exception.
+ *
* @param attrName The name of the attribute to remove.
* @throws Exception if an error occurs.
* @since 2.0
@@ -882,10 +900,11 @@ public abstract class AbstractFileObject
/**
* Renames the file. Is only called when:
* <ul>
- * <li>{@link #doIsWriteable} returns true.
+ * <li>{@link #doIsWriteable} returns true.</li>
* </ul>
- * <p/>
+ * <p>
* This implementation throws an exception.
+ *
* @param newFile A FileObject with the new file name.
* @throws Exception if an error occurs.
*/
@@ -897,8 +916,9 @@ public abstract class AbstractFileObject
/**
* Sets an attribute of this file. Is only called if {@link #doGetType}
* does not return {@link FileType#IMAGINARY}.
- * <p/>
+ * <p>
* This implementation throws an exception.
+ *
* @param attrName The attribute name.
* @param value The value to be associated with the attribute name.
* @throws Exception if an error occurs.
@@ -927,8 +947,9 @@ public abstract class AbstractFileObject
/**
* Sets the last modified time of this file. Is only called if
* {@link #doGetType} does not return {@link FileType#IMAGINARY}.
- * <p/>
+ * <p>
* This implementation throws an exception.
+ *
* @param modtime The last modification time.
* @return true if the time was set.
* @throws Exception if an error occurs.
@@ -1302,7 +1323,7 @@ public abstract class AbstractFileObject
/**
* Returns the name of the file.
- *
+ *
* @return The FileName, never {@code null}.
*/
@Override
@@ -1314,7 +1335,7 @@ public abstract class AbstractFileObject
/**
* Returns the receiver as a URI String for public display, like, without a
* password.
- *
+ *
* @return A URI String without a password, never {@code null}.
*/
@Override
@@ -1536,8 +1557,10 @@ public abstract class AbstractFileObject
}
/**
- * Called when this file is changed.<br />
+ * Called when this file is changed.
+ * <p>
* This will only happen if you monitor the file using {@link org.apache.commons.vfs2.FileMonitor}.
+ *
* @throws Exception if an error occurs.
*/
protected void handleChanged() throws Exception
@@ -1547,8 +1570,9 @@ public abstract class AbstractFileObject
}
/**
- * Called when this file is created. Updates cached info and notifies
+ * Called when this file is created. Updates cached info and notifies
* the parent and file system.
+ *
* @param newType The type of the file.
* @throws Exception if an error occurs.
*/
@@ -1740,8 +1764,8 @@ public abstract class AbstractFileObject
/**
* Checks if this fileObject is the same file as {@code destFile} just with a different
- * name.<br />
- * E.g. for case insensitive filesystems like windows.
+ * name. E.g. for case insensitive filesystems like windows.
+ *
* @param destFile The file to compare to.
* @return true if the FileObjects are the same.
* @throws FileSystemException if an error occurs.
@@ -1930,8 +1954,9 @@ public abstract class AbstractFileObject
/**
* Called when the type or content of this file changes.
- * <p/>
+ * <p>
* This implementation does nothing.
+ *
* @throws Exception if an error occurs.
*/
protected void onChange() throws Exception
@@ -1941,8 +1966,9 @@ public abstract class AbstractFileObject
/**
* Called when the children of this file change. Allows subclasses to
* refresh any cached information about the children of this file.
- * <p/>
+ * <p>
* This implementation does nothing.
+ *
* @param child The name of the child that changed.
* @param newType The type of the file.
* @throws Exception if an error occurs.
@@ -2097,7 +2123,7 @@ public abstract class AbstractFileObject
/**
* Returns the URI as a String.
- *
+ *
* @return Returns the URI as a String.
*/
@Override
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileSystem.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileSystem.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileSystem.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileSystem.java Thu May 1 00:33:43 2014
@@ -459,7 +459,7 @@ public abstract class AbstractFileSystem
/**
* Returns the accuracy of the last modification time.
*
- * @return ms 0 perfectly accurate, >0 might be off by this value e.g. sftp 1000ms
+ * @return ms 0 perfectly accurate, {@literal >0} might be off by this value e.g. sftp 1000ms
*/
@Override
public double getLastModTimeAccuracy()
@@ -565,8 +565,10 @@ public abstract class AbstractFileSystem
}
/**
- * Fires a file changed event. <br />
+ * Fires a file changed event.
+ * <p>
* This will only happen if you monitor the file using {@link org.apache.commons.vfs2.FileMonitor}.
+ *
* @param file The FileObject that changed.
*/
public void fireFileChanged(final FileObject file)
@@ -575,8 +577,9 @@ public abstract class AbstractFileSystem
}
/**
- * returns true if no file is using this filesystem.
- * @return true of no file is using this FileSystem.
+ * Returns true if no file is using this filesystem.
+ *
+ * @return true if no file is using this FileSystem.
*/
public boolean isReleaseable()
{
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/DefaultFileContent.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/DefaultFileContent.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/DefaultFileContent.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/DefaultFileContent.java Thu May 1 00:33:43 2014
@@ -575,7 +575,8 @@ public final class DefaultFileContent im
*/
/**
- * check if a input and/or output stream is open.<br />
+ * Check if a input and/or output stream is open.
+ * <p>
* This checks only the scope of the current thread.
*
* @return true if this is the case
@@ -588,7 +589,7 @@ public final class DefaultFileContent im
}
/**
- * check if a input and/or output stream is open.<br />
+ * Check if a input and/or output stream is open.
* This checks all threads.
*
* @return true if this is the case
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java Thu May 1 00:33:43 2014
@@ -37,10 +37,10 @@ import org.apache.commons.vfs2.util.Weak
/**
* A file backed by another file.
+ * <p>
+ * TODO - Extract subclass that overlays the children.
*
* @param <AFS> A subclass of AbstractFileSystem.
- *
- * @todo Extract subclass that overlays the children
*/
public class DelegateFileObject<AFS extends AbstractFileSystem> extends AbstractFileObject<AFS> implements FileListener
{
@@ -391,8 +391,9 @@ public class DelegateFileObject<AFS exte
/**
* Called when a file is changed.
- * <p/>
+ * <p>
* This will only happen if you monitor the file using {@link org.apache.commons.vfs2.FileMonitor}.
+ *
* @param event The FileChangeEvent.
* @throws Exception if an error occurs.
*/
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/FileProvider.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/FileProvider.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/FileProvider.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/FileProvider.java Thu May 1 00:33:43 2014
@@ -29,8 +29,8 @@ import org.apache.commons.vfs2.FileSyste
/**
* A file provider. Each file provider is responsible for handling files for
* a particular URI scheme.
- * <p/>
- * <p>A file provider may also implement {@link VfsComponent}.
+ * <p>
+ * A file provider may also implement {@link VfsComponent}.
*/
public interface FileProvider
{
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/FileReplicator.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/FileReplicator.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/FileReplicator.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/FileReplicator.java Thu May 1 00:33:43 2014
@@ -24,8 +24,8 @@ import org.apache.commons.vfs2.FileSyste
/**
* Responsible for making local replicas of files.
- * <p/>
- * <p>A file replicator may also implement {@link VfsComponent}.
+ * <p>
+ * A file replicator may also implement {@link VfsComponent}.
*/
public interface FileReplicator
{
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/HostFileNameParser.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/HostFileNameParser.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/HostFileNameParser.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/HostFileNameParser.java Thu May 1 00:33:43 2014
@@ -23,8 +23,9 @@ import org.apache.commons.vfs2.util.Cryp
import org.apache.commons.vfs2.util.CryptorFactory;
/**
- * Implementation for any url based filesystem.<br />
- * Parses the url into user/password/host/port/path<br />
+ * Implementation for any url based filesystem.
+ * <p>
+ * Parses the url into user/password/host/port/path.
* Does not handle a query string (after ?)
*
* @see URLFileNameParser URLFileNameParser for the implementation which also handles the query string too
@@ -209,7 +210,7 @@ public class HostFileNameParser extends
}
/**
- * Extracts the port from a URI. The scheme://userinfo@hostname
+ * Extracts the port from a URI. The {@code scheme://userinfo@hostname}
* part has been removed.
*
* @return The port, or -1 if the URI does not contain a port.
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/LayeredFileNameParser.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/LayeredFileNameParser.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/LayeredFileNameParser.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/LayeredFileNameParser.java Thu May 1 00:33:43 2014
@@ -22,7 +22,7 @@ import org.apache.commons.vfs2.FileType;
/**
* Implementation for layered filesystems.
- * <p/>
+ * <p>
* Additionally encodes the '!' character.
*/
public class LayeredFileNameParser extends AbstractFileNameParser
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/LocalFileProvider.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/LocalFileProvider.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/LocalFileProvider.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/LocalFileProvider.java Thu May 1 00:33:43 2014
@@ -29,9 +29,10 @@ public interface LocalFileProvider
{
/**
* Determines if a name is an absolute file name.
+ * <p>
+ * TODO - Move this to a general file name parser interface.
*
* @param name The name to test.
- * @todo Move this to a general file name parser interface.
* @return true if the name is absolute.
*/
boolean isAbsoluteLocalName(final String name);
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/URLFileNameParser.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/URLFileNameParser.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/URLFileNameParser.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/URLFileNameParser.java Thu May 1 00:33:43 2014
@@ -21,8 +21,9 @@ import org.apache.commons.vfs2.FileSyste
import org.apache.commons.vfs2.FileType;
/**
- * Implementation for any url based filesystem.<br />
- * Parses the url into user/password/host/port/path/queryString<br />
+ * Implementation for any url based filesystem.
+ * <p>
+ * Parses the url into user/password/host/port/path/queryString.
*/
public class URLFileNameParser extends HostFileNameParser
{
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftp/FTPClientWrapper.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftp/FTPClientWrapper.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftp/FTPClientWrapper.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftp/FTPClientWrapper.java Thu May 1 00:33:43 2014
@@ -30,7 +30,8 @@ import org.apache.commons.vfs2.provider.
import org.apache.commons.vfs2.util.UserAuthenticatorUtils;
/**
- * A wrapper to the FTPClient to allow automatic reconnect on connection loss.<br />
+ * A wrapper to the FTPClient to allow automatic reconnect on connection loss.
+ * <p>
* I decided to not to use eg. noop() to determine the state of the connection to avoid
* unnecessary server round-trips.
*/
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystemConfigBuilder.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystemConfigBuilder.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystemConfigBuilder.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystemConfigBuilder.java Thu May 1 00:33:43 2014
@@ -104,8 +104,9 @@ public class FtpFileSystemConfigBuilder
}
/**
- * get the default date format used by the server. see {@link org.apache.commons.net.ftp.FTPClientConfig}
+ * Get the default date format used by the server. See {@link org.apache.commons.net.ftp.FTPClientConfig}
* for details and examples.
+ *
* @param opts The FileSystemOptions
* @return The default date format.
*/
@@ -157,7 +158,8 @@ public class FtpFileSystemConfigBuilder
}
/**
- * see {@link org.apache.commons.net.ftp.FTPClientConfig} for details and examples.
+ * See {@link org.apache.commons.net.ftp.FTPClientConfig} for details and examples.
+ *
* @param opts The FileSystemOptions.
* @return The recent date format.
*/
@@ -167,8 +169,9 @@ public class FtpFileSystemConfigBuilder
}
/**
- * get the language code used by the server. see {@link org.apache.commons.net.ftp.FTPClientConfig}
+ * Get the language code used by the server. See {@link org.apache.commons.net.ftp.FTPClientConfig}
* for details and examples.
+ *
* @param opts The FilesystemOptions.
* @return The language code of the server.
*/
@@ -178,7 +181,8 @@ public class FtpFileSystemConfigBuilder
}
/**
- * see {@link org.apache.commons.net.ftp.FTPClientConfig} for details and examples.
+ * See {@link org.apache.commons.net.ftp.FTPClientConfig} for details and examples.
+ *
* @param opts The FileSystemOptions.
* @return The server timezone id.
*/
@@ -188,7 +192,8 @@ public class FtpFileSystemConfigBuilder
}
/**
- * see {@link org.apache.commons.net.ftp.FTPClientConfig} for details and examples.
+ * See {@link org.apache.commons.net.ftp.FTPClientConfig} for details and examples.
+ *
* @param opts The FileSystemOptions.
* @return An array of short month names.
*/
@@ -212,7 +217,7 @@ public class FtpFileSystemConfigBuilder
* Returns {@link Boolean#TRUE} if VFS should treat the user directory as the root directory. Defaults to
* <code>Boolean.TRUE</code> if the method {@link #setUserDirIsRoot(FileSystemOptions, boolean)} has not been
* invoked.
- *
+ *
* @param opts
* The FileSystemOptions.
* @return <code>Boolean.TRUE</code> if VFS treats the user directory as the root directory.
@@ -227,7 +232,6 @@ public class FtpFileSystemConfigBuilder
* Sets the timeout for the initial control connection.
* <p>
* If you set the connectTimeout to {@code null} no connectTimeout will be set.
- * </p>
*
* @param opts The FileSystemOptions.
* @param connectTimeout the timeout value in milliseconds
@@ -239,7 +243,8 @@ public class FtpFileSystemConfigBuilder
}
/**
- * see {@link org.apache.commons.net.ftp.FTP#setControlEncoding} for details and examples.
+ * See {@link org.apache.commons.net.ftp.FTP#setControlEncoding} for details and examples.
+ *
* @param opts The FileSystemOptions.
* @param encoding the encoding to use
* @since 2.0
@@ -250,8 +255,9 @@ public class FtpFileSystemConfigBuilder
}
/**
- * set the data timeout for the ftp client.<br />
- * If you set the dataTimeout to {@code null} no dataTimeout will be set on the
+ * Set the data timeout for the ftp client.
+ * <p>
+ * If you set the {@code dataTimeout} to null no dataTimeout will be set on the
* ftp client.
*
* @param opts The FileSystemOptions.
@@ -263,8 +269,9 @@ public class FtpFileSystemConfigBuilder
}
/**
- * set the default date format used by the server. see {@link org.apache.commons.net.ftp.FTPClientConfig}
+ * Set the default date format used by the server. See {@link org.apache.commons.net.ftp.FTPClientConfig}
* for details and examples.
+ *
* @param opts The FileSystemOptions.
* @param defaultDateFormat The default date format.
*/
@@ -274,11 +281,11 @@ public class FtpFileSystemConfigBuilder
}
/**
- * set the FQCN of your FileEntryParser used to parse the directory listing from your server.<br />
- * <br />
- * <i>If you do not use the default commons-net FTPFileEntryParserFactory e.g. by using
- * {@link #setEntryParserFactory}
- * this is the "key" parameter passed as argument into your custom factory</i>
+ * Set the FQCN of your FileEntryParser used to parse the directory listing from your server.
+ * <p>
+ * If you do not use the default commons-net FTPFileEntryParserFactory e.g. by using
+ * {@link #setEntryParserFactory} this is the "key" parameter passed as argument into your
+ * custom factory.
*
* @param opts The FileSystemOptions.
* @param key The key.
@@ -312,7 +319,7 @@ public class FtpFileSystemConfigBuilder
}
/**
- * enter into passive mode.
+ * Enter into passive mode.
*
* @param opts The FileSystemOptions.
* @param passiveMode true if passive mode should be used.
@@ -323,7 +330,8 @@ public class FtpFileSystemConfigBuilder
}
/**
- * see {@link org.apache.commons.net.ftp.FTPClientConfig} for details and examples.
+ * See {@link org.apache.commons.net.ftp.FTPClientConfig} for details and examples.
+ *
* @param opts The FileSystemOptions.
* @param recentDateFormat The recent date format.
*/
@@ -333,8 +341,9 @@ public class FtpFileSystemConfigBuilder
}
/**
- * set the language code used by the server. see {@link org.apache.commons.net.ftp.FTPClientConfig}
+ * Set the language code used by the server. See {@link org.apache.commons.net.ftp.FTPClientConfig}
* for details and examples.
+ *
* @param opts The FileSystemOptions.
* @param serverLanguageCode The servers language code.
*/
@@ -344,7 +353,8 @@ public class FtpFileSystemConfigBuilder
}
/**
- * see {@link org.apache.commons.net.ftp.FTPClientConfig} for details and examples.
+ * See {@link org.apache.commons.net.ftp.FTPClientConfig} for details and examples.
+ *
* @param opts The FileSystemOptions.
* @param serverTimeZoneId The server timezone id.
*/
@@ -354,7 +364,8 @@ public class FtpFileSystemConfigBuilder
}
/**
- * see {@link org.apache.commons.net.ftp.FTPClientConfig} for details and examples.
+ * See {@link org.apache.commons.net.ftp.FTPClientConfig} for details and examples.
+ *
* @param opts The FileSystemOptions.
* @param shortMonthNames an array of short month name Strings.
*/
@@ -371,8 +382,9 @@ public class FtpFileSystemConfigBuilder
}
/**
- * Sets the socket timeout for the FTP client.<br />
- * If you set the socketTimeout to {@code null} no socketTimeout will be set on the
+ * Sets the socket timeout for the FTP client.
+ * <p>
+ * If you set the {@code soTimeout} to null no socket timeout will be set on the
* ftp client.
*
* @param opts The FileSystem options.
@@ -385,7 +397,7 @@ public class FtpFileSystemConfigBuilder
}
/**
- * use user directory as root (do not change to fs root).
+ * Use user directory as root (do not change to fs root).
*
* @param opts The FileSystemOptions.
* @param userDirIsRoot true if the user directory should be treated as the root.
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsClientWrapper.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsClientWrapper.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsClientWrapper.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsClientWrapper.java Thu May 1 00:33:43 2014
@@ -27,8 +27,11 @@ import org.apache.commons.vfs2.util.User
/**
- * A wrapper to the FTPSClient to allow automatic reconnect on connection loss.<br />
- * The only difference to the FTPClientWrapper is the creation of a FTPSClient instead of a FTPClient.
+ * A wrapper to the FTPSClient to allow automatic reconnect on connection loss.
+ * <p>
+ * The only difference to the {@link FTPClientWrapper} is the creation of a {@link FTPSClient}
+ * instead of a {@link FTPClient}.
+ *
* @since 2.0
*/
class FtpsClientWrapper extends FTPClientWrapper
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileObject.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileObject.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileObject.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileObject.java Thu May 1 00:33:43 2014
@@ -42,10 +42,10 @@ import org.apache.commons.vfs2.util.Rand
/**
* A file object backed by Apache Commons HttpClient.
+ * <p>
+ * TODO - status codes.
*
* @param <FS> An {@link HttpFileSystem} subclass
- *
- * @todo status codes
*/
public class HttpFileObject<FS extends HttpFileSystem> extends AbstractFileObject<FS>
{
@@ -117,11 +117,11 @@ public class HttpFileObject<FS extends H
/**
* Creates an input stream to read the file content from. Is only called
* if {@link #doGetType} returns {@link FileType#FILE}.
- * <p/>
- * <p>It is guaranteed that there are no open output streams for this file
+ * <p>
+ * It is guaranteed that there are no open output streams for this file
* when this method is called.
- * <p/>
- * <p>The returned stream does not have to be buffered.
+ * <p>
+ * The returned stream does not have to be buffered.
*/
@Override
protected InputStream doGetInputStream() throws Exception
@@ -143,7 +143,7 @@ public class HttpFileObject<FS extends H
/**
* Returns the last modified time of this file.
- * <p/>
+ * <p>
* This implementation throws an exception.
*/
@Override
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpClientFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpClientFactory.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpClientFactory.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpClientFactory.java Thu May 1 00:33:43 2014
@@ -264,7 +264,8 @@ public final class SftpClientFactory
/**
* Finds the .ssh directory.
- * <p>The lookup order is:</p>
+ * <p>
+ * The lookup order is:
* <ol>
* <li>The system property {@code vfs.sftp.sshdir} (the override
* mechanism)</li>
@@ -272,12 +273,10 @@ public final class SftpClientFactory
* <li>On Windows only: C:\cygwin\home\{user.name}\.ssh</li>
* <li>The current directory, as a last resort.</li>
* <ol>
- * <p/>
- * Windows Notes:
+ * Windows Notes:<br>
* The default installation directory for Cygwin is {@code C:\cygwin}.
* On my set up (Gary here), I have Cygwin in C:\bin\cygwin, not the default.
* Also, my .ssh directory was created in the {user.home} directory.
- * </p>
*
* @return The .ssh directory
*/
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileObject.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileObject.java?rev=1591516&r1=1591515&r2=1591516&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileObject.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileObject.java Thu May 1 00:33:43 2014
@@ -46,8 +46,6 @@ import com.jcraft.jsch.SftpException;
/**
* An SFTP file.
- *
- * @version $Id$
*/
public class SftpFileObject extends AbstractFileObject<SftpFileSystem>
{
@@ -231,7 +229,7 @@ public class SftpFileObject extends Abst
/**
* Sets the last modified time of this file. Is only called if
- * {@link #doGetType} does not return {@link FileType#IMAGINARY}. <p/>
+ * {@link #doGetType} does not return {@link FileType#IMAGINARY}.
*
* @param modtime
* is modification time in milliseconds. SFTP protocol can send