You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by rg...@apache.org on 2009/04/13 06:06:06 UTC
svn commit: r764356 [1/11] - in /commons/proper/vfs/trunk: ./
core/src/main/java/org/apache/commons/vfs/
core/src/main/java/org/apache/commons/vfs/auth/
core/src/main/java/org/apache/commons/vfs/cache/
core/src/main/java/org/apache/commons/vfs/events/ ...
Author: rgoers
Date: Mon Apr 13 04:06:01 2009
New Revision: 764356
URL: http://svn.apache.org/viewvc?rev=764356&view=rev
Log:
Fixed thousands of checkstyle errors. No application logic was changed
Added:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/auth/package.html (with props)
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/package.html (with props)
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/events/package.html (with props)
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/vcs/package.html (with props)
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/bzip2/package.html (with props)
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/compressed/package.html (with props)
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/gzip/package.html (with props)
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/http/package.html (with props)
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/https/package.html (with props)
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/webdav/package.html (with props)
Modified:
commons/proper/vfs/trunk/checkstyle.xml
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileContent.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileName.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileObject.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSelectInfo.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSelector.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystem.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemConfigBuilder.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemException.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemManager.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemOptions.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileType.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileTypeHasNoContentException.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileTypeSelector.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileUtil.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/NameScope.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/RandomAccessContent.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/Selectors.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/UserAuthenticationData.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/UserAuthenticator.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/VFS.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/VfsLog.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/auth/StaticUserAuthenticator.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/AbstractFilesCache.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/DefaultFilesCache.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/FileSystemAndNameKey.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/LRUFilesCache.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/NullFilesCache.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/OnCallRefreshFileObject.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/SoftRefFilesCache.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/WeakRefFilesCache.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/events/AbstractFileChangeEvent.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/events/ChangedEvent.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/events/CreateEvent.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/events/DeleteEvent.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/impl/DecoratedFileObject.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/impl/DefaultFileContentInfo.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/impl/DefaultFileMonitor.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/impl/DefaultFileReplicator.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/impl/DefaultFileSystemConfigBuilder.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/impl/DefaultFileSystemManager.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/impl/DefaultVfsComponentContext.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/impl/FileContentInfoFilenameFactory.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/impl/FileTypeMap.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/impl/PrivilegedFileReplicator.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/impl/ProviderConfiguration.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/impl/Resource.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/impl/StandardFileSystemManager.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/impl/SynchronizedFileObject.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/impl/URLStreamHandlerProxy.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/impl/VFSClassLoader.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/impl/VirtualFileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/impl/VirtualFileSystem.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/AbstractFileOperation.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/AbstractFileOperationProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/DefaultFileOperations.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/FileOperation.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/FileOperationProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/FileOperations.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/vcs/VcsAdd.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/vcs/VcsCheckout.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/vcs/VcsCommit.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/vcs/VcsCommitListener.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/vcs/VcsDelete.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/vcs/VcsLog.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/vcs/VcsLogEntry.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/vcs/VcsLogEntryHandler.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/vcs/VcsModifyListener.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/vcs/VcsRevert.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/vcs/VcsStatus.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/vcs/VcsUpdate.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/operations/vcs/VcsUpdateListener.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/AbstractFileName.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/AbstractFileObject.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/AbstractFileSystem.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/AbstractLayeredFileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/AbstractOriginatingFileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/AbstractRandomAccessContent.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/AbstractRandomAccessStreamContent.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/AbstractVfsComponent.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/AbstractVfsContainer.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/DefaultFileContent.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/DefaultFileSelectorInfo.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/DefaultURLConnection.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/DefaultURLStreamHandler.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/DelegateFileObject.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/FileContentThreadData.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/FileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/FileReplicator.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/GenericFileName.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/LayeredFileName.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/LocalFileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/TemporaryFileStore.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/UriParser.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/VfsComponent.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/VfsComponentContext.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/bzip2/BZip2Constants.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/bzip2/Bzip2FileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/bzip2/Bzip2FileSystem.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/bzip2/CBZip2InputStream.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/bzip2/CBZip2OutputStream.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/bzip2/CRC.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/ftp/FTPClientWrapper.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/ftp/FtpClientFactory.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/ftp/FtpFileObject.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/ftp/FtpFileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/ftp/FtpFileSystem.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/ftp/FtpFileSystemConfigBuilder.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/ftp/FtpRandomAccessContent.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/http/HttpClientFactory.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/http/HttpFileContentInfoFactory.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/http/HttpFileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/http/HttpFileSystem.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/http/HttpFileSystemConfigBuilder.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/http/HttpRandomAccesContent.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/https/HttpsFileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/jar/JarURLConnectionImpl.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/local/GenericFileNameParser.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/local/LocalFile.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/local/LocalFileNameParser.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/local/LocalFileRandomAccessContent.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/local/WindowsFileNameParser.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/ram/RamFileData.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/ram/RamFileObject.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/ram/RamFileOutputStream.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/ram/RamFileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/ram/RamFileRandomAccessContent.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/ram/RamFileSystem.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/ram/RamFileSystemConfigBuilder.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/sftp/SftpClientFactory.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/sftp/SftpFileNameParser.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/sftp/SftpFileObject.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/sftp/SftpFileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/sftp/SftpFileSystem.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/sftp/SftpFileSystemConfigBuilder.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/sftp/SftpRandomAccessContent.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarBuffer.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarConstants.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarEntry.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarFileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarFileSystem.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarInputStream.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TarUtils.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/Tbz2FileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/tar/TgzFileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/temp/TemporaryFileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/webdav/ExceptionConverter.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/webdav/WebdavFileContentInfoFactory.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/webdav/WebdavFileNameParser.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/webdav/WebdavFileObject.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/webdav/WebdavFileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/webdav/WebdavFileSystem.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/webdav/WebdavFileSystemConfigBuilder.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/webdav/WebdavMethodRetryHandler.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/zip/ZipFileProvider.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/provider/zip/ZipFileSystem.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/AbstractSyncTask.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/CopyTask.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/DeleteTask.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/MkdirTask.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/MoveTask.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/ShowFileTask.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/tasks/SyncTask.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/util/CombinedResources.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/util/FileObjectUtils.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/util/MonitorInputStream.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/util/MonitorOutputStream.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/util/Os.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/util/OsFamily.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/util/RandomAccessMode.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/util/UserAuthenticatorUtils.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/util/WeakRefFileListener.java
Modified: commons/proper/vfs/trunk/checkstyle.xml
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/checkstyle.xml?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/checkstyle.xml (original)
+++ commons/proper/vfs/trunk/checkstyle.xml Mon Apr 13 04:06:01 2009
@@ -39,7 +39,9 @@
<module name="JavadocType">
<property name="authorFormat" value="\S"/>
</module>
- <module name="JavadocVariable"/>
+ <module name="JavadocVariable">
+ <property name="scope" value="protected"/>
+ </module>
<!-- Checks for Naming Conventions. -->
@@ -105,7 +107,11 @@
<!-- Checks for blocks. You know, those {}'s -->
<!-- See http://checkstyle.sf.net/config_blocks.html -->
<module name="AvoidNestedBlocks"/>
- <module name="EmptyBlock"/>
+ <!-- Require empty catch blocks to have at least a comment -->
+ <module name="EmptyBlock">
+ <property name="option" value="text"/>
+ <property name="tokens" value="LITERAL_CATCH"/>
+ </module>
<module name="LeftCurly">
<property name="option" value="nl"/>
</module>
@@ -158,7 +164,9 @@
<property name="format" value="\s+$"/>
<property name="message" value="Line has trailing spaces."/>
</module>
- <module name="TodoComment"/>
+ <module name="TodoComment">
+ <property name="severity" value="info"/>
+ </module>
<module name="UpperEll"/>
</module>
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileContent.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileContent.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileContent.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileContent.java Mon Apr 13 04:06:01 2009
@@ -191,7 +191,7 @@
* @throws FileSystemException If the file is read-only, or is being read, or is being written,
* or on error opening the stream.
*/
- public RandomAccessContent getRandomAccessContent(final RandomAccessMode mode) throws FileSystemException;
+ RandomAccessContent getRandomAccessContent(final RandomAccessMode mode) throws FileSystemException;
/**
* Returns an output stream for writing the file's content.
@@ -228,11 +228,11 @@
* @return the FileContentInfo
* @throws FileSystemException if an error occurs.
*/
- public FileContentInfo getContentInfo() throws FileSystemException;
+ FileContentInfo getContentInfo() throws FileSystemException;
/**
* check if this file has open streams
* @return true if the file is open, false otherwise.
*/
- public boolean isOpen();
+ boolean isOpen();
}
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileName.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileName.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileName.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileName.java Mon Apr 13 04:06:01 2009
@@ -86,7 +86,7 @@
* @return The extension. Returns an empty string if the name has no
* extension.
*/
- public String getExtension();
+ String getExtension();
/**
* Returns the depth of this file name, within its file system. The depth
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileObject.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileObject.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileObject.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileObject.java Mon Apr 13 04:06:01 2009
@@ -132,7 +132,7 @@
* the root of a file system.
* @throws FileSystemException On error finding the file's parent.
*/
- public FileObject getParent() throws FileSystemException;
+ FileObject getParent() throws FileSystemException;
/**
* Returns the file system that contains this file.
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSelectInfo.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSelectInfo.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSelectInfo.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSelectInfo.java Mon Apr 13 04:06:01 2009
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -28,16 +28,19 @@
{
/**
* Returns the base folder of the traversal.
+ * @return FileObject representing the base folder.
*/
FileObject getBaseFolder();
/**
* Returns the file (or folder) to be considered.
+ * @return The FileObject.
*/
FileObject getFile();
/**
* Returns the depth of the file relative to the base folder.
+ * @return The depth of the file relative to the base folder.
*/
int getDepth();
}
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSelector.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSelector.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSelector.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSelector.java Mon Apr 13 04:06:01 2009
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -32,6 +32,7 @@
*
* @param fileInfo the file or folder to select.
* @return true if the file should be selected.
+ * @throws Exception if an error occurs.
*/
boolean includeFile(FileSelectInfo fileInfo)
throws Exception;
@@ -46,6 +47,7 @@
*
* @param fileInfo the file or folder to select.
* @return true if the folder should be traversed.
+ * @throws Exception if an error occurs.
*/
boolean traverseDescendents(FileSelectInfo fileInfo)
throws Exception;
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystem.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystem.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystem.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystem.java Mon Apr 13 04:06:01 2009
@@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -28,11 +28,14 @@
{
/**
* Returns the root file of this file system.
+ * @return The root FileObject.
+ * @throws FileSystemException if an error occurs.
*/
FileObject getRoot() throws FileSystemException;
/**
* Returns the name of the root file of this file system.
+ * @return the root FileName.
*/
FileName getRootName();
@@ -51,6 +54,7 @@
* Returns the parent layer if this is a layered file system.
*
* @return The parent layer, or null if this is not a layered file system.
+ * @throws FileSystemException if an error occurs.
*/
FileObject getParentLayer() throws FileSystemException;
@@ -89,6 +93,7 @@
*
* @param name The name of the file.
* @return The file. Never returns null.
+ * @throws FileSystemException if an error occurs.
*/
FileObject resolveFile(FileName name) throws FileSystemException;
@@ -97,6 +102,7 @@
*
* @param name The name of the file. This must be an absolute path.
* @return The file. Never returns null.
+ * @throws FileSystemException if an error occurs.
*/
FileObject resolveFile(String name) throws FileSystemException;
@@ -159,11 +165,13 @@
/**
* Returns the FileSystemOptions used to instantiate this filesystem
+ * @return The FileSystemOptions.
*/
FileSystemOptions getFileSystemOptions();
/**
* Returns a reference to the FileSytemManager
+ * @return The FileSystemManager.
*/
FileSystemManager getFileSystemManager();
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemConfigBuilder.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemConfigBuilder.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemConfigBuilder.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemConfigBuilder.java Mon Apr 13 04:06:01 2009
@@ -24,8 +24,10 @@
*/
public abstract class FileSystemConfigBuilder
{
+ /** Default prefix to use when resolving system properties */
private static final String PREFIX = "vfs.";
+ /** The prefix to use when resolving system properties */
private final String prefix;
protected FileSystemConfigBuilder()
@@ -74,7 +76,7 @@
protected Boolean getBoolean(FileSystemOptions opts, String name, Boolean defaultValue)
{
- Boolean value = (Boolean)getParam(opts, name);
+ Boolean value = (Boolean) getParam(opts, name);
if (value == null)
{
String str = System.getProperty(PREFIX + name);
@@ -99,7 +101,7 @@
protected Byte getByte(FileSystemOptions opts, String name, Byte defaultValue)
{
- Byte value = (Byte)getParam(opts, name);
+ Byte value = (Byte) getParam(opts, name);
if (value == null)
{
String str = System.getProperty(this.prefix + name);
@@ -124,7 +126,7 @@
protected Character getCharacter(FileSystemOptions opts, String name, Character defaultValue)
{
- Character value = (Character)getParam(opts, name);
+ Character value = (Character) getParam(opts, name);
if (value == null)
{
String str = System.getProperty(this.prefix + name);
@@ -149,7 +151,7 @@
protected Double getDouble(FileSystemOptions opts, String name, Double defaultValue)
{
- Double value = (Double)getParam(opts, name);
+ Double value = (Double) getParam(opts, name);
if (value == null)
{
String str = System.getProperty(this.prefix + name);
@@ -174,7 +176,7 @@
protected Float getFloat(FileSystemOptions opts, String name, Float defaultValue)
{
- Float value = (Float)getParam(opts, name);
+ Float value = (Float) getParam(opts, name);
if (value == null)
{
String str = System.getProperty(this.prefix + name);
@@ -199,7 +201,7 @@
protected Integer getInteger(FileSystemOptions opts, String name, Integer defaultValue)
{
- Integer value = (Integer)getParam(opts, name);
+ Integer value = (Integer) getParam(opts, name);
if (value == null)
{
String str = System.getProperty(this.prefix + name);
@@ -224,7 +226,7 @@
protected Long getLong(FileSystemOptions opts, String name, Long defaultValue)
{
- Long value = (Long)getParam(opts, name);
+ Long value = (Long) getParam(opts, name);
if (value == null)
{
String str = System.getProperty(this.prefix + name);
@@ -249,7 +251,7 @@
protected Short getShort(FileSystemOptions opts, String name, Short defaultValue)
{
- Short value = (Short)getParam(opts, name);
+ Short value = (Short) getParam(opts, name);
if (value == null)
{
String str = System.getProperty(this.prefix + name);
@@ -269,7 +271,7 @@
protected String getString(FileSystemOptions opts, String name, String defaultValue)
{
- String value = (String)getParam(opts, name);
+ String value = (String) getParam(opts, name);
if (value == null)
{
value = System.getProperty(this.prefix + name);
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemException.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemException.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemException.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemException.java Mon Apr 13 04:06:01 2009
@@ -31,7 +31,10 @@
public class FileSystemException
extends IOException
{
+ /** URL pattern */
private static final Pattern URL_PATTERN = Pattern.compile("[a-z]+://.*");
+
+ /** Password pattern */
private static final Pattern PASSWORD_PATTERN = Pattern.compile(":(?:[^/]+)@");
/**
@@ -131,7 +134,8 @@
String value = String.valueOf(info[i]);
// mask passwords (VFS-169)
final Matcher urlMatcher = URL_PATTERN.matcher(value);
- if (urlMatcher.find()) {
+ if (urlMatcher.find())
+ {
final Matcher pwdMatcher = PASSWORD_PATTERN.matcher(value);
value = pwdMatcher.replaceFirst(":***@");
}
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemManager.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemManager.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemManager.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemManager.java Mon Apr 13 04:06:01 2009
@@ -73,8 +73,10 @@
{
/**
* Returns the base file used to resolve relative paths.
+ * @return The base FileObject.
+ * @throws FileSystemException if an error occurs.
*/
- public FileObject getBaseFile() throws FileSystemException;
+ FileObject getBaseFile() throws FileSystemException;
/**
* Locates a file by name. Equivalent to calling
@@ -84,8 +86,7 @@
* @return The file. Never returns null.
* @throws FileSystemException On error parsing the file name.
*/
- public FileObject resolveFile(String name)
- throws FileSystemException;
+ FileObject resolveFile(String name) throws FileSystemException;
/**
* Locates a file by name. Equivalent to calling
@@ -96,10 +97,10 @@
* @return The file. Never returns null.
* @throws FileSystemException On error parsing the file name.
*/
- public FileObject resolveFile(String name, FileSystemOptions fileSystemOptions)
+ FileObject resolveFile(String name, FileSystemOptions fileSystemOptions)
throws FileSystemException;
- /**
+ /** ยง
* Locates a file by name. The name is resolved as described
* <a href="#naming">above</a>. That is, the name can be either
* an absolute URI, an absolute file name, or a relative path to
@@ -113,8 +114,7 @@
* @return The file. Never returns null.
* @throws FileSystemException On error parsing the file name.
*/
- public FileObject resolveFile(FileObject baseFile, String name)
- throws FileSystemException;
+ FileObject resolveFile(FileObject baseFile, String name) throws FileSystemException;
/**
* Locates a file by name. See {@link #resolveFile(FileObject, String)}
@@ -126,8 +126,7 @@
* @return The file. Never returns null.
* @throws FileSystemException On error parsing the file name.
*/
- public FileObject resolveFile(File baseFile, String name)
- throws FileSystemException;
+ FileObject resolveFile(File baseFile, String name) throws FileSystemException;
/**
* Resolves a name, relative to this file name. Equivalent to calling
@@ -138,7 +137,7 @@
* @return A {@link FileName} object representing the resolved file name.
* @throws FileSystemException If the name is invalid.
*/
- public FileName resolveName(final FileName root, final String name) throws FileSystemException;
+ FileName resolveName(final FileName root, final String name) throws FileSystemException;
/**
* Resolves a name, relative to the "root" file name. Refer to {@link NameScope}
@@ -150,7 +149,7 @@
* @return A {@link FileName} object representing the resolved file name.
* @throws FileSystemException If the name is invalid.
*/
- public FileName resolveName(final FileName root, String name, NameScope scope)
+ FileName resolveName(final FileName root, String name, NameScope scope)
throws FileSystemException;
/**
@@ -161,8 +160,7 @@
* returns null.
* @throws FileSystemException On error converting the file.
*/
- public FileObject toFileObject(File file)
- throws FileSystemException;
+ FileObject toFileObject(File file) throws FileSystemException;
/**
* Creates a layered file system. A layered file system is a file system
@@ -174,16 +172,17 @@
* @return The root file of the new file system.
* @throws FileSystemException On error creating the file system.
*/
- public FileObject createFileSystem(String provider, FileObject file)
+ FileObject createFileSystem(String provider, FileObject file)
throws FileSystemException;
- /**
- * Closes the given filesystem.<br />
- * If you use VFS as singleton it is VERY dangerous to call this method.
- */
- public void closeFileSystem(FileSystem filesystem);
+ /**
+ * Closes the given filesystem.<br />
+ * If you use VFS as singleton it is VERY dangerous to call this method.
+ * @param filesystem The FileSystem to close.
+ */
+ void closeFileSystem(FileSystem filesystem);
- /**
+ /**
* Creates a layered file system. A layered file system is a file system
* that is created from the contents of a file, such as a zip or tar file.
*
@@ -191,8 +190,7 @@
* @return The root file of the new file system.
* @throws FileSystemException On error creating the file system.
*/
- public FileObject createFileSystem(FileObject file)
- throws FileSystemException;
+ FileObject createFileSystem(FileObject file) throws FileSystemException;
/**
* Creates an empty virtual file system. Can be populated by adding
@@ -200,9 +198,9 @@
*
* @param rootUri The root URI to use for the new file system. Can be null.
* @return The root file of the new file system.
+ * @throws FileSystemException if an error occurs creating the VirtualFileSystem.
*/
- public FileObject createVirtualFileSystem(String rootUri)
- throws FileSystemException;
+ FileObject createVirtualFileSystem(String rootUri) throws FileSystemException;
/**
* Creates a virtual file system. The file system will contain a junction
@@ -210,84 +208,102 @@
*
* @param rootFile The root file to backs the file system.
* @return The root of the new file system.
+ * @throws FileSystemException if an error occurs creating the VirtualFileSystem.
*/
- public FileObject createVirtualFileSystem(FileObject rootFile)
- throws FileSystemException;
+ FileObject createVirtualFileSystem(FileObject rootFile) throws FileSystemException;
/**
* Returns a streamhandler factory to enable URL lookup using this
* FileSystemManager.
+ * @return the URLStreamHandlerFactory.
*/
- public URLStreamHandlerFactory getURLStreamHandlerFactory();
+ URLStreamHandlerFactory getURLStreamHandlerFactory();
/**
* Determines if a layered file system can be created for a given file.
*
* @param file The file to check for.
+ * @return true if the FileSystem can be created.
+ * @throws FileSystemException if an error occurs.
*/
- public boolean canCreateFileSystem(FileObject file) throws FileSystemException;
+ boolean canCreateFileSystem(FileObject file) throws FileSystemException;
/**
* Get the cache used to cache fileobjects.
+ * @return The FilesCache.
*/
- public FilesCache getFilesCache();
+ FilesCache getFilesCache();
/**
* Get the cache strategy used
+ * @return the CacheStrategy.
*/
- public CacheStrategy getCacheStrategy();
+ CacheStrategy getCacheStrategy();
/**
* Get the file object decorator used
+ * @return the file object decorator Class.
*/
- public Class getFileObjectDecorator();
+ Class getFileObjectDecorator();
/**
* The constructor associated to the fileObjectDecorator.
* We cache it here for performance reasons.
+ * @return the Constructor associated with the FileObjectDecorator.
*/
- public Constructor getFileObjectDecoratorConst();
+ Constructor getFileObjectDecoratorConst();
/**
* The class to use to determine the content-type (mime-type)
+ * @return the FileContentInfoFactory.
*/
- public FileContentInfoFactory getFileContentInfoFactory();
+ FileContentInfoFactory getFileContentInfoFactory();
/**
- * Returns true if this manager has a provider for a particular scheme.
- */
- public boolean hasProvider(final String scheme);
+ * Returns true if this manager has a provider for a particular scheme.
+ * @param scheme The scheme for which a provider should be checked.
+ * @return true if a provider for the scheme is available.
+ */
+ boolean hasProvider(final String scheme);
/**
* Get the schemes currently available.
+ * @return An array of available scheme names that are supported.
*/
- public String[] getSchemes();
+ String[] getSchemes();
/**
* Get the capabilities for a given scheme.
*
+ * @param scheme The scheme to use to locate the provider's capabilities.
+ * @return A Collection of the various capabilities.
* @throws FileSystemException if the given scheme is not konwn
*/
- public Collection getProviderCapabilities(final String scheme) throws FileSystemException;
+ Collection getProviderCapabilities(final String scheme) throws FileSystemException;
/**
* Sets the logger to use.
+ * @param log The logger to use.
*/
- public void setLogger(final Log log);
+ void setLogger(final Log log);
/**
* Get the configuration builder for the given scheme
*
+ * @param scheme The schem to use to obtain the FileSystemConfigBuidler.
+ * @return A FileSystemConfigBuilder appropriate for the given scheme.
* @throws FileSystemException if the given scheme is not konwn
*/
- public FileSystemConfigBuilder getFileSystemConfigBuilder(final String scheme) throws FileSystemException;
+ FileSystemConfigBuilder getFileSystemConfigBuilder(final String scheme) throws FileSystemException;
/**
* Resolve the uri to a filename
*
+ * @param uri The uri to resolve.
+ * @return A FileName that matches the uri.
* @throws FileSystemException if this is not possible
*/
- public FileName resolveURI(String uri) throws FileSystemException;
+ FileName resolveURI(String uri) throws FileSystemException;
// -- OPERATIONS --
/**
@@ -296,20 +312,22 @@
* For example, for "file" scheme we can register SvnWsOperationProvider and
* CvsOperationProvider.
*
- * @param scheme
- * @param operationProvider
- * @throws FileSystemException
+ * @param scheme The scheme assoicated with this provider.
+ * @param operationProvider The FileOperationProvider to add.
+ * @throws FileSystemException if an error occurs.
*/
- public void addOperationProvider(final String scheme, final FileOperationProvider operationProvider) throws FileSystemException;
+ void addOperationProvider(final String scheme, final FileOperationProvider operationProvider)
+ throws FileSystemException;
/**
* @see FileSystemManager#addOperationProvider(String, org.apache.commons.vfs.operations.FileOperationProvider)
*
- * @param schemes
- * @param operationProvider
- * @throws FileSystemException
+ * @param schemes The schemes that will be associated with the provider.
+ * @param operationProvider The FileOperationProvider to add.
+ * @throws FileSystemException if an error occurs.
*/
- public void addOperationProvider(final String[] schemes, final FileOperationProvider operationProvider) throws FileSystemException;
+ void addOperationProvider(final String[] schemes, final FileOperationProvider operationProvider)
+ throws FileSystemException;
/**
@@ -318,7 +336,7 @@
* @return the registered FileOperationProviders for the specified scheme.
* If there were no providers registered for the scheme, it returns null.
*
- * @throws FileSystemException
+ * @throws FileSystemException if an error occurs.
*/
- public FileOperationProvider[] getOperationProviders(final String scheme) throws FileSystemException;
+ FileOperationProvider[] getOperationProviders(final String scheme) throws FileSystemException;
}
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemOptions.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemOptions.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemOptions.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileSystemOptions.java Mon Apr 13 04:06:01 2009
@@ -31,11 +31,21 @@
*/
public class FileSystemOptions
{
+ /** The options */
private Map options = new TreeMap();
- private class FileSystemOptionKey implements Comparable
+ /**
+ * Keys in the options Map.
+ */
+ private final class FileSystemOptionKey implements Comparable
{
+ /** Constant used to create hashcode */
+ private static final int HASH = 29;
+
+ /** The FileSystem class */
private final Class fileSystemClass;
+
+ /** The option name */
private final String name;
private FileSystemOptionKey(Class fileSystemClass, String name)
@@ -86,7 +96,7 @@
{
int result;
result = fileSystemClass.hashCode();
- result = 29 * result + name.hashCode();
+ result = HASH * result + name.hashCode();
return result;
}
}
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileType.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileType.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileType.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileType.java Mon Apr 13 04:06:01 2009
@@ -36,21 +36,28 @@
*/
public static final FileType FILE = new FileType("file", false, true, true);
- /**
- * A file or folder. May have data content and attributes, and can
- * contain other files.
- */
- public static final FileType FILE_OR_FOLDER = new FileType("fileOrFolder", true, true, true);
+ /**
+ * A file or folder. May have data content and attributes, and can
+ * contain other files.
+ */
+ public static final FileType FILE_OR_FOLDER = new FileType("fileOrFolder", true, true, true);
- /**
+ /**
* A file that does not exist. May not have data content, attributes,
* or contain other files.
*/
public static final FileType IMAGINARY = new FileType("imaginary", false, false, false);
+ /** The name of the FileType */
private final String name;
+
+ /** true if the FileType can have children */
private final boolean hasChildren;
+
+ /** true if the FileType can have content */
private final boolean hasContent;
+
+ /** true if the FileType has attributes */
private final boolean hasAttrs;
private FileType(final String name,
@@ -66,6 +73,7 @@
/**
* Returns the name of this type.
+ * @return The name of this type.
*/
public String toString()
{
@@ -74,6 +82,7 @@
/**
* Returns the name of this type.
+ * @return The name of the type.
*/
public String getName()
{
@@ -82,6 +91,7 @@
/**
* Returns true if files of this type may contain other files.
+ * @return tru if files can contain other files.
*/
public boolean hasChildren()
{
@@ -90,6 +100,7 @@
/**
* Returns true if files of this type may have data content.
+ * @return true if files can have content.
*/
public boolean hasContent()
{
@@ -98,6 +109,7 @@
/**
* Returns true if files of this type may have attributes.
+ * @return true if files can have attributes
*/
public boolean hasAttributes()
{
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileTypeHasNoContentException.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileTypeHasNoContentException.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileTypeHasNoContentException.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileTypeHasNoContentException.java Mon Apr 13 04:06:01 2009
@@ -17,7 +17,9 @@
package org.apache.commons.vfs;
/**
- * delivers a file-not-folder exception which happens when trying to issue {@link org.apache.commons.vfs.FileObject#getChildren()} on a file.
+ * delivers a file-not-folder exception which happens when trying to issue
+ * {@link org.apache.commons.vfs.FileObject#getChildren()} on a file.
+ * @author <a href="http://commons.apache.org/vfs/team-list.html">Commons VFS team</a>
*/
public class FileTypeHasNoContentException extends FileSystemException
{
@@ -30,4 +32,4 @@
{
super("vfs.provider/read-not-file.error", info0, throwable);
}
-}
\ No newline at end of file
+}
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileTypeSelector.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileTypeSelector.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileTypeSelector.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileTypeSelector.java Mon Apr 13 04:06:01 2009
@@ -25,6 +25,7 @@
public class FileTypeSelector
implements FileSelector
{
+ /** The FileType */
private final FileType type;
public FileTypeSelector(final FileType type)
@@ -34,15 +35,20 @@
/**
* Determines if a file or folder should be selected.
+ * @param fileInfo The file selection information.
+ * @return true if the file or folder should be selected.
+ * @throws FileSystemException if an error occurs
*/
public boolean includeFile(final FileSelectInfo fileInfo)
throws FileSystemException
{
- return (fileInfo.getFile().getType() == type);
+ return fileInfo.getFile().getType() == type;
}
/**
* Determines whether a folder should be traversed.
+ * @param fileInfo The file selection information.
+ * @return true if the file or folder should be traversed.
*/
public boolean traverseDescendents(final FileSelectInfo fileInfo)
{
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileUtil.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileUtil.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileUtil.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/FileUtil.java Mon Apr 13 04:06:01 2009
@@ -26,8 +26,12 @@
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
* @version $Revision$ $Date$
*/
-public class FileUtil
+public final class FileUtil
{
+
+ /** The buffer size */
+ private static final int BUFFER_SIZE = 1024;
+
private FileUtil()
{
}
@@ -36,6 +40,8 @@
* Returns the content of a file, as a byte array.
*
* @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.
*/
public static byte[] getContent(final FileObject file)
throws IOException
@@ -63,6 +69,9 @@
/**
* Writes the content of a file to an OutputStream.
+ * @param file The FileObject to write.
+ * @param outstr The OutputStream to write to.
+ * @throws IOException if an error occurs writing the file.
*/
public static void writeContent(final FileObject file,
final OutputStream outstr)
@@ -71,7 +80,7 @@
final InputStream instr = file.getContent().getInputStream();
try
{
- final byte[] buffer = new byte[1024];
+ final byte[] buffer = new byte[BUFFER_SIZE];
while (true)
{
final int nread = instr.read(buffer);
@@ -90,6 +99,9 @@
/**
* Copies the content from a source file to a destination file.
+ * @param srcFile The source FileObject.
+ * @param destFile The target FileObject
+ * @throws IOException If an error occurs copying the file.
*/
public static void copyContent(final FileObject srcFile,
final FileObject destFile)
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/NameScope.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/NameScope.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/NameScope.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/NameScope.java Mon Apr 13 04:06:01 2009
@@ -65,6 +65,7 @@
*/
public static final NameScope FILE_SYSTEM = new NameScope("filesystem");
+ /** The name */
private final String name;
private NameScope(final String name)
@@ -74,6 +75,7 @@
/**
* Returns the name of the scope.
+ * @return The name of the scope.
*/
public String toString()
{
@@ -82,6 +84,7 @@
/**
* Returns the name of the scope.
+ * @return The name of the scope.
*/
public String getName()
{
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/RandomAccessContent.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/RandomAccessContent.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/RandomAccessContent.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/RandomAccessContent.java Mon Apr 13 04:06:01 2009
@@ -36,7 +36,7 @@
* at which the next read or write occurs.
* @throws IOException if an I/O error occurs.
*/
- public long getFilePointer() throws IOException;
+ long getFilePointer() throws IOException;
/**
* Sets the file-pointer offset, measured from the beginning of this
@@ -46,7 +46,8 @@
* change only by writing after the offset has been set beyond the end
* of the file.
* <br/>
- * <b>Notice: If you use {@link #getInputStream()} you have to reget the InputStream after calling {@link #seek(long)}</b>
+ * <b>Notice: If you use {@link #getInputStream()} you have to reget the InputStream after
+ * calling {@link #seek(long)}</b>
*
* @param pos the offset position, measured in bytes from the
* beginning of the file, at which to set the file
@@ -54,7 +55,7 @@
* @throws IOException if <code>pos</code> is less than
* <code>0</code> or if an I/O error occurs.
*/
- public void seek(long pos) throws IOException;
+ void seek(long pos) throws IOException;
/**
* Returns the length of this file.
@@ -62,7 +63,7 @@
* @return the length of this file, measured in bytes.
* @throws IOException if an I/O error occurs.
*/
- public long length() throws IOException;
+ long length() throws IOException;
/**
* Closes this random access file stream and releases any system
@@ -75,12 +76,14 @@
*
* @throws IOException if an I/O error occurs.
*/
- public void close() throws IOException;
+ void close() throws IOException;
/**
* get the input stream
* <br/>
* <b>Notice: If you use {@link #seek(long)} you have to reget the InputStream</b>
+ * @return the InputStream.
+ * @throws IOException if an I/O error occurs.
*/
- public InputStream getInputStream() throws IOException;
+ InputStream getInputStream() throws IOException;
}
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/Selectors.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/Selectors.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/Selectors.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/Selectors.java Mon Apr 13 04:06:01 2009
@@ -22,44 +22,51 @@
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
* @version $Revision$ $Date$
*/
-public interface Selectors
+public final class Selectors
{
/**
* A {@link FileSelector} that selects only the base file/folder.
*/
- FileSelector SELECT_SELF = new FileDepthSelector(0, 0);
+ public static final FileSelector SELECT_SELF = new FileDepthSelector(0, 0);
/**
* A {@link FileSelector} that selects the base file/folder and its
* direct children.
*/
- FileSelector SELECT_SELF_AND_CHILDREN = new FileDepthSelector(0, 1);
+ public static final FileSelector SELECT_SELF_AND_CHILDREN = new FileDepthSelector(0, 1);
/**
* A {@link FileSelector} that selects only the direct children
* of the base folder.
*/
- FileSelector SELECT_CHILDREN = new FileDepthSelector(1, 1);
+ public static final FileSelector SELECT_CHILDREN = new FileDepthSelector(1, 1);
/**
* A {@link FileSelector} that selects all the descendents of the
* base folder, but does not select the base folder itself.
*/
- FileSelector EXCLUDE_SELF = new FileDepthSelector(1, Integer.MAX_VALUE);
+ public static final FileSelector EXCLUDE_SELF = new FileDepthSelector(1, Integer.MAX_VALUE);
/**
* A {@link FileSelector} that only files (not folders).
*/
- FileSelector SELECT_FILES = new FileTypeSelector(FileType.FILE);
+ public static final FileSelector SELECT_FILES = new FileTypeSelector(FileType.FILE);
/**
* A {@link FileSelector} that only folders (not files).
*/
- FileSelector SELECT_FOLDERS = new FileTypeSelector(FileType.FOLDER);
+ public static final FileSelector SELECT_FOLDERS = new FileTypeSelector(FileType.FOLDER);
/**
* A {@link FileSelector} that selects the base file/folder, plus all
* its descendents.
*/
- FileSelector SELECT_ALL = new AllFileSelector();
+ public static final FileSelector SELECT_ALL = new AllFileSelector();
+
+ /**
+ * Prevent the class from being instantiated.
+ */
+ private Selectors()
+ {
+ }
}
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/UserAuthenticationData.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/UserAuthenticationData.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/UserAuthenticationData.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/UserAuthenticationData.java Mon Apr 13 04:06:01 2009
@@ -22,94 +22,114 @@
/**
* Container for various authentication data
+ * @author <a href="http://commons.apache.org/vfs/team-list.html">Commons VFS team</a>
*/
public class UserAuthenticationData
{
- public static class Type implements Comparable
- {
- private final String type;
-
- public Type(String type)
- {
- this.type = type;
- }
-
- public boolean equals(Object o)
- {
- if (this == o)
- {
- return true;
- }
- if (o == null || getClass() != o.getClass())
- {
- return false;
- }
-
- Type type1 = (Type) o;
-
- if (type != null ? !type.equals(type1.type) : type1.type != null)
- {
- return false;
- }
-
- return true;
- }
-
- public int compareTo(Object o)
- {
- Type t = (Type) o;
-
- return type.compareTo(t.type);
- }
- }
-
- public static final Type USERNAME = new Type("username");
- public static final Type PASSWORD = new Type("password");
- public static final Type DOMAIN = new Type("domain");
-
- private Map authenticationData = new TreeMap();
-
- public UserAuthenticationData()
- {
- }
-
- /**
- * set a data to this collection
- */
- public void setData(Type type, char[] data)
- {
- authenticationData.put(type, data);
- }
-
- /**
- * get a data from the collection
- */
- public char[] getData(Type type)
- {
- return (char[]) authenticationData.get(type);
- }
-
- /**
- * deleted all data stored within this authenticator
- */
- public void cleanup()
- {
- // step 1: nullify character buffers
- Iterator iterAuthenticationData = authenticationData.values().iterator();
- while (iterAuthenticationData.hasNext())
- {
- char[] data = (char[]) iterAuthenticationData.next();
- if (data == null || data.length < 0)
- {
- continue;
- }
-
- for (int i = 0; i<data.length; i++)
- {
- data[i]=0;
- }
- }
- // step 2: allow data itself to gc
- authenticationData.clear();
- }
+ /**
+ * Inner class to represent portions of the user authentication data.
+ */
+ public static class Type implements Comparable
+ {
+ /** The type name */
+ private final String type;
+
+ public Type(String type)
+ {
+ this.type = type;
+ }
+
+ public boolean equals(Object o)
+ {
+ if (this == o)
+ {
+ return true;
+ }
+ if (o == null || getClass() != o.getClass())
+ {
+ return false;
+ }
+
+ Type type1 = (Type) o;
+
+ if (type != null ? !type.equals(type1.type) : type1.type != null)
+ {
+ return false;
+ }
+
+ return true;
+ }
+
+ public int compareTo(Object o)
+ {
+ Type t = (Type) o;
+
+ return type.compareTo(t.type);
+ }
+
+ public int hashCode()
+ {
+ return type != null ? type.hashCode() : 0;
+ }
+ }
+
+ /** The user name */
+ public static final Type USERNAME = new Type("username");
+
+ /** The password */
+ public static final Type PASSWORD = new Type("password");
+
+ /** The user's domain */
+ public static final Type DOMAIN = new Type("domain");
+
+ /** The authentication data */
+ private Map authenticationData = new TreeMap();
+
+ public UserAuthenticationData()
+ {
+ }
+
+ /**
+ * set a data to this collection
+ * @param type The Type to add
+ * @param data The data assoicated with the Type
+ */
+ public void setData(Type type, char[] data)
+ {
+ authenticationData.put(type, data);
+ }
+
+ /**
+ * get a data from the collection
+ * @param type The Type to retrieve.
+ * @return a character array containing the data assoicated with the type.
+ */
+ public char[] getData(Type type)
+ {
+ return (char[]) authenticationData.get(type);
+ }
+
+ /**
+ * deleted all data stored within this authenticator
+ */
+ public void cleanup()
+ {
+ // step 1: nullify character buffers
+ Iterator iterAuthenticationData = authenticationData.values().iterator();
+ while (iterAuthenticationData.hasNext())
+ {
+ char[] data = (char[]) iterAuthenticationData.next();
+ if (data == null || data.length < 0)
+ {
+ continue;
+ }
+
+ for (int i = 0; i < data.length; i++)
+ {
+ data[i] = 0;
+ }
+ }
+ // step 2: allow data itself to gc
+ authenticationData.clear();
+ }
}
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/UserAuthenticator.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/UserAuthenticator.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/UserAuthenticator.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/UserAuthenticator.java Mon Apr 13 04:06:01 2009
@@ -18,11 +18,14 @@
/**
* The user authenticator is used to query credentials from the user
+ * @author <a href="http://commons.apache.org/vfs/team-list.html">Commons VFS team</a>
*/
public interface UserAuthenticator
{
- /**
- * queries the given type from the user
- */
- public UserAuthenticationData requestAuthentication(UserAuthenticationData.Type[] types);
+ /**
+ * queries the given type from the user
+ * @param types An array containing the user's credentials
+ * @return The UserAuthenticationData.
+ */
+ UserAuthenticationData requestAuthentication(UserAuthenticationData.Type[] types);
}
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/VFS.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/VFS.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/VFS.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/VFS.java Mon Apr 13 04:06:01 2009
@@ -26,10 +26,12 @@
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
* @version $Revision$ $Date$
*/
-public class VFS
+public final class VFS
{
- private static Boolean URI_STYLE = null;
+ /** The URI style */
+ private static Boolean uriStyle;
+ /** The FileSystemManager */
private static FileSystemManager instance;
private VFS()
@@ -38,6 +40,8 @@
/**
* Returns the default {@link FileSystemManager} instance
+ * @return The FileSystemManager.
+ * @throws FileSystemException if an error occurs creating the manager.
*/
public static synchronized FileSystemManager getManager()
throws FileSystemException
@@ -51,6 +55,9 @@
/**
* Creates a file system manager instance.
+ * @param managerClassName The specific manager impelmentation class name.
+ * @return The FileSystemManager.
+ * @throws FileSystemException if an error occurs creating the manager.
*/
private static FileSystemManager createManager(final String managerClassName)
throws FileSystemException
@@ -104,19 +111,19 @@
public static boolean isUriStyle()
{
- if (URI_STYLE == null)
+ if (uriStyle == null)
{
- URI_STYLE = Boolean.FALSE;
+ uriStyle = Boolean.FALSE;
}
- return URI_STYLE.booleanValue();
+ return uriStyle.booleanValue();
}
public static void setUriStyle(boolean uriStyle)
{
- if (URI_STYLE != null && URI_STYLE.booleanValue() != uriStyle)
+ if (VFS.uriStyle != null && VFS.uriStyle.booleanValue() != uriStyle)
{
throw new IllegalStateException("URI STYLE ALREADY SET TO");
}
- URI_STYLE = uriStyle ? Boolean.TRUE : Boolean.FALSE;
+ VFS.uriStyle = uriStyle ? Boolean.TRUE : Boolean.FALSE;
}
}
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/VfsLog.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/VfsLog.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/VfsLog.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/VfsLog.java Mon Apr 13 04:06:01 2009
@@ -26,7 +26,7 @@
* @author <a href="mailto:imario@apache.org">Mario Ivankovits</a>
* @version $Revision$ $Date$
*/
-public class VfsLog
+public final class VfsLog
{
// static utility class
private VfsLog()
@@ -35,6 +35,10 @@
/**
* warning
+ * @param vfslog The base component Logger to use.
+ * @param commonslog The class specific Logger
+ * @param message The message to log.
+ * @param t The exception, if any.
*/
public static void warn(Log vfslog, Log commonslog, String message, Throwable t)
{
@@ -50,6 +54,9 @@
/**
* warning
+ * @param vfslog The base component Logger to use.
+ * @param commonslog The class specific Logger
+ * @param message The message to log.
*/
public static void warn(Log vfslog, Log commonslog, String message)
{
@@ -65,6 +72,9 @@
/**
* debug
+ * @param vfslog The base component Logger to use.
+ * @param commonslog The class specific Logger
+ * @param message The message to log.
*/
public static void debug(Log vfslog, Log commonslog, String message)
{
@@ -80,6 +90,10 @@
/**
* debug
+ * @param vfslog The base component Logger to use.
+ * @param commonslog The class specific Logger
+ * @param message The message to log.
+ * @param t The exception, if any.
*/
public static void debug(Log vfslog, Log commonslog, String message, Throwable t)
{
@@ -95,6 +109,10 @@
/**
* info
+ * @param vfslog The base component Logger to use.
+ * @param commonslog The class specific Logger
+ * @param message The message to log.
+ * @param t The exception, if any.
*/
public static void info(Log vfslog, Log commonslog, String message, Throwable t)
{
@@ -110,6 +128,9 @@
/**
* info
+ * @param vfslog The base component Logger to use.
+ * @param commonslog The class specific Logger
+ * @param message The message to log.
*/
public static void info(Log vfslog, Log commonslog, String message)
{
@@ -125,6 +146,10 @@
/**
* error
+ * @param vfslog The base component Logger to use.
+ * @param commonslog The class specific Logger
+ * @param message The message to log.
+ * @param t The exception, if any.
*/
public static void error(Log vfslog, Log commonslog, String message, Throwable t)
{
@@ -140,6 +165,9 @@
/**
* error
+ * @param vfslog The base component Logger to use.
+ * @param commonslog The class specific Logger
+ * @param message The message to log.
*/
public static void error(Log vfslog, Log commonslog, String message)
{
@@ -155,6 +183,10 @@
/**
* fatal
+ * @param vfslog The base component Logger to use.
+ * @param commonslog The class specific Logger
+ * @param message The message to log.
+ * @param t The exception, if any.
*/
public static void fatal(Log vfslog, Log commonslog, String message, Throwable t)
{
@@ -170,6 +202,9 @@
/**
* fatal
+ * @param vfslog The base component Logger to use.
+ * @param commonslog The class specific Logger
+ * @param message The message to log.
*/
public static void fatal(Log vfslog, Log commonslog, String message)
{
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/auth/StaticUserAuthenticator.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/auth/StaticUserAuthenticator.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/auth/StaticUserAuthenticator.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/auth/StaticUserAuthenticator.java Mon Apr 13 04:06:01 2009
@@ -22,26 +22,32 @@
/**
* provides always the same credential data passed in with the constructor.
+ * @author <a href="http://commons.apache.org/vfs/team-list.html">Commons VFS team</a>
*/
public class StaticUserAuthenticator implements UserAuthenticator
{
- private final String username;
- private final String password;
- private final String domain;
+ /** The user name */
+ private final String username;
- public StaticUserAuthenticator(String domain, String username, String password)
- {
- this.username = username;
- this.password = password;
- this.domain = domain;
- }
+ /** The password */
+ private final String password;
- public UserAuthenticationData requestAuthentication(UserAuthenticationData.Type[] types)
- {
- UserAuthenticationData data = new UserAuthenticationData();
- data.setData(UserAuthenticationData.DOMAIN, UserAuthenticatorUtils.toChar(domain));
- data.setData(UserAuthenticationData.USERNAME, UserAuthenticatorUtils.toChar(username));
- data.setData(UserAuthenticationData.PASSWORD, UserAuthenticatorUtils.toChar(password));
- return data;
- }
+ /** The user's domain */
+ private final String domain;
+
+ public StaticUserAuthenticator(String domain, String username, String password)
+ {
+ this.username = username;
+ this.password = password;
+ this.domain = domain;
+ }
+
+ public UserAuthenticationData requestAuthentication(UserAuthenticationData.Type[] types)
+ {
+ UserAuthenticationData data = new UserAuthenticationData();
+ data.setData(UserAuthenticationData.DOMAIN, UserAuthenticatorUtils.toChar(domain));
+ data.setData(UserAuthenticationData.USERNAME, UserAuthenticatorUtils.toChar(username));
+ data.setData(UserAuthenticationData.PASSWORD, UserAuthenticatorUtils.toChar(password));
+ return data;
+ }
}
Added: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/auth/package.html
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/auth/package.html?rev=764356&view=auto
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/auth/package.html (added)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/auth/package.html Mon Apr 13 04:06:01 2009
@@ -0,0 +1,19 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<body>
+<p>VFS Authentication implementation</p>
+</body>
Propchange: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/auth/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/auth/package.html
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/auth/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/AbstractFilesCache.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/AbstractFilesCache.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/AbstractFilesCache.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/AbstractFilesCache.java Mon Apr 13 04:06:01 2009
@@ -21,7 +21,7 @@
/**
* Description
- *
+ *
* @author <a href="mailto:imario@apache.org">Mario Ivankovits</a>
* @version $Revision$ $Date$
*/
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/DefaultFilesCache.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/DefaultFilesCache.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/DefaultFilesCache.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/DefaultFilesCache.java Mon Apr 13 04:06:01 2009
@@ -25,13 +25,16 @@
/**
* A {@link org.apache.commons.vfs.FilesCache} implementation.<br>
- * This implementation caches every file for the complete lifetime of the used {@link org.apache.commons.vfs.FileSystemManager}.
+ * This implementation caches every file for the complete lifetime of the used
+ * {@link org.apache.commons.vfs.FileSystemManager}.
*
* @author <a href="mailto:imario@apache.org">Mario Ivankovits</a>
* @version $Revision$ $Date$
*/
public class DefaultFilesCache extends AbstractFilesCache
{
+
+ /** The FileSystem cache */
private final Map filesystemCache = new HashMap(10);
public void putFile(final FileObject file)
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/FileSystemAndNameKey.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/FileSystemAndNameKey.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/FileSystemAndNameKey.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/FileSystemAndNameKey.java Mon Apr 13 04:06:01 2009
@@ -28,8 +28,13 @@
*/
class FileSystemAndNameKey implements Comparable
{
+ /** The FileSystem */
private final FileSystem fileSystem;
+
+ /** The FileName */
private final FileName fileName;
+
+ /** hashcode to identify this object */
private final int fileSystemId;
FileSystemAndNameKey(final FileSystem fileSystem, final FileName fileName)
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/LRUFilesCache.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/LRUFilesCache.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/LRUFilesCache.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/LRUFilesCache.java Mon Apr 13 04:06:01 2009
@@ -39,17 +39,26 @@
*/
public class LRUFilesCache extends AbstractFilesCache
{
+ /** The default LRU size */
+ private static final int DEFAULT_LRU_SIZE = 100;
/**
* The logger to use.
*/
private Log log = LogFactory.getLog(LRUFilesCache.class);
+ /** The FileSystem cache */
private final Map filesystemCache = new HashMap(10);
+
+ /** The size of the cache */
private final int lruSize;
+ /**
+ * The file cache
+ */
private class MyLRUMap extends LRUMap
{
- final FileSystem filesystem;
+ /** The FileSystem */
+ private final FileSystem filesystem;
public MyLRUMap(final FileSystem filesystem, int size)
{
@@ -61,14 +70,16 @@
{
synchronized (LRUFilesCache.this)
{
- FileObject file = (FileObject) linkEntry.getValue();
-
+ FileObject file = (FileObject) linkEntry.getValue();
+
// System.err.println(">>> " + size() + " check removeLRU:" + linkEntry.getKey().toString());
if (file.isAttached() || file.isContentOpen())
{
// do not allow open or attached files to be removed
- // System.err.println(">>> " + size() + " VETO removeLRU:" + linkEntry.getKey().toString() + " (" + file.isAttached() + "/" + file.isContentOpen() + ")");
+ // System.err.println(">>> " + size() + " VETO removeLRU:" +
+ // linkEntry.getKey().toString() + " (" + file.isAttached() + "/" +
+ // file.isContentOpen() + ")");
return false;
}
@@ -104,7 +115,7 @@
*/
public LRUFilesCache()
{
- this(100);
+ this(DEFAULT_LRU_SIZE);
}
/**
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/NullFilesCache.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/NullFilesCache.java?rev=764356&r1=764355&r2=764356&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/NullFilesCache.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs/cache/NullFilesCache.java Mon Apr 13 04:06:01 2009
@@ -26,7 +26,8 @@
* This implementation never ever caches a single file.
* </p>
* <p/>
- * <b>Notice: if you use resolveFile(uri) multiple times with the same path, the system will always create a new instance.
+ * <b>Notice: if you use resolveFile(uri) multiple times with the same path, the system will always
+ * create a new instance.
* Changes on one instance of this file are not seen by the others.</b>
* </p>
*