Author: imario
Date: Wed Mar 30 15:20:34 2005
New Revision: 159541
URL: http://svn.apache.org/viewcvs?view=rev&rev=159541
Log:
document /META-INF/vfs-providers.xml
Modified:
jakarta/commons/sandbox/vfs/trunk/xdocs/api.xml
jakarta/commons/sandbox/vfs/trunk/xdocs/index.xml
Modified: jakarta/commons/sandbox/vfs/trunk/xdocs/api.xml
URL:
http://svn.apache.org/viewcvs/jakarta/commons/sandbox/vfs/trunk/xdocs/api.xml?view=diff&r1=159540&r2=159541
==============================================================================
--- jakarta/commons/sandbox/vfs/trunk/xdocs/api.xml (original)
+++ jakarta/commons/sandbox/vfs/trunk/xdocs/api.xml Wed Mar 30 15:20:34 2005
@@ -62,24 +62,9 @@
<subsection name="Cache">
<p>
- By default every resolved file will be cached in an map
and - unhappily - it will never be released.
- This is what
- <a
href="apidocs/org/apache/commons/vfs/cache/SoftRefFilesCache.html">SoftRefFilesCache</a>
- tries to address.
+ Commons VFS uses a <a
href="apidocs/org/apache/commons/vfs/cache/SoftRefFilesCache.html">SoftRefFilesCache</a>
to release memory if a file is no longer used by the application.
</p>
<p>
- Currently you could not use VFS.getManager() to use this
sort of cache, instead you have to create
- your own FileSytemManager instance.
- </p>
- <source><![CDATA[
-private static FileSystemManager manager;
-
-manager = new StandardFileSystemManager();
-manager.setFilesCache(new SoftRefFilesCache());
-manager.init();
- ]]></source>
-
- <p>
This cache will return the same instance for a file as
long as it is "strongly reachable" e.g. you
hold a reference to this object. If the FileObject is no
longer reachable, and the jvm needs some memory,
it will be released.
@@ -109,6 +94,15 @@
<a
href="apidocs/org/apache/commons/vfs/VFS.html#getManager()">VFS.getManager()</a>
method, which returns the default Commons VFS implementation.
</p>
+ <p>
+ This method will also automatically scan the classpath for a
/META-INF/vfs-providers.xml file
+ (also in jar files).
+ If such a file is found Commons VFS uses it in <u>addition</u>
to the default providers.xml.
+ This allows you to start using a new filesystem by simply drop
its implementation into the classpath.
+ The configuration file format is described below.<br />
+ <b>Notice:</b> Currently it is not allowed to override a
already configured filesystem. Commons VFS throws
+ an exception if there is already a filesystem for a scheme.
+ </p>
<p>
To configure Commons VFS programatically, you can create an
@@ -178,16 +172,6 @@
<code>setConfiguration()</code> method to set the
location of the configuration file to use. The configuration
file format is described below.
- </p>
-
- <p>
- The fourth method is in addition to the default providers.xml.
- This method automatically scans the classpath for a
/META-INF/vfs-providers.xml file (even if it is within an jar).
- If such a file is found Commons VFS uses it in addition to the
default.
- This allows you to start using a new filesystem by simply drop
its implementation into the classpath.
- The configuration file format is described below.<br />
- <b>Notice:</b> Currently it is not allowed to override a
already configured filesystem. Commons VFS throws
- an exception if there is already a filesystem for a scheme.
</p>
<p>
Modified: jakarta/commons/sandbox/vfs/trunk/xdocs/index.xml
URL:
http://svn.apache.org/viewcvs/jakarta/commons/sandbox/vfs/trunk/xdocs/index.xml?view=diff&r1=159540&r2=159541
==============================================================================
--- jakarta/commons/sandbox/vfs/trunk/xdocs/index.xml (original)
+++ jakarta/commons/sandbox/vfs/trunk/xdocs/index.xml Wed Mar 30 15:20:34 2005
@@ -47,7 +47,7 @@
</section>
<section name="News">
- <p>2005-03 - [EMAIL PROTECTED]: easier configuration for
plugins</p>
+ <p>2005-03 - [EMAIL PROTECTED]: easier configuration for plugins -
see api section for details</p>
<p>2005-03 - [EMAIL PROTECTED]: The filename parsing and api has
changed.
<ul>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
