commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject svn commit: r1585761 - in /commons/proper/vfs/trunk: core/src/main/java/org/apache/commons/vfs2/FileSystemOptions.java src/changes/changes.xml
Date Tue, 08 Apr 2014 15:40:57 GMT
Author: ggregory
Date: Tue Apr  8 15:40:57 2014
New Revision: 1585761

URL: http://svn.apache.org/r1585761
Log:
<action issue="VFS-518" dev="ggregory" type="update" due-to="Roland Illig">
  Documentation of FileSystemOptions should be more helpful.
</action>

Modified:
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystemOptions.java
    commons/proper/vfs/trunk/src/changes/changes.xml

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystemOptions.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystemOptions.java?rev=1585761&r1=1585760&r2=1585761&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystemOptions.java
(original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystemOptions.java
Tue Apr  8 15:40:57 2014
@@ -20,10 +20,15 @@ import java.util.Map;
 import java.util.TreeMap;
 
 /**
- * Container for FileSystemOptions.<br>
- * You have to use *FileSystemConfigBuilder.getInstance() to fill this container<br>
- * * = the filesystem provider short name
- *
+ * Configures file systems individually with these options.
+ * <p>
+ * To configure a file system, you set properties on a {@link FileSystemOptions} object.
Most file systems provide a
+ * {@link FileSystemConfigBuilder} with specific options for that file system.
+ * <p>
+ * To use the options, pass them to {@link FileSystemManager#resolveFile(String,FileSystemOptions)}.
From there, the
+ * options apply to all files that are resolved relative to that file.
+ * </p>
+ * 
  * @see org.apache.commons.vfs2.provider.sftp.SftpFileSystemConfigBuilder
  * @see org.apache.commons.vfs2.provider.ftp.FtpFileSystemConfigBuilder
  * @see org.apache.commons.vfs2.provider.ftps.FtpsFileSystemConfigBuilder

Modified: commons/proper/vfs/trunk/src/changes/changes.xml
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/src/changes/changes.xml?rev=1585761&r1=1585760&r2=1585761&view=diff
==============================================================================
--- commons/proper/vfs/trunk/src/changes/changes.xml (original)
+++ commons/proper/vfs/trunk/src/changes/changes.xml Tue Apr  8 15:40:57 2014
@@ -26,6 +26,9 @@
 <!--       <action issue="VFS-443" dev="ggregory" type="update" due-to="nickallen">
-->
 <!--     	[Local] Need an easy way to convert from a FileObject to a File. -->
 <!--       </action> -->
+      <action issue="VFS-518" dev="ggregory" type="update" due-to="Roland Illig">
+        Documentation of FileSystemOptions should be more helpful.
+      </action>
       <action issue="VFS-500" dev="ggregory" type="update" due-to="Bernd Eckenfels">
         VFSClassLoader.findResources missing.
       </action>



Mime
View raw message