changeset:   178439:d2caa2806387
tag:         tip
user:        Vladimir Voskresensky <vv159170@netbeans.org>
date:        Wed Sep 29 22:46:57 2010 +0400
summary:     fixed #190480 -  need for FileUtil.normalizePath

diff --git a/openide.filesystems/apichanges.xml b/openide.filesystems/apichanges.xml
--- a/openide.filesystems/apichanges.xml
+++ b/openide.filesystems/apichanges.xml
@@ -938,6 +938,26 @@
             <class package="org.openide.filesystems" name="FileUtil"/>
             <issue number="40410"/>
         </change>
+        <change id="FileUtil.normalizePath">
+            <api name="filesystems"/>
+            <summary>
+                <code>FileUtil.normalizePath</code> added
+            </summary>
+            <version major="7" minor="42"/>
+            <date day="30" month="9" year="2010"/>
+            <author login="vv159170"/>
+            <compatibility addition="yes" binary="compatible" source="compatible" semantic="compatible" deprecation="no" deletion="no" modification="no"/>
+            <description>
+                <p>
+                    The method 
+                    <code>FileUtil.normalizePath(String)</code> was added as a refinement of 
+                    <code>FileUtil.normalizeFile</code> that does not require String to File to String conversion
+                     on client side when intention is to convert unnormalized path to normalized path presentation. 
+                </p>
+            </description>
+            <class package="org.openide.filesystems" name="FileUtil"/>
+            <issue number="190480"/>
+        </change>        
         <change id="FileObject.setImportant">
             <api name="filesystems"/>
             <summary>
diff --git a/openide.filesystems/manifest.mf b/openide.filesystems/manifest.mf
--- a/openide.filesystems/manifest.mf
+++ b/openide.filesystems/manifest.mf
@@ -2,5 +2,5 @@
 OpenIDE-Module: org.openide.filesystems
 OpenIDE-Module-Localizing-Bundle: org/openide/filesystems/Bundle.properties
 OpenIDE-Module-Layer: org/openide/filesystems/resources/layer.xml
-OpenIDE-Module-Specification-Version: 7.41
+OpenIDE-Module-Specification-Version: 7.42
 
diff --git a/openide.filesystems/src/org/openide/filesystems/FileUtil.java b/openide.filesystems/src/org/openide/filesystems/FileUtil.java
--- a/openide.filesystems/src/org/openide/filesystems/FileUtil.java
+++ b/openide.filesystems/src/org/openide/filesystems/FileUtil.java
@@ -1661,6 +1661,23 @@
     }
 
     /**
+     * @see normalizeFile for details
+     * @param path file path to normalize
+     * @return normalized file path
+     * @since 7.42
+     */
+    public static String normalizePath(final String path) {
+        Map<String, String> normalizedPaths = getNormalizedFilesMap();
+        String normalized = normalizedPaths.get(path);
+        if (normalized == null) {
+            File ret = normalizeFileImpl(new File(path));
+            normalized = ret.getPath();
+            normalizedPaths.put(path, normalized);
+        }
+        return normalized;
+    }
+    
+    /**
      * Normalize a file path to a clean form.
      * This method may for example make sure that the returned file uses
      * the natural case on Windows; that old Windows 8.3 filenames are changed to the long form;
diff --git a/openide.filesystems/test/unit/src/org/openide/filesystems/FileUtilTest.java b/openide.filesystems/test/unit/src/org/openide/filesystems/FileUtilTest.java
--- a/openide.filesystems/test/unit/src/org/openide/filesystems/FileUtilTest.java
+++ b/openide.filesystems/test/unit/src/org/openide/filesystems/FileUtilTest.java
@@ -253,6 +253,44 @@
     /** Tests normalizeFile() method. */
     public void testNormalizeFile() throws IOException {
         // pairs of path before and after normalization
+        Map<String, String> paths = createNormalizedPaths();
+
+        for (String path : paths.keySet()) {
+            File file = new File(path);
+            assertTrue("Idempotency violated for path: " + path, FileUtil.normalizeFile(FileUtil.normalizeFile(file)).equals(FileUtil.normalizeFile(file)));
+            assertEquals("File not normalized: " + path, paths.get(path), FileUtil.normalizeFile(file).getPath());
+        }
+    }
+
+    public void testNormalizeFileIsCached() throws Exception {
+        File f = new File(getWorkDir(), "text.txt");
+        CharSequence log = Log.enable(FileUtil.class.getName(), Level.FINE);
+        File one = FileUtil.normalizeFile(f);
+        String msg = "FileUtil.normalizeFile for " + f;
+        if (log.toString().indexOf(msg) == -1) {
+            fail("One querfy for the file shall be in logs:\n" + log);
+        }
+        CharSequence log2 = Log.enable(FileUtil.class.getName(), Level.FINE);
+        File two = FileUtil.normalizeFile(f);
+        if (log2.toString().contains(msg)) {
+            fail("No second FileUtil.normalizeFile for in:\n" + log);
+        }
+        assertEquals("Files are equal", one, two);
+    }
+
+    /** Tests normalizePath() method. */
+    public void testNormalizePath() throws IOException {
+        // pairs of path before and after normalization
+        Map<String, String> paths = createNormalizedPaths();
+
+        for (String path : paths.keySet()) {
+            assertTrue("Idempotency violated for path: " + path, FileUtil.normalizePath(FileUtil.normalizePath(path)).equals(FileUtil.normalizePath(path)));
+            assertEquals("File path not normalized: " + path, paths.get(path), FileUtil.normalizePath(path));
+        }
+    }
+
+    private Map<String, String> createNormalizedPaths() throws IOException {
+        // pairs of path before and after normalization
         Map<String, String> paths = new HashMap<String, String>();
         if (Utilities.isWindows()) {
             paths.put("A:\\", "A:\\");
@@ -291,31 +329,26 @@
         // #137407 - java.io.File(".") should be normalized
         paths.put(".", new File(".").getCanonicalPath());
         paths.put("..", new File("..").getCanonicalPath());
-
-        for (String path : paths.keySet()) {
-            File file = new File(path);
-            assertTrue("Idempotency violated for path: " + path, FileUtil.normalizeFile(FileUtil.normalizeFile(file)).equals(FileUtil.normalizeFile(file)));
-            assertEquals("File not normalized: " + path, paths.get(path), FileUtil.normalizeFile(file).getPath());
-        }
+        return paths;
     }
-
-    public void testNormalizeFileIsCached() throws Exception {
-        File f = new File(getWorkDir(), "text.txt");
+    
+    public void testNormalizePathIsCached() throws Exception {
+        File f = new File(getWorkDir(), "textPath.txt");
+        String path = f.getPath();
         CharSequence log = Log.enable(FileUtil.class.getName(), Level.FINE);
-        File one = FileUtil.normalizeFile(f);
+        String one = FileUtil.normalizePath(path);
         String msg = "FileUtil.normalizeFile for " + f;
         if (log.toString().indexOf(msg) == -1) {
             fail("One querfy for the file shall be in logs:\n" + log);
         }
         CharSequence log2 = Log.enable(FileUtil.class.getName(), Level.FINE);
-        File two = FileUtil.normalizeFile(f);
+        String two = FileUtil.normalizePath(path);
         if (log2.toString().contains(msg)) {
             fail("No second FileUtil.normalizeFile for in:\n" + log);
         }
         assertEquals("Files are equal", one, two);
     }
 
-
     /** Tests that only resolvers are queried which supply at least one of
      * MIME types given in array in FileUtil.getMIMEType(fo, String[]).
      * See issue 137734.