[jboss-cvs] JBossAS SVN: r87394 - projects/vfs/trunk/src/main/java/org/jboss/virtual/plugins/vfs/helpers.

[jboss-cvs-commits at lists.jboss.org]

Author: david.lloyd at jboss.com
Date: 2009-04-15 18:16:22 -0400 (Wed, 15 Apr 2009)
New Revision: 87394

Modified:
   projects/vfs/trunk/src/main/java/org/jboss/virtual/plugins/vfs/helpers/PathTokenizer.java
Log:
javadocs

Modified: projects/vfs/trunk/src/main/java/org/jboss/virtual/plugins/vfs/helpers/PathTokenizer.java
===================================================================
--- projects/vfs/trunk/src/main/java/org/jboss/virtual/plugins/vfs/helpers/PathTokenizer.java	2009-04-15 22:12:41 UTC (rev 87393)
+++ projects/vfs/trunk/src/main/java/org/jboss/virtual/plugins/vfs/helpers/PathTokenizer.java	2009-04-15 22:16:22 UTC (rev 87394)
@@ -90,11 +90,13 @@
    private static final int STATE_MAYBE_REVERSE_PATH = 3;
 
    /**
-    * Get the tokens
+    * Get the tokens that comprise this path.
     * 
     * @param path the path
     * @return the tokens or null if the path is empty
-    * @throws IllegalArgumentException if the path is null, it is empty or it is a relative path
+    * @throws IllegalArgumentException if the path is null, or if this class is configured to reject
+    *    so-called "suspicious" tokens (files that start with "." which are not one of the two special
+    *    directories "." or "..")
     */
    public static List<String> getTokens(String path)
    {