This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-vfs.git
The following commit(s) were added to refs/heads/master by this push:
new 233f4f509 Javadoc
233f4f509 is described below
commit 233f4f509e27bd49707bb1d778340dabaae3065c
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Aug 2 17:20:23 2026 -0400
Javadoc
---
.../vfs2/provider/webdav/WebdavFileObject.java | 4 +-
.../vfs2/provider/webdav4/Webdav4FileObject.java | 2 +-
.../vfs2/provider/webdav4/test/JackrabbitMain.java | 2 +-
.../java/org/apache/commons/vfs2/FileContent.java | 14 ++---
.../java/org/apache/commons/vfs2/FileListener.java | 6 +-
.../java/org/apache/commons/vfs2/FileSelector.java | 6 +-
.../java/org/apache/commons/vfs2/FileUtil.java | 4 +-
.../apache/commons/vfs2/RandomAccessContent.java | 10 ++--
.../vfs2/impl/PrivilegedFileReplicator.java | 2 +-
.../vfs2/impl/StandardFileSystemManager.java | 2 +-
.../commons/vfs2/provider/AbstractFileObject.java | 64 +++++++++++-----------
.../vfs2/provider/AbstractRandomAccessContent.java | 2 +-
.../AbstractRandomAccessStreamContent.java | 2 +-
.../commons/vfs2/provider/DefaultFileContent.java | 8 +--
.../commons/vfs2/provider/DelegateFileObject.java | 12 ++--
.../apache/commons/vfs2/provider/URLFileName.java | 2 +-
.../vfs2/provider/bzip2/Bzip2FileObject.java | 2 +-
.../vfs2/provider/ftp/FtpClientFactory.java | 2 +-
.../commons/vfs2/provider/http/HttpFileObject.java | 6 +-
.../vfs2/provider/http5/Http5FileObject.java | 4 +-
.../commons/vfs2/provider/ram/RamFileObject.java | 2 +-
.../commons/vfs2/provider/sftp/SftpFileObject.java | 2 +-
.../commons/vfs2/provider/url/UrlFileObject.java | 2 +-
.../apache/commons/vfs2/util/FileObjectUtils.java | 8 +--
.../commons/vfs2/util/MonitorInputStream.java | 12 ++--
.../commons/vfs2/util/MonitorOutputStream.java | 12 ++--
.../vfs2/util/MonitorRandomAccessContent.java | 4 +-
.../commons/vfs2/util/RawMonitorInputStream.java | 10 ++--
.../commons/vfs2/util/WeakRefFileListener.java | 8 +--
.../vfs2/provider/sftp/SftpTestServerHelper.java | 2 +-
30 files changed, 109 insertions(+), 109 deletions(-)
diff --git
a/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileObject.java
b/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileObject.java
index 9b8526015..ac6f9df93 100644
---
a/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileObject.java
+++
b/commons-vfs2-jackrabbit1/src/main/java/org/apache/commons/vfs2/provider/webdav/WebdavFileObject.java
@@ -360,7 +360,7 @@ public class WebdavFileObject extends
HttpFileObject<WebdavFileSystem> {
* This implementation always returns true.
*
* @return true if the file is writable.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
@Override
protected boolean doIsWriteable() throws Exception {
@@ -605,7 +605,7 @@ public class WebdavFileObject extends
HttpFileObject<WebdavFileSystem> {
*
* @param method The HttpMethod.
* @throws FileSystemException if an error occurs encoding the uri.
- * @throws URIException if the URI is in error.
+ * @throws URIException Thrown if the URI is in error.
*/
@Override
protected void setupMethod(final HttpMethod method) throws
FileSystemException, URIException {
diff --git
a/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileObject.java
b/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileObject.java
index 731361578..1084cdb6c 100644
---
a/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileObject.java
+++
b/commons-vfs2-jackrabbit2/src/main/java/org/apache/commons/vfs2/provider/webdav4/Webdav4FileObject.java
@@ -377,7 +377,7 @@ public class Webdav4FileObject extends
Http4FileObject<Webdav4FileSystem> {
* This implementation always returns true.
*
* @return true if the file is writable.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
@Override
protected boolean doIsWriteable() throws Exception {
diff --git
a/commons-vfs2-jackrabbit2/src/test/java/org/apache/commons/vfs2/provider/webdav4/test/JackrabbitMain.java
b/commons-vfs2-jackrabbit2/src/test/java/org/apache/commons/vfs2/provider/webdav4/test/JackrabbitMain.java
index 3d5e3cdaf..95a886ad7 100644
---
a/commons-vfs2-jackrabbit2/src/test/java/org/apache/commons/vfs2/provider/webdav4/test/JackrabbitMain.java
+++
b/commons-vfs2-jackrabbit2/src/test/java/org/apache/commons/vfs2/provider/webdav4/test/JackrabbitMain.java
@@ -219,7 +219,7 @@ public class JackrabbitMain {
* Run this Main application.
* <p>
* <em>Note:</em> this is public because this can be used by other
projects in unit tests. e.g, Commons-VFS.
- * @throws Exception if any exception occurs
+ * @throws Exception Thrown if any exception occurs
* </p>
*/
public void run() throws Exception {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContent.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContent.java
index 4df6f5672..ac5fc2fb8 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContent.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileContent.java
@@ -86,7 +86,7 @@ public interface FileContent extends Closeable {
* Returns the content of a file as a byte array.
*
* @return The content as a byte array.
- * @throws IOException if the file content cannot be accessed.
+ * @throws IOException Thrown if the file content cannot be accessed.
* @since 2.4
*/
default byte[] getByteArray() throws IOException {
@@ -278,7 +278,7 @@ public interface FileContent extends Closeable {
*
* @param charset The file character set, may be null.
* @return The content as a byte array.
- * @throws IOException if the file content cannot be accessed.
+ * @throws IOException Thrown if the file content cannot be accessed.
* @since 2.4
*/
default String getString(final Charset charset) throws IOException {
@@ -290,7 +290,7 @@ public interface FileContent extends Closeable {
*
* @param charset The file character set, may be null.
* @return The content as a byte array.
- * @throws IOException if the file content cannot be accessed.
+ * @throws IOException Thrown if the file content cannot be accessed.
* @since 2.4
*/
default String getString(final String charset) throws IOException {
@@ -356,7 +356,7 @@ public interface FileContent extends Closeable {
* Writes this content to another FileContent.
*
* @param output The target OutputStream.
- * @throws IOException if an error occurs writing the content.
+ * @throws IOException Thrown if an error occurs writing the content.
* @return The total number of bytes written
* @since 2.1
*/
@@ -366,7 +366,7 @@ public interface FileContent extends Closeable {
* Writes this content to another FileObject.
*
* @param file The target FileObject.
- * @throws IOException if an error occurs writing the content.
+ * @throws IOException Thrown if an error occurs writing the content.
* @return The total number of bytes written
* @since 2.1
*/
@@ -377,7 +377,7 @@ public interface FileContent extends Closeable {
*
* @param output The target OutputStream.
* @return The total number of bytes written
- * @throws IOException if an error occurs writing the content.
+ * @throws IOException Thrown if an error occurs writing the content.
* @since 2.1
*/
long write(OutputStream output) throws IOException;
@@ -388,7 +388,7 @@ public interface FileContent extends Closeable {
* @param output The target OutputStream.
* @param bufferSize The buffer size to write data chunks.
* @return The total number of bytes written
- * @throws IOException if an error occurs writing the file.
+ * @throws IOException Thrown if an error occurs writing the file.
* @since 2.1
*/
long write(OutputStream output, int bufferSize) throws IOException;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileListener.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileListener.java
index 23316ed0a..605767706 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileListener.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileListener.java
@@ -28,7 +28,7 @@ public interface FileListener {
* </p>
*
* @param event The FileChangeEvent.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
void fileChanged(FileChangeEvent event) throws Exception;
@@ -36,7 +36,7 @@ public interface FileListener {
* Called when a file is created.
*
* @param event The FileChangeEvent.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
void fileCreated(FileChangeEvent event) throws Exception;
@@ -44,7 +44,7 @@ public interface FileListener {
* Called when a file is deleted.
*
* @param event The FileChangeEvent.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
void fileDeleted(FileChangeEvent event) throws Exception;
}
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSelector.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSelector.java
index 863bc6b28..f51a88b67 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSelector.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSelector.java
@@ -29,7 +29,7 @@ public interface FileSelector {
*
* @param fileInfo The file or folder to select.
* @return true if the file should be selected.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
boolean includeFile(FileSelectInfo fileInfo) throws Exception;
@@ -42,7 +42,7 @@ public interface FileSelector {
*
* @param fileInfo The file or folder to select.
* @return true if the folder should be traversed.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
* @since 2.10.0
*/
default boolean traverseDescendants(final FileSelectInfo fileInfo) throws
Exception {
@@ -58,7 +58,7 @@ public interface FileSelector {
*
* @param fileInfo The file or folder to select.
* @return true if the folder should be traversed.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
* @deprecated Use {@link #traverseDescendants(FileSelectInfo)}.
*/
@Deprecated
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileUtil.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileUtil.java
index bb10d8f9c..ac9a29bac 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileUtil.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileUtil.java
@@ -49,7 +49,7 @@ public final class FileUtil {
*
* @param file The file to get the content of.
* @return The content as a byte array.
- * @throws IOException if the file content cannot be accessed.
+ * @throws IOException Thrown if the file content cannot be accessed.
* @deprecated Use {@link
org.apache.commons.vfs2.util.FileObjectUtils#getContentAsByteArray(FileObject)}.
*/
@Deprecated
@@ -62,7 +62,7 @@ public final class FileUtil {
*
* @param file The FileObject to write.
* @param output The OutputStream to write to.
- * @throws IOException if an error occurs writing the file.
+ * @throws IOException Thrown if an error occurs writing the file.
* @see FileContent#write(OutputStream)
* @deprecated Use {@link
org.apache.commons.vfs2.util.FileObjectUtils#writeContent(FileObject,
OutputStream)}.
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java
index 113d6d103..a5ffa46b2 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java
@@ -36,7 +36,7 @@ public interface RandomAccessContent extends DataOutput,
DataInput, Closeable {
* If this file has an associated channel then the channel is closed as
well.
* </p>
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
void close() throws IOException;
@@ -45,7 +45,7 @@ public interface RandomAccessContent extends DataOutput,
DataInput, Closeable {
* Returns the current offset in this file.
*
* @return The offset from the beginning of the file, in bytes, at which
the next read or write occurs.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
long getFilePointer() throws IOException;
@@ -56,7 +56,7 @@ public interface RandomAccessContent extends DataOutput,
DataInput, Closeable {
* </p>
*
* @return The InputStream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
InputStream getInputStream() throws IOException;
@@ -64,7 +64,7 @@ public interface RandomAccessContent extends DataOutput,
DataInput, Closeable {
* Returns the length of this file.
*
* @return The length of this file, measured in bytes.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
long length() throws IOException;
@@ -82,7 +82,7 @@ public interface RandomAccessContent extends DataOutput,
DataInput, Closeable {
*
* @param pos The offset position, measured in bytes from the beginning of
the file, at which to set the file
* pointer.
- * @throws IOException if {@code pos} is less than {@code 0} or if an I/O
error occurs.
+ * @throws IOException Thrown if {@code pos} is less than {@code 0} or if
an I/O error occurs.
*/
void seek(long pos) throws IOException;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/PrivilegedFileReplicator.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/PrivilegedFileReplicator.java
index f40f25948..082bb5236 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/PrivilegedFileReplicator.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/PrivilegedFileReplicator.java
@@ -80,7 +80,7 @@ public class PrivilegedFileReplicator implements
FileReplicator, VfsComponent {
/**
* Performs the action.
*
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
@Override
public File run() throws Exception {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/StandardFileSystemManager.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/StandardFileSystemManager.java
index 146d07d40..853cbedb0 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/StandardFileSystemManager.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/StandardFileSystemManager.java
@@ -270,7 +270,7 @@ public class StandardFileSystemManager extends
DefaultFileSystemManager {
/**
* Enumerates resources from different class loaders.
*
- * @throws IOException if {@code getResource} failed.
+ * @throws IOException Thrown if {@code getResource} failed.
* @see #findClassLoader()
*/
private Enumeration<URL> enumerateResources(final String name) throws
IOException {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java
index 71058fc11..fa1010c39 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java
@@ -195,7 +195,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
*
* @param childName The name of the child.
* @param newType The type of the child.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected void childrenChanged(final FileName childName, final FileType
newType) throws Exception {
// TODO - this may be called when not attached
@@ -473,7 +473,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* Detaches this file, invalidating all cached info. This will force a
call to {@link #doAttach} next time this file
* is used.
*
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
private void detach() throws Exception {
synchronized (fileSystem) {
@@ -505,7 +505,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* This implementation does nothing.
* </p>
*
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected void doAttach() throws Exception {
// noop
@@ -530,7 +530,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* </ul>
* This implementation throws an exception.
*
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected void doCreateFolder() throws Exception {
throw new
FileSystemException("vfs.provider/create-folder-not-supported.error");
@@ -545,7 +545,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* </ul>
* This implementation throws an exception.
*
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected void doDelete() throws Exception {
throw new
FileSystemException("vfs.provider/delete-not-supported.error");
@@ -561,7 +561,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* This implementation does nothing.
* </p>
*
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected void doDetach() throws Exception {
// noop
@@ -575,7 +575,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* </p>
*
* @return The attributes of the file.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected Map<String, Object> doGetAttributes() throws Exception {
return Collections.emptyMap();
@@ -589,7 +589,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* </p>
*
* @return The certificates used to sign the file.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected Certificate[] doGetCertificates() throws Exception {
return null;
@@ -600,7 +600,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* {@link FileType#FILE}.
*
* @return The size of the file in bytes.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected abstract long doGetContentSize() throws Exception;
@@ -615,7 +615,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* </p>
*
* @return An InputStream to read the file content.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected InputStream doGetInputStream() throws Exception {
// Backward compatibility.
@@ -633,7 +633,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* </p>
* @param bufferSize Buffer size hint.
* @return An InputStream to read the file content.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected InputStream doGetInputStream(final int bufferSize) throws
Exception {
throw new UnsupportedOperationException(DO_GET_INPUT_STREAM_INT);
@@ -646,7 +646,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* </p>
*
* @return The last modification time.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected long doGetLastModifiedTime() throws Exception {
throw new
FileSystemException("vfs.provider/get-last-modified-not-supported.error");
@@ -669,7 +669,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
*
* @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.
+ * @throws Exception Thrown if an error occurs.
*/
protected OutputStream doGetOutputStream(final boolean bAppend) throws
Exception {
throw new
FileSystemException("vfs.provider/write-not-supported.error");
@@ -683,7 +683,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
*
* @param mode The mode to access the file.
* @return The RandomAccessContext.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected RandomAccessContent doGetRandomAccessContent(final
RandomAccessMode mode) throws Exception {
throw new
FileSystemException("vfs.provider/random-access-not-supported.error");
@@ -694,7 +694,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* implementation can be expensive.
*
* @return The type of the file.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected abstract FileType doGetType() throws Exception;
@@ -706,7 +706,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* </p>
*
* @return true if the file is executable, false otherwise.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected boolean doIsExecutable() throws Exception {
return false;
@@ -720,7 +720,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* </p>
*
* @return true if the file is hidden, false otherwise.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected boolean doIsHidden() throws Exception {
return false;
@@ -734,7 +734,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* </p>
*
* @return true if the file is readable, false otherwise.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected boolean doIsReadable() throws Exception {
return true;
@@ -760,7 +760,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* </p>
*
* @return true if the file is readable, false otherwise.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
* @since 2.4
*/
protected boolean doIsSymbolicLink() throws Exception {
@@ -775,7 +775,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* </p>
*
* @return true if the file is writable.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected boolean doIsWriteable() throws Exception {
return true;
@@ -787,7 +787,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
*
* @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.
+ * @throws Exception Thrown if an error occurs.
*/
protected abstract String[] doListChildren() throws Exception;
@@ -805,7 +805,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* </p>
*
* @return The children of this FileObject.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected FileObject[] doListChildrenResolved() throws Exception {
return null;
@@ -821,7 +821,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* </p>
*
* @param attrName The name of the attribute to remove.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
* @since 2.0
*/
protected void doRemoveAttribute(final String attrName) throws Exception {
@@ -841,7 +841,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* </p>
*
* @param newFile A FileObject with the new file name.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected void doRename(final FileObject newFile) throws Exception {
throw new
FileSystemException("vfs.provider/rename-not-supported.error");
@@ -858,7 +858,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
*
* @param attrName The attribute name.
* @param value The value to be associated with the attribute name.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected void doSetAttribute(final String attrName, final Object value)
throws Exception {
throw new
FileSystemException("vfs.provider/set-attribute-not-supported.error");
@@ -941,7 +941,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
/**
* Called when the output stream for this file is closed.
*
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected void endOutput() throws Exception {
if (getType() == FileType.IMAGINARY) {
@@ -1413,7 +1413,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* This will only happen if you monitor the file using {@link
org.apache.commons.vfs2.FileMonitor}.
* </p>
*
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected void handleChanged() throws Exception {
// Notify the file system
@@ -1424,7 +1424,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* 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.
+ * @throws Exception Thrown if an error occurs.
*/
protected void handleCreate(final FileType newType) throws Exception {
synchronized (fileSystem) {
@@ -1449,7 +1449,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
/**
* Called when this file is deleted. Updates cached info and notifies
subclasses, parent and file system.
*
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected void handleDelete() throws Exception {
synchronized (fileSystem) {
@@ -1742,7 +1742,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
*
* @param childName The name of the child.
* @param newType The type of the child.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
private void notifyParent(final FileName childName, final FileType
newType) throws Exception {
if (parent == null) {
@@ -1764,7 +1764,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
* This implementation does nothing.
* </p>
*
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected void onChange() throws Exception {
// noop
@@ -1779,7 +1779,7 @@ public abstract class AbstractFileObject<AFS extends
AbstractFileSystem> impleme
*
* @param child The name of the child that changed.
* @param newType The type of the file.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected void onChildrenChanged(final FileName child, final FileType
newType) throws Exception {
// noop
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractRandomAccessContent.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractRandomAccessContent.java
index 17babffb6..6a5ae4db2 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractRandomAccessContent.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractRandomAccessContent.java
@@ -44,7 +44,7 @@ public abstract class AbstractRandomAccessContent implements
RandomAccessContent
* @deprecated see {@link DataInputStream#readLine()} This method will be
removed when it is removed from
* the DataInput interface this class implements (which will
probably never happen).
* @return The line as a String.
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
*/
@Override
@Deprecated
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractRandomAccessStreamContent.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractRandomAccessStreamContent.java
index 068e9a674..79b7cc148 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractRandomAccessStreamContent.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractRandomAccessStreamContent.java
@@ -40,7 +40,7 @@ public abstract class AbstractRandomAccessStreamContent
extends AbstractRandomAc
* Gets a DataInputStream.
*
* @return A DataInputStream.
- * @throws IOException if an IO error occurs.
+ * @throws IOException Thrown if an IO error occurs.
*/
protected abstract DataInputStream getDataInputStream() throws IOException;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DefaultFileContent.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DefaultFileContent.java
index 5a4ab4507..fcbb20133 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DefaultFileContent.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DefaultFileContent.java
@@ -814,7 +814,7 @@ public final class DefaultFileContent implements
FileContent {
*
* @param fileContent The target FileContent.
* @return The total number of bytes written
- * @throws IOException if an error occurs writing the content.
+ * @throws IOException Thrown if an error occurs writing the content.
* @since 2.1
*/
@Override
@@ -829,7 +829,7 @@ public final class DefaultFileContent implements
FileContent {
*
* @param file The target FileObject.
* @return The total number of bytes written
- * @throws IOException if an error occurs writing the content.
+ * @throws IOException Thrown if an error occurs writing the content.
* @since 2.1
*/
@Override
@@ -842,7 +842,7 @@ public final class DefaultFileContent implements
FileContent {
*
* @param output The target OutputStream.
* @return The total number of bytes written
- * @throws IOException if an error occurs writing the content.
+ * @throws IOException Thrown if an error occurs writing the content.
* @since 2.1
*/
@Override
@@ -856,7 +856,7 @@ public final class DefaultFileContent implements
FileContent {
* @param output The target OutputStream.
* @param bufferSize The buffer size to write data chunks.
* @return The total number of bytes written.
- * @throws IOException if an error occurs writing the file.
+ * @throws IOException Thrown if an error occurs writing the file.
* @since 2.1
*/
@Override
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java
index 3fb575a18..b27428738 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/DelegateFileObject.java
@@ -74,7 +74,7 @@ public class DelegateFileObject<AFS extends
AbstractFileSystem> extends Abstract
*
* @param baseName The base FileName.
* @param type The FileType.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
public void attachChild(final FileName baseName, final FileType type)
throws Exception {
final FileType oldType = doGetType();
@@ -317,7 +317,7 @@ public class DelegateFileObject<AFS extends
AbstractFileSystem> extends Abstract
* </p>
*
* @param event The FileChangeEvent.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
@Override
public void fileChanged(final FileChangeEvent event) throws Exception {
@@ -333,7 +333,7 @@ public class DelegateFileObject<AFS extends
AbstractFileSystem> extends Abstract
* Called when a file is created.
*
* @param event The FileChangeEvent.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
@Override
public void fileCreated(final FileChangeEvent event) throws Exception {
@@ -349,7 +349,7 @@ public class DelegateFileObject<AFS extends
AbstractFileSystem> extends Abstract
* Called when a file is deleted.
*
* @param event The FileChangeEvent.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
@Override
public void fileDeleted(final FileChangeEvent event) throws Exception {
@@ -379,7 +379,7 @@ public class DelegateFileObject<AFS extends
AbstractFileSystem> extends Abstract
* Checks whether the file's type has changed, and fires the appropriate
events.
*
* @param oldType The old FileType.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
private void maybeTypeChanged(final FileType oldType) throws Exception {
final FileType newType = doGetType();
@@ -408,7 +408,7 @@ public class DelegateFileObject<AFS extends
AbstractFileSystem> extends Abstract
* Attaches or detaches the target file.
*
* @param fileObject The FileObject.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
public void setFile(final FileObject fileObject) throws Exception {
final FileType oldType = doGetType();
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileName.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileName.java
index 888c2bfc8..718400306 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileName.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/URLFileName.java
@@ -141,7 +141,7 @@ public class URLFileName extends GenericFileName {
* @param charset The character set.
* @return The encoded URI
* @throws FileSystemException if some other exception occurs.
- * @throws URIException if an exception occurs encoding the URI.
+ * @throws URIException Thrown if an exception occurs encoding the URI.
*/
public String getURIEncoded(final String charset) throws
FileSystemException, URIException {
final StringBuilder sb = new StringBuilder(BUFFER_SIZE);
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.java
index bb341903a..483952e62 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.java
@@ -45,7 +45,7 @@ public class Bzip2FileObject extends
CompressedFileFileObject<Bzip2FileSystem> {
* @param name Unused.
* @param inputStream The input stream to wrap.
* @return A new compressor input stream.
- * @throws IOException if the stream content is malformed or an I/O error
occurs.
+ * @throws IOException Thrown if the stream content is malformed or an I/O
error occurs.
*/
public static InputStream wrapInputStream(final String name, final
InputStream inputStream) throws IOException {
return new BZip2CompressorInputStream(inputStream);
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClientFactory.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClientFactory.java
index e725ac8ac..bdad844c4 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClientFactory.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClientFactory.java
@@ -243,7 +243,7 @@ public final class FtpClientFactory {
*
* @param client The client.
* @param fileSystemOptions The file system options.
- * @throws IOException if an IO error occurs.
+ * @throws IOException Thrown if an IO error occurs.
*/
protected abstract void setupOpenConnection(C client,
FileSystemOptions fileSystemOptions) throws IOException;
}
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileObject.java
index 4d7f5b3a3..049609277 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileObject.java
@@ -212,7 +212,7 @@ public class HttpFileObject<FS extends HttpFileSystem>
extends AbstractFileObjec
*
* @param unescaped An unescaped path.
* @return The encoded path.
- * @throws URIException if the default protocol charset is not supported
+ * @throws URIException Thrown if the default protocol charset is not
supported
*/
protected String encodePath(final String unescaped) throws URIException {
return URIUtil.encodePath(unescaped);
@@ -241,7 +241,7 @@ public class HttpFileObject<FS extends HttpFileSystem>
extends AbstractFileObjec
* Gets a new HeadMethod.
*
* @return A new HeadMethod.
- * @throws IOException if an IO error occurs.
+ * @throws IOException Thrown if an IO error occurs.
*/
HeadMethod getHeadMethod() throws IOException {
// need to synchronize on the file system as the detach method will
clear out "method"
@@ -284,7 +284,7 @@ public class HttpFileObject<FS extends HttpFileSystem>
extends AbstractFileObjec
*
* @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.
+ * @throws URIException Thrown if path cannot be represented.
* @since 2.0 (was package)
*/
protected void setupMethod(final HttpMethod method) throws
FileSystemException, URIException {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java
index d925a29e6..26f589f3b 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http5/Http5FileObject.java
@@ -171,7 +171,7 @@ public class Http5FileObject<FS extends Http5FileSystem>
extends AbstractFileObj
*
* @param httpRequest {@code HttpUriRequest} object
* @return {@code ClassicHttpResponse} from the execution
- * @throws IOException if IO error occurs
+ * @throws IOException Thrown if IO error occurs
*/
protected ClassicHttpResponse executeHttpUriRequest(final HttpUriRequest
httpRequest) throws IOException {
final FS abstractFileSystem = getAbstractFileSystem();
@@ -198,7 +198,7 @@ public class Http5FileObject<FS extends Http5FileSystem>
extends AbstractFileObj
* Gets the last executed HEAD {@code HttpResponse} object.
*
* @return The last executed HEAD {@code HttpResponse} object
- * @throws IOException if IO error occurs
+ * @throws IOException Thrown if IO error occurs
*/
ClassicHttpResponse getLastHeadResponse() throws IOException {
if (lastHeadResponse != null) {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileObject.java
index d24342198..9cb8034f4 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileObject.java
@@ -222,7 +222,7 @@ public class RamFileObject extends
AbstractFileObject<RamFileSystem> {
/**
* @param newSize The new buffer size.
- * @throws IOException if the new size exceeds the limit
+ * @throws IOException Thrown if the new size exceeds the limit
*/
synchronized void resize(final long newSize) throws IOException {
final RamFileSystem afs = getAbstractFileSystem();
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileObject.java
index 4b31bace0..58a991183 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileObject.java
@@ -524,7 +524,7 @@ public class SftpFileObject extends
AbstractFileObject<SftpFileSystem> {
/**
* Fetches file attributes from server.
*
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
*/
private synchronized void statSelf() throws IOException {
ChannelSftp channelSftp = null;
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileObject.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileObject.java
index ef51c6919..2d1cef5c0 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileObject.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileObject.java
@@ -57,7 +57,7 @@ public class UrlFileObject extends
AbstractFileObject<UrlFileSystem> {
*
* @param name The file name.
* @return A new URL.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected URL createURL(final FileName name) throws IOException {
if (name instanceof URLFileName) {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/FileObjectUtils.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/FileObjectUtils.java
index 64bd33bbd..f90d76082 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/FileObjectUtils.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/FileObjectUtils.java
@@ -73,7 +73,7 @@ public final class FileObjectUtils {
*
* @param file Gets the contents of this file object.
* @return The content as a byte array.
- * @throws IOException if the file content cannot be accessed.
+ * @throws IOException Thrown if the file content cannot be accessed.
* @since 2.6.0
*/
public static byte[] getContentAsByteArray(final FileObject file) throws
IOException {
@@ -90,7 +90,7 @@ public final class FileObjectUtils {
* @param file Gets the contents of this file object.
* @param charset The file character set, may be null.
* @return The content as a string.
- * @throws IOException if the file content cannot be accessed.
+ * @throws IOException Thrown if the file content cannot be accessed.
* @since 2.4
*/
public static String getContentAsString(final FileObject file, final
Charset charset) throws IOException {
@@ -107,7 +107,7 @@ public final class FileObjectUtils {
* @param file Gets the contents of this file object.
* @param charset The file character set, may be null.
* @return The content as a string.
- * @throws IOException if the file content cannot be accessed.
+ * @throws IOException Thrown if the file content cannot be accessed.
* @since 2.4
*/
public static String getContentAsString(final FileObject file, final
String charset) throws IOException {
@@ -195,7 +195,7 @@ public final class FileObjectUtils {
*
* @param file The FileObject to write.
* @param output The OutputStream to write to.
- * @throws IOException if an error occurs writing the file.
+ * @throws IOException Thrown if an error occurs writing the file.
* @see FileContent#write(OutputStream)
* @since 2.6.0
*/
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorInputStream.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorInputStream.java
index e8c46f317..d09b685e1 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorInputStream.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorInputStream.java
@@ -55,7 +55,7 @@ public class MonitorInputStream extends BufferedInputStream {
* Returns 0 if the stream is at EOF, else the underlying inputStream will
be queried.
*
* @return The number of bytes that are available.
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
* @since 2.0
*/
@Override
@@ -69,7 +69,7 @@ public class MonitorInputStream extends BufferedInputStream {
/**
* Closes this input stream and releases any system resources associated
with the stream.
*
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
*/
@Override
public void close() throws IOException {
@@ -100,7 +100,7 @@ public class MonitorInputStream extends BufferedInputStream
{
* the underlying stream (VFS-805). There are cases where closing that
stream will
* consume any amount of remaining data. In such cases closing a different
* entity instead (such as an HttpResponse) may be more appropriate.
- * @throws IOException if an IO error occurs.
+ * @throws IOException Thrown if an IO error occurs.
*/
protected void closeSuper() throws IOException {
super.close();
@@ -122,7 +122,7 @@ public class MonitorInputStream extends BufferedInputStream
{
/**
* Called after the stream has been closed. This implementation does
nothing.
*
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
*/
protected void onClose() throws IOException {
// noop
@@ -132,7 +132,7 @@ public class MonitorInputStream extends BufferedInputStream
{
* Reads a character.
*
* @return The character that was read as an integer.
- * @throws IOException if an IO error occurs.
+ * @throws IOException Thrown if an IO error occurs.
*/
@Override
public synchronized int read() throws IOException {
@@ -153,7 +153,7 @@ public class MonitorInputStream extends BufferedInputStream
{
* @param offset The offset at which to start reading.
* @param length The maximum number of bytes to read.
* @return The number of bytes read.
- * @throws IOException if an IO error occurs.
+ * @throws IOException Thrown if an IO error occurs.
*/
@Override
public synchronized int read(final byte[] buffer, final int offset, final
int length) throws IOException {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorOutputStream.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorOutputStream.java
index 6efb25712..aaeace699 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorOutputStream.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorOutputStream.java
@@ -76,7 +76,7 @@ public class MonitorOutputStream extends BufferedOutputStream
{
* This does nothing if the stream is closed already.
* </p>
*
- * @throws IOException if an IO error occurs.
+ * @throws IOException Thrown if an IO error occurs.
*/
@Override
public void close() throws IOException {
@@ -116,7 +116,7 @@ public class MonitorOutputStream extends
BufferedOutputStream {
}
/**
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
* @since 2.0
*/
@Override
@@ -137,7 +137,7 @@ public class MonitorOutputStream extends
BufferedOutputStream {
* This implementation does nothing.
* </p>
*
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
*/
// IOException is needed because subclasses may need to throw it
protected void onClose() throws IOException {
@@ -145,7 +145,7 @@ public class MonitorOutputStream extends
BufferedOutputStream {
/**
* @param b The byte array.
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
* @since 2.0
*/
@Override
@@ -158,7 +158,7 @@ public class MonitorOutputStream extends
BufferedOutputStream {
* @param b The byte array.
* @param off The offset into the array.
* @param len The number of bytes to write.
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
* @since 2.0
*/
@Override
@@ -169,7 +169,7 @@ public class MonitorOutputStream extends
BufferedOutputStream {
/**
* @param b The character to write.
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
* @since 2.0
*/
@Override
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorRandomAccessContent.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorRandomAccessContent.java
index 2eebdb043..e1f0dcd2e 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorRandomAccessContent.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/MonitorRandomAccessContent.java
@@ -41,7 +41,7 @@ public class MonitorRandomAccessContent implements
RandomAccessContent {
/**
* Closes this content.
*
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
*/
@Override
public void close() throws IOException {
@@ -90,7 +90,7 @@ public class MonitorRandomAccessContent implements
RandomAccessContent {
/**
* Called after this stream is closed.
*
- * @throws IOException if subclass throws it.
+ * @throws IOException Thrown if subclass throws it.
*/
@SuppressWarnings("unused") // IOException is needed because subclasses
may need to throw it
protected void onClose() throws IOException {
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/RawMonitorInputStream.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/RawMonitorInputStream.java
index 1ecfc7c06..0f6657710 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/RawMonitorInputStream.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/RawMonitorInputStream.java
@@ -64,7 +64,7 @@ public class RawMonitorInputStream extends FilterInputStream {
* Returns 0 if the stream is at EOF, else the underlying inputStream will
be queried.
*
* @return The number of bytes that are available.
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
*/
@Override
public synchronized int available() throws IOException {
@@ -78,7 +78,7 @@ public class RawMonitorInputStream extends FilterInputStream {
/**
* Closes this input stream and releases any system resources associated
with the stream.
*
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
*/
@Override
public void close() throws IOException {
@@ -125,7 +125,7 @@ public class RawMonitorInputStream extends
FilterInputStream {
/**
* Called after the stream has been closed. This implementation does
nothing.
*
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
*/
protected void onClose() throws IOException {
// noop
@@ -135,7 +135,7 @@ public class RawMonitorInputStream extends
FilterInputStream {
* Reads a character.
*
* @return The character that was read as an integer.
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
*/
@Override
public int read() throws IOException { // lgtm [java/non-sync-override]
@@ -158,7 +158,7 @@ public class RawMonitorInputStream extends
FilterInputStream {
* @param offset The offset at which to start reading.
* @param length The maximum number of bytes to read.
* @return The number of bytes read.
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
*/
@Override
public int read(final byte[] buffer, final int offset, final int length)
throws IOException { // lgtm [java/non-sync-override]
diff --git
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/WeakRefFileListener.java
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/WeakRefFileListener.java
index bc669784a..26f033c14 100644
---
a/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/WeakRefFileListener.java
+++
b/commons-vfs2/src/main/java/org/apache/commons/vfs2/util/WeakRefFileListener.java
@@ -76,7 +76,7 @@ public class WeakRefFileListener implements FileListener {
* </p>
*
* @param event The FileChangeEvent.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
@Override
public void fileChanged(final FileChangeEvent event) throws Exception {
@@ -90,7 +90,7 @@ public class WeakRefFileListener implements FileListener {
* Called when a file is created.
*
* @param event The FileChangeEvent.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
@Override
public void fileCreated(final FileChangeEvent event) throws Exception {
@@ -104,7 +104,7 @@ public class WeakRefFileListener implements FileListener {
* Called when a file is deleted.
*
* @param event The FileChangeEvent.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
@Override
public void fileDeleted(final FileChangeEvent event) throws Exception {
@@ -119,7 +119,7 @@ public class WeakRefFileListener implements FileListener {
* listeners.
*
* @return The FileListener.
- * @throws Exception if an error occurs.
+ * @throws Exception Thrown if an error occurs.
*/
protected FileListener getListener() throws Exception {
final FileListener listener = this.listener.get();
diff --git
a/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/sftp/SftpTestServerHelper.java
b/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/sftp/SftpTestServerHelper.java
index 56dcc1b88..a7af3e32e 100644
---
a/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/sftp/SftpTestServerHelper.java
+++
b/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/sftp/SftpTestServerHelper.java
@@ -257,7 +257,7 @@ public final class SftpTestServerHelper {
/**
* Starts the embedded SFTP server.
*
- * @throws IOException if server cannot be started
+ * @throws IOException Thrown if server cannot be started
*/
public static synchronized void startServer() throws IOException {
if (server != null) {
