Beautified JavaDoc for file index, adjusted parameters names to make them correct...
authorAlexandr Evstigneev <Alexandr.Evstigneev@jetbrains.com>
Thu, 29 Dec 2016 11:16:38 +0000 (14:16 +0300)
committerAlexandr Evstigneev <Alexandr.Evstigneev@jetbrains.com>
Thu, 29 Dec 2016 11:16:38 +0000 (14:16 +0300)
platform/projectModel-api/src/com/intellij/openapi/roots/FileIndex.java
platform/projectModel-impl/src/com/intellij/openapi/roots/impl/FileIndexBase.java
platform/projectModel-impl/src/com/intellij/openapi/roots/impl/ModuleFileIndexImpl.java
platform/projectModel-impl/src/com/intellij/openapi/roots/impl/ProjectFileIndexImpl.java

index 5a177b8ccc72fa8bb8da4aeb2889415fd60aec7a..3346983c6dbdcaad8e21eb4e402e1aceb61e9cb8 100644 (file)
@@ -31,33 +31,26 @@ import java.util.Set;
  */
 public interface FileIndex {
   /**
-   * Iterates all files and directories under content roots skipping excluded and ignored files and directories.
+   * Processes all files and directories under content roots skipping excluded and ignored files and directories.
    *
-   * @param iterator the iterator receiving the files.
    * @return false if files processing was stopped ({@link ContentIterator#processFile(VirtualFile)} returned false)
    */
-  boolean iterateContent(@NotNull ContentIterator iterator);
+  boolean iterateContent(@NotNull ContentIterator processor);
 
   /**
-   * Iterates all files and directories in the content under directory <code>dir</code> (including the directory itself) skipping excluded
-   * and ignored files and directories. Does not iterate anything if <code>dir</code> is not in the content.
+   * Processes all files and directories in the content under directory <code>dir</code> (including the directory itself) skipping excluded
+   * and ignored files and directories. Does nothing if <code>dir</code> is not in the content.
    *
-   * @param dir      the directory the contents of which is iterated.
-   * @param iterator the iterator receiving the files.
    * @return false if files processing was stopped ({@link ContentIterator#processFile(VirtualFile)} returned false)
    */
-  boolean iterateContentUnderDirectory(@NotNull VirtualFile dir, @NotNull ContentIterator iterator);
+  boolean iterateContentUnderDirectory(@NotNull VirtualFile dir, @NotNull ContentIterator processor);
 
   /**
-   * Same as {@link #iterateContentUnderDirectory(VirtualFile, ContentIterator)} but allows to pass additional custom filter to the processor
-   *
-   * @param dir          the directory the contents of which is iterated.
-   * @param iterator     the iterator receiving the files.
-   * @param customFilter custom filter for files and directories
-   * @return false if files processing was stopped ({@link ContentIterator#processFile(VirtualFile)} returned false)
+   * Same as {@link #iterateContentUnderDirectory(VirtualFile, ContentIterator)} but allows to pass additional <code>customFilter</code> to
+   * the iterator, in case you need to skip some file system branches using your own logic.
    */
   boolean iterateContentUnderDirectory(@NotNull VirtualFile dir,
-                                       @NotNull ContentIterator iterator,
+                                       @NotNull ContentIterator processor,
                                        @NotNull VirtualFileFilter customFilter);
 
   /**
@@ -67,13 +60,10 @@ public interface FileIndex {
   boolean isInContent(@NotNull VirtualFile fileOrDir);
 
   /**
-   * Returns {@code true} if {@code fileOrDir} is a file located under a sources, tests or resources root and not excluded or ignored.
+   * Returns {@code true} if {@code file} is a file located under a sources, tests or resources root and not excluded or ignored.
    * <p/>
    * Note that sometimes a file can belong to the content and be a source file but not belong to sources of the content.
    * This happens if sources of some library are located under the content (so they belong to the project content but not as sources).
-   *
-   * @param file the file to check.
-   * @return true if the file is a source file in the content sources, false otherwise.
    */
   boolean isContentSourceFile(@NotNull VirtualFile file);
 
@@ -91,8 +81,6 @@ public interface FileIndex {
    * you'd better use {@link TestSourcesFilter#isTestSources(VirtualFile, Project)} instead
    * which includes {@link ProjectFileIndex#isInTestSourceContent(VirtualFile)} invocation.
    *
-   * @param fileOrDir the file or directory to check.
-   * @return true if the file or directory belongs to a test source root, false otherwise.
    * @see TestSourcesFilter#isTestSources(VirtualFile, Project)
    */
   boolean isInTestSourceContent(@NotNull VirtualFile fileOrDir);
index 7432905427914368e6e89781cb7491fc0e0efea0..9e5c1650f6aa2f2bbacf738d63316a901a5463c7 100644 (file)
@@ -35,14 +35,14 @@ public abstract class FileIndexBase implements FileIndex {
 
   @Override
   public boolean iterateContentUnderDirectory(@NotNull VirtualFile dir,
-                                              @NotNull ContentIterator iterator,
+                                              @NotNull ContentIterator processor,
                                               @NotNull VirtualFileFilter customFilter) {
-    return iterateContentUnderDirectoryWithFilter(dir, iterator, file -> myContentFilter.accept(file) && customFilter.accept(file));
+    return iterateContentUnderDirectoryWithFilter(dir, processor, file -> myContentFilter.accept(file) && customFilter.accept(file));
   }
 
   @Override
-  public boolean iterateContentUnderDirectory(@NotNull VirtualFile dir, @NotNull ContentIterator iterator) {
-    return iterateContentUnderDirectoryWithFilter(dir, iterator, myContentFilter);
+  public boolean iterateContentUnderDirectory(@NotNull VirtualFile dir, @NotNull ContentIterator processor) {
+    return iterateContentUnderDirectoryWithFilter(dir, processor, myContentFilter);
   }
 
   private static boolean iterateContentUnderDirectoryWithFilter(@NotNull VirtualFile dir,
index 13ea0f1a669217dd7c0ea14d0f46d106fb37afee..5af7a65d81db6f62c291d0620502de77f5fa37ac 100644 (file)
@@ -43,7 +43,7 @@ public class ModuleFileIndexImpl extends FileIndexBase implements ModuleFileInde
   }
 
   @Override
-  public boolean iterateContent(@NotNull ContentIterator iterator) {
+  public boolean iterateContent(@NotNull ContentIterator processor) {
     final Set<VirtualFile> contentRoots = ApplicationManager.getApplication().runReadAction((Computable<Set<VirtualFile>>)() -> {
       if (myModule.isDisposed()) return Collections.emptySet();
 
@@ -66,7 +66,7 @@ public class ModuleFileIndexImpl extends FileIndexBase implements ModuleFileInde
       return result;
     });
     for (VirtualFile contentRoot : contentRoots) {
-      if (!iterateContentUnderDirectory(contentRoot, iterator)) {
+      if (!iterateContentUnderDirectory(contentRoot, processor)) {
         return false;
       }
     }
index 65ee994504d009be5692230e2e14be79a9323a70..771a7daa33eff4bb74f5f3e6ffa5e24d3eaea887 100644 (file)
@@ -48,12 +48,12 @@ public class ProjectFileIndexImpl extends FileIndexBase implements ProjectFileIn
   }
 
   @Override
-  public boolean iterateContent(@NotNull ContentIterator iterator) {
+  public boolean iterateContent(@NotNull ContentIterator processor) {
     Module[] modules =
       ApplicationManager.getApplication().runReadAction((Computable<Module[]>)() -> ModuleManager.getInstance(myProject).getModules());
     for (final Module module : modules) {
       for (VirtualFile contentRoot : getRootsToIterate(module)) {
-        if (!iterateContentUnderDirectory(contentRoot, iterator)) {
+        if (!iterateContentUnderDirectory(contentRoot, processor)) {
           return false;
         }
       }