Author: ecki
Date: Sun Jan 11 23:11:44 2015
New Revision: 1650988
URL: http://svn.apache.org/r1650988
Log:
[core] Remove java8 javadoc warnings, cleanup comments.
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/VFSClassLoader.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperationProvider.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/AbstractFileProvider.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/AbstractLayeredFileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractVfsComponent.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractVfsContainer.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/CompositeFileProvider.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/GenericFileName.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/ftp/FtpFileSystem.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/hdfs/HdfsFileSystem.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/http/HttpFileSystemConfigBuilder.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/local/LocalFile.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileNameParser.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystem.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/tar/TarFileObject.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/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/VfsTask.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/util/MonitorRandomAccessContent.java
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/VFSClassLoader.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/VFSClassLoader.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/VFSClassLoader.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/impl/VFSClassLoader.java
Sun Jan 11 23:11:44 2015
@@ -364,8 +364,7 @@ public class VFSClassLoader extends Secu
}
catch (final Exception mue)
{
- // Ignore
- // TODO - report?
+ /* Ignored. TODO: report? */
}
return null;
@@ -374,12 +373,13 @@ public class VFSClassLoader extends Secu
/**
* Returns an Enumeration of all the resources in the search path
* with the specified name.
- *
+ * <p>
* Gets called from {@link ClassLoader#getResources(String)} after
* parent class loader was questioned.
+ *
* @param name The resources to find.
* @return An Enumeration of the resources associated with the name.
- * @throws FileSystemException
+ * @throws FileSystemException if an error occurs.
*/
@Override
protected Enumeration<URL> findResources(final String name) throws
IOException
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperationProvider.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperationProvider.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperationProvider.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperationProvider.java
Sun Jan 11 23:11:44 2015
@@ -51,8 +51,7 @@ public abstract class AbstractFileOperat
* @param file
* the FileObject for which we want to get the list of available
* operations.
- * @throws org.apache.commons.vfs2.FileSystemException
- * if list of operations cannot be retrieved.
+ * @throws FileSystemException if list of operations cannot be retrieved.
*/
@Override
public final void collectOperations(final Collection<Class<? extends
FileOperation>> operationsList,
@@ -62,8 +61,18 @@ public abstract class AbstractFileOperat
}
/**
+ * Gather available operations for the specified FileObject and put them
into
+ * specified operationsList.
*
- * @throws FileSystemException
+ * @param availableOperations
+ * the list of available operations for the specified
FileObject.
+ * @param resultList
+ * List to be filled with applicable operations.
+ * @param file
+ * the FileObject for which we want to get the list of available
+ * operations.
+ * @throws FileSystemException if list of operations cannot be retrieved.
+ * @see #collectOperations(Collection operationsList, FileObject file)
*/
protected abstract void doCollectOperations(
final Collection<Class<? extends FileOperation>>
availableOperations,
@@ -76,8 +85,7 @@ public abstract class AbstractFileOperat
* @param operationClass
* the Class which instance we are needed.
* @return the required operation instance.
- * @throws org.apache.commons.vfs2.FileSystemException
- * if operation cannot be retrieved.
+ * @throws FileSystemException if operation cannot be retrieved.
*/
@Override
public final FileOperation getOperation(final FileObject file, final
Class<? extends FileOperation> operationClass)
@@ -91,18 +99,22 @@ public abstract class AbstractFileOperat
}
/**
+ * Get operation instance for specified FileOperation subclass.
*
- * @param operationClass
+ * @param file the file this operation should act on.
+ * @param operationClass the class of an file operation interface to
instantiate.
* @return a new file operation
- * @throws FileSystemException
+ * @throws FileSystemException if operation cannot be instantiated.
*/
protected abstract FileOperation instantiateOperation(final FileObject
file,
final Class<? extends FileOperation> operationClass) throws
FileSystemException;
/**
+ * Find class implementing a specific operation interface.
*
- * @param operationClass
+ * @param operationClass the interface which is requested.
* @return never returns null
+ * @throws FileSystemException if operationClass is not a known
FileOperation interface.
*/
protected final Class<? extends FileOperation> lookupOperation(final
Class<? extends FileOperation> operationClass)
throws FileSystemException
@@ -135,9 +147,10 @@ public abstract class AbstractFileOperat
}
/**
+ * Add new FileOperation to list of known operations.
*
- * @param operationClass
- * @throws FileSystemException
+ * @param operationClass a class implementing FileOperation.
+ * @throws FileSystemException if instances of the class cannot be
assigned to FileOperation.
*/
protected final void addOperation(final Class<? extends FileOperation>
operationClass)
throws FileSystemException
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=1650988&r1=1650987&r2=1650988&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
Sun Jan 11 23:11:44 2015
@@ -855,12 +855,16 @@ public abstract class AbstractFileObject
protected abstract String[] doListChildren() throws Exception;
/**
- * 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.
+ * <p>
+ * Is only called if {@link #doGetType} returns {@link FileType#FOLDER}.
+ * <p>
+ * The return value of this method is cached, so the implementation can be
expensive.<br>
* Other than {@code doListChildren} you could return FileObject's to e.g.
reinitialize the
- * type of the file.<br>
+ * type of the file.
+ * <p>
* (Introduced for Webdav: "permission denied on resource" during
getType())
+ *
* @return The children of this FileObject.
* @throws Exception if an error occurs.
*/
@@ -870,8 +874,9 @@ public abstract class AbstractFileObject
}
/**
- * Removes an attribute of this file. Is only called if {@link #doGetType}
- * does not return {@link FileType#IMAGINARY}.
+ * Removes an attribute of this file.
+ * <p>
+ * Is only called if {@link #doGetType} does not return {@link
FileType#IMAGINARY}.
* <p>
* This implementation throws an exception.
*
@@ -885,7 +890,9 @@ public abstract class AbstractFileObject
}
/**
- * Renames the file. Is only called when:
+ * Renames the file.
+ * <p>
+ * Is only called when:
* <ul>
* <li>{@link #doIsWriteable} returns true.</li>
* </ul>
@@ -901,8 +908,9 @@ public abstract class AbstractFileObject
}
/**
- * Sets an attribute of this file. Is only called if {@link #doGetType}
- * does not return {@link FileType#IMAGINARY}.
+ * Sets an attribute of this file.
+ * <p>
+ * Is only called if {@link #doGetType} does not return {@link
FileType#IMAGINARY}.
* <p>
* This implementation throws an exception.
*
@@ -916,30 +924,34 @@ public abstract class AbstractFileObject
}
/**
+ * Make the file executable.
+ * <p>
* Only called if {@link #doGetType} does not return {@link
FileType#IMAGINARY}.
+ * <p>
+ * This implementation returns false.
*
- * @param writable
- * True to allow access, false to disallow
- * @param ownerOnly
- * If {@code true}, the permission applies only to the owner;
otherwise, it applies to everybody.
- * @return true if the operation succeeded
+ * @param executable True to allow access, false to disallow.
+ * @param ownerOnly If {@code true}, the permission applies only to the
owner; otherwise, it applies to everybody.
+ * @return true if the operation succeeded.
+ * @throws Exception Any Exception thrown is wrapped in
FileSystemException.
* @see #setExecutable(boolean, boolean)
* @since 2.1
*/
- protected boolean doSetExecutable(final boolean writable, final boolean
ownerOnly) throws Exception
+ protected boolean doSetExecutable(final boolean executable, final boolean
ownerOnly) throws Exception
{
return false;
}
/**
- * Sets the last modified time of this file. Is only called if
- * {@link #doGetType} does not return {@link FileType#IMAGINARY}.
+ * Sets the last modified time of this file.
+ * <p>
+ * Is only called if {@link #doGetType} does not return {@link
FileType#IMAGINARY}.
* <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.
+ * @throws Exception Any Exception thrown is wrapped in
FileSystemException.
*/
protected boolean doSetLastModifiedTime(final long modtime) throws
Exception
{
@@ -947,13 +959,18 @@ public abstract class AbstractFileObject
}
/**
+ * Make the file or folder readable.
+ * <p>
* Only called if {@link #doGetType} does not return {@link
FileType#IMAGINARY}.
+ * <p>
+ * This implementation returns false.
*
* @param readable
* True to allow access, false to disallow
* @param ownerOnly
* If {@code true}, the permission applies only to the owner;
otherwise, it applies to everybody.
* @return true if the operation succeeded
+ * @throws Exception Any Exception thrown is wrapped in
FileSystemException.
* @see #setReadable(boolean, boolean)
* @since 2.1
*/
@@ -963,13 +980,14 @@ public abstract class AbstractFileObject
}
/**
+ * Make the file or folder writeable.
+ * <p>
* Only called if {@link #doGetType} does not return {@link
FileType#IMAGINARY}.
*
- * @param writable
- * True to allow access, false to disallow
- * @param ownerOnly
- * If {@code true}, the permission applies only to the owner;
otherwise, it applies to everybody.
+ * @param writable True to allow access, false to disallow
+ * @param ownerOnly If {@code true}, the permission applies only to the
owner; otherwise, it applies to everybody.
* @return true if the operation succeeded
+ * @throws Exception Any Exception thrown is wrapped in
FileSystemException.
* @see #setWritable(boolean, boolean)
* @since 2.1
*/
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileProvider.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileProvider.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileProvider.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileProvider.java
Sun Jan 11 23:11:44 2015
@@ -89,8 +89,12 @@ public abstract class AbstractFileProvid
}
/**
- * Adds a file system to those cached by this provider. The file system
- * may implement {@link VfsComponent}, in which case it is initialised.
+ * Adds a file system to those cached by this provider.
+ * <p>
+ * The file system may implement {@link VfsComponent}, in which case it is
initialised.
+ * @param key The root file of the file system, part of the cache key.
+ * @param fs the file system to add.
+ * @throws FileSystemException if any error occurs.
*/
protected void addFileSystem(final Comparable<?> key, final FileSystem fs)
throws FileSystemException
@@ -108,9 +112,11 @@ public abstract class AbstractFileProvid
}
/**
- * Locates a cached file system
+ * Locates a cached file system.
*
- * @return The provider, or null if it is not cached.
+ * @param key The root file of the file system, part of the cache key.
+ * @param fileSystemProps file system options the file system instance
must have.
+ * @return The file system instance, or null if it is not cached.
*/
protected FileSystem findFileSystem(final Comparable<?> key, final
FileSystemOptions fileSystemProps)
{
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=1650988&r1=1650987&r2=1650988&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
Sun Jan 11 23:11:44 2015
@@ -146,20 +146,27 @@ public abstract class AbstractFileSystem
}
/**
- * Close the underlaying link used to access the files
+ * Close the underlying link used to access the files
*/
protected void doCloseCommunicationLink()
{
}
/**
- * Creates a file object. This method is called only if the requested
- * file is not cached.
+ * Creates a file object.
+ * <p>
+ * This method is called only if the requested file is not cached.
+ *
+ * @param name name referencing the new file.
+ * @return new created FileObject.
+ * @throws Exception might throw an Exception, which is then wrapped in
FileSystemException.
*/
protected abstract FileObject createFile(final AbstractFileName name)
throws Exception;
/**
* Adds the capabilities of this file system.
+ *
+ * @param caps collections of Capabilities, can be immutable.
*/
protected abstract void addCapabilities(Collection<Capability> caps);
@@ -186,6 +193,7 @@ public abstract class AbstractFileSystem
/**
* Adds a file object to the cache.
+ * @param file the file to add.
*/
protected void putFileToCache(final FileObject file)
{
@@ -206,6 +214,8 @@ public abstract class AbstractFileSystem
/**
* Returns a cached file.
+ * @param name name to search for.
+ * @return file object or null if not found.
*/
protected FileObject getFileFromCache(final FileName name)
{
@@ -213,7 +223,8 @@ public abstract class AbstractFileSystem
}
/**
- * remove a cached file.
+ * Remove a cached file.
+ * @param name The file name to remove.
*/
protected void removeFileFromCache(final FileName name)
{
@@ -449,6 +460,11 @@ public abstract class AbstractFileSystem
/**
* Creates a temporary local copy of a file and its descendants.
+ *
+ * @param file the start of the tree.
+ * @param selector selection what to do with childs.
+ * @return replicated root file.
+ * @throws Exception any Exception is wrapped as FileSystemException.
*/
protected File doReplicateFile(final FileObject file,
final FileSelector selector)
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractLayeredFileProvider.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractLayeredFileProvider.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractLayeredFileProvider.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractLayeredFileProvider.java
Sun Jan 11 23:11:44 2015
@@ -91,12 +91,15 @@ public abstract class AbstractLayeredFil
}
/**
- * Creates a layered file system. This method is called if the file system
- * is not cached. The file system may implement {@link VfsComponent}.
+ * Creates a layered file system.
+ * <p>
+ * This method is called if the file system is not cached.
*
* @param scheme The URI scheme.
* @param file The file to create the file system on top of.
- * @return The file system.
+ * @param fileSystemOptions options for new and underlying file systems.
+ * @return The file system, never null. Might implement {@link
VfsComponent}.
+ * @throws FileSystemException if the file system cannot be created.
*/
protected abstract FileSystem doCreateFileSystem(final String scheme,
final FileObject file,
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractVfsComponent.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractVfsComponent.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractVfsComponent.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractVfsComponent.java
Sun Jan 11 23:11:44 2015
@@ -67,6 +67,7 @@ public abstract class AbstractVfsCompone
/**
* Returns the logger for this file system to use.
+ * @return logger for this file system
*/
protected final Log getLogger()
{
@@ -75,6 +76,7 @@ public abstract class AbstractVfsCompone
/**
* Returns the context for this provider.
+ * @return provider context
*/
protected final VfsComponentContext getContext()
{
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractVfsContainer.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractVfsContainer.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractVfsContainer.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractVfsContainer.java
Sun Jan 11 23:11:44 2015
@@ -32,9 +32,12 @@ public abstract class AbstractVfsContain
private final ArrayList<Object> components = new ArrayList<Object>();
/**
- * Adds a sub-component to this component. If the sub-component implements
- * {@link VfsComponent}, it is initialised. All sub-components are closed
- * when this component is closed.
+ * Adds a sub-component to this component.
+ * <p>
+ * If the sub-component implements {@link VfsComponent}, it is initialised.
+ * All sub-components are closed when this component is closed.
+ * @param component the component to add.
+ * @throws FileSystemException if any error occurs.
*/
protected void addComponent(final Object component)
throws FileSystemException
@@ -57,6 +60,8 @@ public abstract class AbstractVfsContain
/**
* Removes a sub-component from this component.
+ *
+ * @param component the component to remove.
*/
protected void removeComponent(final Object component)
{
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/CompositeFileProvider.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/CompositeFileProvider.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/CompositeFileProvider.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/CompositeFileProvider.java
Sun Jan 11 23:11:44 2015
@@ -33,7 +33,8 @@ public abstract class CompositeFileProvi
}
/**
- * The schemes to use for resolve
+ * The schemes known.
+ * @return Array of supported schemes.
*/
protected abstract String[] getSchemes();
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=1650988&r1=1650987&r2=1650988&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
Sun Jan 11 23:11:44 2015
@@ -440,7 +440,12 @@ public class DelegateFileObject<AFS exte
}
}
- /** @since 2.0 */
+ /**
+ * Return file content info.
+ * @return the file content info of the delegee.
+ * @throws Exception Any thrown Exception is wrapped in
FileSystemException.
+ * @since 2.0
+ */
protected FileContentInfo doGetContentInfo() throws Exception
{
return file.getContent().getContentInfo();
@@ -448,6 +453,9 @@ public class DelegateFileObject<AFS exte
/**
* Renames the file.
+ *
+ * @param newFile the new location/name.
+ * @throws Exception Any thrown Exception is wrapped in
FileSystemException.
* @since 2.0
*/
@Override
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/GenericFileName.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/GenericFileName.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/GenericFileName.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/GenericFileName.java
Sun Jan 11 23:11:44 2015
@@ -142,7 +142,12 @@ public class GenericFileName extends Abs
}
/**
- * append the user credentials
+ * Append the user credentials.
+ * <p>
+ * If anything was added, it will be '@' terminated.
+ *
+ * @param buffer the string buffer to modify.
+ * @param addPassword flag if password should be added or replaced with
placeholder (false).
*/
protected void appendCredentials(final StringBuilder buffer, final boolean
addPassword)
{
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=1650988&r1=1650987&r2=1650988&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
Sun Jan 11 23:11:44 2015
@@ -77,6 +77,8 @@ public class HostFileNameParser extends
*
* @param uri The absolute URI to parse.
* @param name Used to return the remainder of the URI.
+ * @return Authority extracted host authority, never null.
+ * @throws FileSystemException if authority cannot be extracted.
*/
protected Authority extractToPath(final String uri,
final StringBuilder name)
@@ -154,8 +156,10 @@ public class HostFileNameParser extends
}
/**
- * Extracts the user info from a URI. The scheme:// part has been removed
- * already.
+ * Extracts the user info from a URI.
+ *
+ * @param name string buffer with the "scheme://" part has been removed
already. Will be modified.
+ * @return the user information up to the '@' or null.
*/
protected String extractUserInfo(final StringBuilder name)
{
@@ -182,8 +186,10 @@ public class HostFileNameParser extends
}
/**
- * Extracts the hostname from a URI. The scheme://userinfo@ part has
- * been removed.
+ * Extracts the hostname from a URI.
+ *
+ * @param name string buffer with the "scheme://[userinfo@]" part has been
removed already. Will be modified.
+ * @return the host name or null.
*/
protected String extractHostName(final StringBuilder name)
{
@@ -210,10 +216,13 @@ public class HostFileNameParser extends
}
/**
- * Extracts the port from a URI. The {@code scheme://userinfo@hostname}
- * part has been removed.
- *
+ * Extracts the port from a URI.
+ * @param name string buffer with the "scheme://[userinfo@]hostname" part
has been removed already.
+ * Will be modified.
+ * @param uri full URI for error reporting.
* @return The port, or -1 if the URI does not contain a port.
+ * @throws FileSystemException if URI is malformed.
+ * @throws NumberFormatException if port number cannot be parsed.
*/
protected int extractPort(final StringBuilder name, final String uri)
throws FileSystemException
{
@@ -244,7 +253,7 @@ public class HostFileNameParser extends
}
/**
- * Parsed authority info (scheme, hostname, userinfo, port)
+ * Parsed authority info (scheme, hostname, username/password, port).
*/
protected static class Authority
{
@@ -254,61 +263,101 @@ public class HostFileNameParser extends
private String password;
private int port;
- /** @since 2.0 */
+ /**
+ * Get the connection schema.
+ * @return the connection scheme.
+ * @since 2.0
+ */
public String getScheme()
{
return scheme;
}
- /** @since 2.0 */
+ /**
+ * Set the connection schema.
+ * @param scheme the connection scheme.
+ * @since 2.0
+ */
public void setScheme(final String scheme)
{
this.scheme = scheme;
}
- /** @since 2.0 */
+ /**
+ * Get the host name.
+ * @return the host name.
+ * @since 2.0
+ */
public String getHostName()
{
return hostName;
}
- /** @since 2.0 */
+ /**
+ * Set the host name.
+ * @param hostName the host name.
+ * @since 2.0
+ */
public void setHostName(final String hostName)
{
this.hostName = hostName;
}
- /** @since 2.0 */
+ /**
+ * Get the user name.
+ * @return the user name or null.
+ * @since 2.0
+ */
public String getUserName()
{
return userName;
}
- /** @since 2.0 */
+ /**
+ * Set the user name.
+ * @param userName the user name.
+ * @since 2.0
+ */
public void setUserName(final String userName)
{
this.userName = userName;
}
- /** @since 2.0 */
+ /**
+ * Get the user password.
+ * @return the password or null.
+ * @since 2.0
+ */
public String getPassword()
{
return password;
}
- /** @since 2.0 */
+ /**
+ * Set the user password.
+ * @param password the user password.
+ * @since 2.0
+ */
public void setPassword(final String password)
{
this.password = password;
}
- /** @since 2.0 */
+ /**
+ * Get the port.
+ * @return the port or -1.
+ * @since 2.0
+ */
public int getPort()
{
return port;
}
- /** @since 2.0 */
+ /**
+ * Set the connection port.
+ * @param port the port number or -1.
+ * @since 2.0
+ */
public void setPort(final int port)
{
this.port = 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=1650988&r1=1650987&r2=1650988&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
Sun Jan 11 23:11:44 2015
@@ -85,6 +85,10 @@ public class LayeredFileNameParser exten
/**
* Pops the root prefix off a URI, which has had the scheme removed.
+ *
+ * @param uri string builder which gets modified.
+ * @return the extracted root name.
+ * @throws FileSystemException if error occurs.
*/
protected String extractRootName(final StringBuilder uri)
throws FileSystemException
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystem.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystem.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystem.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystem.java
Sun Jan 11 23:11:44 2015
@@ -121,6 +121,9 @@ public class FtpFileSystem extends Abstr
}
/**
+ * Get the wrapper to access this file system.
+ * @return new instance.
+ * @throws FileSystemException if any error occurs.
* @since 2.1
*/
protected FTPClientWrapper createWrapper() throws FileSystemException
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=1650988&r1=1650987&r2=1650988&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
Sun Jan 11 23:11:44 2015
@@ -53,7 +53,11 @@ public class FtpFileSystemConfigBuilder
super("ftp.");
}
- /** @since 2.1 */
+ /**
+ * Create new config builder with specified prefix string.
+ * @param prefix prefix string to use for parameters of this config
builder.
+ * @since 2.1
+ */
protected FtpFileSystemConfigBuilder(final String prefix)
{
super(prefix);
@@ -187,7 +191,8 @@ public class FtpFileSystemConfigBuilder
/**
* Gets whether to use remote verification.
*
- * @param opts
+ * @param opts The FileSystemOptions.
+ * @return True if remote verification should be done.
*/
public Boolean getRemoteVerification(FileSystemOptions opts)
{
@@ -384,8 +389,8 @@ public class FtpFileSystemConfigBuilder
/**
* Sets whether to use remote verification.
*
- * @param opts
- * @param remoteVerification
+ * @param opts The FileSystemOptions.
+ * @param remoteVerification True if verification should be done.
*/
public void setRemoteVerification(FileSystemOptions opts, boolean
remoteVerification)
{
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileSystem.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileSystem.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileSystem.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileSystem.java
Sun Jan 11 23:11:44 2015
@@ -48,8 +48,9 @@ public class HdfsFileSystem extends Abst
/**
* Construct file system.
- * @param rootName
- * @param fileSystemOptions
+ *
+ * @param rootName Name of the root directory of this file system.
+ * @param fileSystemOptions options for this file system instance.
*/
protected HdfsFileSystem(final FileName rootName, final FileSystemOptions
fileSystemOptions)
{
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=1650988&r1=1650987&r2=1650988&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
Sun Jan 11 23:11:44 2015
@@ -242,6 +242,9 @@ public class HttpFileObject<FS extends H
/**
* Prepares a HttpMethod object.
*
+ * @param method The object which gets prepared to access the file object.
+ * @throws FileSystemException if an error occurs.
+ * @throws URIException if path cannot be represented.
* @since 2.0 (was package)
*/
protected void setupMethod(final HttpMethod method) throws
FileSystemException, URIException
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystemConfigBuilder.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystemConfigBuilder.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystemConfigBuilder.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystemConfigBuilder.java
Sun Jan 11 23:11:44 2015
@@ -44,7 +44,11 @@ public class HttpFileSystemConfigBuilder
private static final String KEY_PREEMPTIVE_AUTHENTICATION =
"preemptiveAuth";
- /** @since 2.0 */
+ /**
+ * Create new config builder.
+ * @param prefix String for properties of this file system.
+ * @since 2.0
+ */
protected HttpFileSystemConfigBuilder(final String prefix)
{
super(prefix);
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/local/LocalFile.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/local/LocalFile.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/local/LocalFile.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/local/LocalFile.java
Sun Jan 11 23:11:44 2015
@@ -44,6 +44,11 @@ public class LocalFile extends AbstractF
/**
* Creates a non-root file.
+ *
+ * @param fileSystem the file system this file belongs to.
+ * @param rootFile the root file for the file system.
+ * @param name the file name on this file system.
+ * @throws FileSystemException if an error occurs.
*/
protected LocalFile(final LocalFileSystem fileSystem,
final String rootFile,
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileNameParser.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileNameParser.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileNameParser.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileNameParser.java
Sun Jan 11 23:11:44 2015
@@ -51,6 +51,11 @@ public abstract class LocalFileNameParse
/**
* Pops the root prefix off a URI, which has had the scheme removed.
+ *
+ * @param name the URI to modify.
+ * @param uri the whole URI for error reporting.
+ * @return the root prefix extracted.
+ * @throws FileSystemException if an error occurs.
*/
protected abstract String extractRootPrefix(final String uri,
final StringBuilder name)
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystem.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystem.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystem.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystem.java
Sun Jan 11 23:11:44 2015
@@ -91,6 +91,7 @@ public class SftpFileSystem
/**
* Returns an SFTP channel to the server.
*
+ * @return new or reused channel, never null.
* @throws FileSystemException if a session cannot be created.
* @throws IOException if an I/O error is detected.
*/
@@ -193,6 +194,8 @@ public class SftpFileSystem
/**
* Returns a channel to the pool.
+ *
+ * @param channel the used channel.
*/
protected void putChannel(final ChannelSftp channel)
{
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java
Sun Jan 11 23:11:44 2015
@@ -425,9 +425,8 @@ public final class SftpFileSystemConfigB
/**
* Sets the file name encoding.
*
- * @param opts
- * The FileSystem options.
- * @param fileNameEncoding
+ * @param opts The FileSystem options.
+ * @param fileNameEncoding The name of the encoding to use for file names.
*/
public void setFileNameEncoding(final FileSystemOptions opts, final String
fileNameEncoding)
{
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileObject.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileObject.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileObject.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileObject.java
Sun Jan 11 23:11:44 2015
@@ -72,7 +72,8 @@ public class TarFileObject extends Abstr
}
/**
- * Attaches a child
+ * Attaches a child.
+ * @param childName Name of child to remember.
*/
protected void attachChild(final FileName childName)
{
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileNameParser.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileNameParser.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileNameParser.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileNameParser.java
Sun Jan 11 23:11:44 2015
@@ -66,11 +66,16 @@ public class UrlFileNameParser extends A
}
/**
- * Guess is the given filename is a url with host or not. VFS treats such
urls differently.
+ * Guess if the given file name is an URL with host or not.
* <p>
- * A filename is url-based if the base is a {@code URLFileName} or there
are only 2 slashes
+ * VFS treats such URLs differently.
+ * <p>
+ * A file name is URL-based if the base is a {@code URLFileName} or there
are only 2 slashes
* after the scheme.
* e.g: {@code http://host/path}, {@code file:/path/to/file}, {@code
file:///path/to/file}.
+ * @param base The filename is relative to this base.
+ * @param filename The filename.
+ * @return true if filename contains two slashes or base was URLFileName.
*/
protected boolean isUrlBased(final FileName base, final String filename)
{
@@ -79,8 +84,7 @@ public class UrlFileNameParser extends A
return true;
}
- final int nuofSlash = countSlashes(filename);
- return nuofSlash == 2;
+ return countSlashes(filename) == 2;
}
/**
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileObject.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileObject.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileObject.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileObject.java
Sun Jan 11 23:11:44 2015
@@ -53,6 +53,7 @@ public class ZipFileObject extends Abstr
/**
* Sets the details for this file object.
+ * @param entry ZIP information related to this file.
*/
protected void setZipEntry(final ZipEntry entry)
{
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java
Sun Jan 11 23:11:44 2015
@@ -413,9 +413,16 @@ public abstract class AbstractSyncTask
}
/**
- * Handles an out-of-date file (a file where the destination file
- * either doesn't exist, or is older than the source file).
+ * Handles an out-of-date file.
+ * <p>
+ * This is a file where the destination file
+ * either doesn't exist, or is older than the source file.
+ * <p>
* This implementation does nothing.
+ *
+ * @param srcFile The source file.
+ * @param destFile The destination file.
+ * @throws Exception Implementation can throw any Exception.
*/
protected void handleOutOfDateFile(final FileObject srcFile,
final FileObject destFile)
@@ -424,8 +431,16 @@ public abstract class AbstractSyncTask
}
/**
- * Handles an up-to-date file (where the destination file exists and is
- * newer than the source file). This implementation does nothing.
+ * Handles an up-to-date file.
+ * <p>
+ * This is where the destination file exists and is
+ * newer than the source file.
+ * <p>
+ * This implementation does nothing.
+ *
+ * @param srcFile The source file.
+ * @param destFile The destination file.
+ * @throws Exception Implementation can throw any Exception.
*/
protected void handleUpToDateFile(final FileObject srcFile,
final FileObject destFile)
@@ -435,7 +450,11 @@ public abstract class AbstractSyncTask
/**
* Handles a destination for which there is no corresponding source file.
+ * <p>
* This implementation does nothing.
+ *
+ * @param destFile The existing destination file.
+ * @throws Exception Implementation can throw any Exception.
*/
protected void handleMissingSourceFile(final FileObject destFile)
throws Exception
@@ -444,7 +463,11 @@ public abstract class AbstractSyncTask
/**
* Check if this task cares about destination files with a missing source
- * file. This implementation returns false.
+ * file.
+ * <p>
+ * This implementation returns false.
+ *
+ * @return True if missing file is detected.
*/
protected boolean detectMissingSourceFiles()
{
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/tasks/VfsTask.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/tasks/VfsTask.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/tasks/VfsTask.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/tasks/VfsTask.java
Sun Jan 11 23:11:44 2015
@@ -39,6 +39,8 @@ public class VfsTask
* Resolves a URI to a file, relative to the project's base directory.
*
* @param uri The URI to resolve.
+ * @return resolved file object.
+ * @throws FileSystemException If an error occurred.
*/
protected FileObject resolveFile(final String uri)
throws FileSystemException
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/util/MonitorRandomAccessContent.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/util/MonitorRandomAccessContent.java?rev=1650988&r1=1650987&r2=1650988&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/util/MonitorRandomAccessContent.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/util/MonitorRandomAccessContent.java
Sun Jan 11 23:11:44 2015
@@ -35,7 +35,9 @@ public class MonitorRandomAccessContent
}
/**
- * Called after this stream is closed. This implementation does nothing.
+ * Called after this stream is closed.
+ *
+ * @throws IOException if subclass throws it.
*/
@SuppressWarnings("unused") // IOException is needed because subclasses
may need to throw it
protected void onClose() throws IOException
