Refactoring of callers of DefaultPsiElementFinderImpl.processPackageDirectories.

java-language-api/src/main/java/com/intellij/java/language/psi/PsiElementFinder.java

@@ -15,9 +15,9 @@
  */
 package com.intellij.java.language.psi;
 
+import consulo.annotation.access.RequiredReadAction;
 import consulo.annotation.component.ComponentScope;
 import consulo.annotation.component.ExtensionAPI;
-import consulo.application.util.function.Processor;
 import consulo.component.extension.ExtensionPointName;
 import consulo.language.psi.PsiDirectory;
 import consulo.language.psi.PsiFile;
@@ -38,175 +38,185 @@
  */
 @ExtensionAPI(ComponentScope.PROJECT)
 public abstract class PsiElementFinder {
-  public static final ExtensionPointName<PsiElementFinder> EP_NAME = ExtensionPointName.create(PsiElementFinder.class);
-
-  /**
-   * Searches the specified scope within the project for a class with the specified full-qualified
-   * name and returns one if it is found.
-   *
-   * @param qualifiedName the full-qualified name of the class to find.
-   * @param scope         the scope to search.
-   * @return the PSI class, or null if no class with such name is found.
-   * @see JavaPsiFacade#findClass(String, GlobalSearchScope)
-   */
-  @Nullable
-  public abstract PsiClass findClass(@Nonnull String qualifiedName, @Nonnull GlobalSearchScope scope);
-
-  /**
-   * Searches the specified scope within the project for classes with the specified full-qualified
-   * name and returns all found classes.
-   *
-   * @param qualifiedName the full-qualified name of the class to find.
-   * @param scope         the scope to search.
-   * @return the array of found classes, or an empty array if no classes are found.
-   * @see JavaPsiFacade#findClasses(String, GlobalSearchScope)
-   */
-  @Nonnull
-  public abstract PsiClass[] findClasses(@Nonnull String qualifiedName, @Nonnull GlobalSearchScope scope);
-
-  /**
-   * Searches the project for the package with the specified full-qualified name and returns one
-   * if it is found.
-   *
-   * @param qualifiedName the full-qualified name of the package to find.
-   * @return the PSI package, or null if no package with such name is found.
-   * @see JavaPsiFacade#findPackage(String)
-   */
-  @Nullable
-  public PsiJavaPackage findPackage(@Nonnull String qualifiedName) {
-    return null;
-  }
-
-  /**
-   * Search java module for file. Can be automatic module or explicit declaration from java file
-   */
-  @Nullable
-  public PsiJavaModule findModule(@Nonnull VirtualFile file) {
-    return null;
-  }
-
-  @Nonnull
-  public Collection<PsiJavaModule> findModules(@Nonnull String moduleName, @Nonnull GlobalSearchScope scope) {
-    return List.of();
-  }
-
-  /**
-   * Returns the list of subpackages of the specified package in the specified search scope.
-   *
-   * @param psiPackage the package to return the list of subpackages for.
-   * @param scope      the scope in which subpackages are searched.
-   * @return the list of subpackages.
-   * @see PsiJavaPackage#getSubPackages(GlobalSearchScope)
-   */
-  @Nonnull
-  public PsiJavaPackage[] getSubPackages(@Nonnull PsiJavaPackage psiPackage, @Nonnull GlobalSearchScope scope) {
-    return PsiJavaPackage.EMPTY_ARRAY;
-  }
-
-  /**
-   * Returns a array of files belonging to the specified package which are not located in any of the package directories.
-   *
-   * @param psiPackage the package to return the list of files for.
-   * @param scope      the scope in which files are searched.
-   * @return the array of files.
-   */
-  @Nonnull
-  public PsiFile[] getPackageFiles(@Nonnull PsiJavaPackage psiPackage, @Nonnull GlobalSearchScope scope) {
-    return PsiFile.EMPTY_ARRAY;
-  }
-
-  /**
-   * Returns the filter to use for filtering the list of files in the directories belonging to a package to exclude files
-   * that actually belong to a different package. (For example, in Kotlin the package of a file is determined by its
-   * package statement and not by its location in the directory structure, so the files which have a differring package
-   * statement need to be excluded.)
-   *
-   * @param psiPackage the package for which the list of files is requested.
-   * @param scope      the scope in which children are requested.
-   * @return the filter to use, or null if no additional filtering is necessary.
-   */
-  @Nullable
-  public Predicate<PsiFile> getPackageFilesFilter(@Nonnull PsiJavaPackage psiPackage, @Nonnull GlobalSearchScope scope) {
-    return null;
-  }
-
-  /**
-   * Returns the list of classes in the specified package and in the specified search scope.
-   *
-   * @param psiPackage the package to return the list of classes in.
-   * @param scope      the scope in which classes are searched.
-   * @return the list of classes.
-   * @see PsiJavaPackage#getClasses(GlobalSearchScope)
-   */
-  @Nonnull
-  public PsiClass[] getClasses(@Nonnull PsiJavaPackage psiPackage, @Nonnull GlobalSearchScope scope) {
-    return PsiClass.EMPTY_ARRAY;
-  }
-
-  /**
-   * A method to optimize resolve (to only search classes in a package which might be there)
-   */
-  @Nonnull
-  public Set<String> getClassNames(@Nonnull PsiJavaPackage psiPackage, @Nonnull GlobalSearchScope scope) {
-    return getClassNames(getClasses(psiPackage, scope));
-  }
-
-  @Nonnull
-  protected static Set<String> getClassNames(@Nonnull PsiClass[] classes) {
-    if (classes.length == 0) {
-      return Collections.emptySet();
+    public static final ExtensionPointName<PsiElementFinder> EP_NAME = ExtensionPointName.create(PsiElementFinder.class);
+
+    /**
+     * Searches the specified scope within the project for a class with the specified full-qualified
+     * name and returns one if it is found.
+     *
+     * @param qualifiedName the full-qualified name of the class to find.
+     * @param scope         the scope to search.
+     * @return the PSI class, or null if no class with such name is found.
+     * @see JavaPsiFacade#findClass(String, GlobalSearchScope)
+     */
+    @Nullable
+    public abstract PsiClass findClass(@Nonnull String qualifiedName, @Nonnull GlobalSearchScope scope);
+
+    /**
+     * Searches the specified scope within the project for classes with the specified full-qualified
+     * name and returns all found classes.
+     *
+     * @param qualifiedName the full-qualified name of the class to find.
+     * @param scope         the scope to search.
+     * @return the array of found classes, or an empty array if no classes are found.
+     * @see JavaPsiFacade#findClasses(String, GlobalSearchScope)
+     */
+    @Nonnull
+    public abstract PsiClass[] findClasses(@Nonnull String qualifiedName, @Nonnull GlobalSearchScope scope);
+
+    /**
+     * Searches the project for the package with the specified full-qualified name and returns one
+     * if it is found.
+     *
+     * @param qualifiedName the full-qualified name of the package to find.
+     * @return the PSI package, or null if no package with such name is found.
+     * @see JavaPsiFacade#findPackage(String)
+     */
+    @Nullable
+    public PsiJavaPackage findPackage(@Nonnull String qualifiedName) {
+        return null;
     }
 
-    final HashSet<String> names = new HashSet<String>();
-    for (PsiClass aClass : classes) {
-      ContainerUtil.addIfNotNull(names, aClass.getName());
+    /**
+     * Search java module for file. Can be automatic module or explicit declaration from java file
+     */
+    @Nullable
+    public PsiJavaModule findModule(@Nonnull VirtualFile file) {
+        return null;
     }
-    return names;
-  }
-
-  public boolean processPackageDirectories(@Nonnull PsiJavaPackage psiPackage, @Nonnull GlobalSearchScope scope,
-                                           @Nonnull Processor<PsiDirectory> consumer) {
-    return processPackageDirectories(psiPackage, scope, consumer, false);
-  }
-
-  public boolean processPackageDirectories(@Nonnull PsiJavaPackage psiPackage, @Nonnull GlobalSearchScope scope,
-                                           @Nonnull Processor<PsiDirectory> consumer, boolean includeLibrarySources) {
-    return true;
-  }
-
-  /**
-   * Returns the list of classes in the specified package and in the specified search scope.
-   *
-   * @param className  short name of the class
-   * @param psiPackage the package to return the list of classes in.
-   * @param scope      the scope in which classes are searched.
-   * @return the list of classes.
-   * @see PsiJavaPackage#getClasses(GlobalSearchScope)
-   */
-  @Nonnull
-  public PsiClass[] getClasses(@Nullable String className, @Nonnull PsiJavaPackage psiPackage, @Nonnull GlobalSearchScope scope) {
-    PsiClass[] allClasses = getClasses(psiPackage, scope);
-    if (className == null) {
-      return allClasses;
+
+    @Nonnull
+    public Collection<PsiJavaModule> findModules(@Nonnull String moduleName, @Nonnull GlobalSearchScope scope) {
+        return List.of();
+    }
+
+    /**
+     * Returns the list of subpackages of the specified package in the specified search scope.
+     *
+     * @param psiPackage the package to return the list of subpackages for.
+     * @param scope      the scope in which subpackages are searched.
+     * @return the list of subpackages.
+     * @see PsiJavaPackage#getSubPackages(GlobalSearchScope)
+     */
+    @Nonnull
+    public PsiJavaPackage[] getSubPackages(@Nonnull PsiJavaPackage psiPackage, @Nonnull GlobalSearchScope scope) {
+        return PsiJavaPackage.EMPTY_ARRAY;
+    }
+
+    /**
+     * Returns a array of files belonging to the specified package which are not located in any of the package directories.
+     *
+     * @param psiPackage the package to return the list of files for.
+     * @param scope      the scope in which files are searched.
+     * @return the array of files.
+     */
+    @Nonnull
+    public PsiFile[] getPackageFiles(@Nonnull PsiJavaPackage psiPackage, @Nonnull GlobalSearchScope scope) {
+        return PsiFile.EMPTY_ARRAY;
+    }
+
+    /**
+     * Returns the filter to use for filtering the list of files in the directories belonging to a package to exclude files
+     * that actually belong to a different package. (For example, in Kotlin the package of a file is determined by its
+     * package statement and not by its location in the directory structure, so the files which have a differring package
+     * statement need to be excluded.)
+     *
+     * @param psiPackage the package for which the list of files is requested.
+     * @param scope      the scope in which children are requested.
+     * @return the filter to use, or null if no additional filtering is necessary.
+     */
+    @Nullable
+    public Predicate<PsiFile> getPackageFilesFilter(@Nonnull PsiJavaPackage psiPackage, @Nonnull GlobalSearchScope scope) {
+        return null;
+    }
+
+    /**
+     * Returns the list of classes in the specified package and in the specified search scope.
+     *
+     * @param psiPackage the package to return the list of classes in.
+     * @param scope      the scope in which classes are searched.
+     * @return the list of classes.
+     * @see PsiJavaPackage#getClasses(GlobalSearchScope)
+     */
+    @Nonnull
+    public PsiClass[] getClasses(@Nonnull PsiJavaPackage psiPackage, @Nonnull GlobalSearchScope scope) {
+        return PsiClass.EMPTY_ARRAY;
+    }
+
+    /**
+     * A method to optimize resolve (to only search classes in a package which might be there)
+     */
+    @Nonnull
+    @RequiredReadAction
+    public Set<String> getClassNames(@Nonnull PsiJavaPackage psiPackage, @Nonnull GlobalSearchScope scope) {
+        return getClassNames(getClasses(psiPackage, scope));
+    }
+
+    @Nonnull
+    @RequiredReadAction
+    protected static Set<String> getClassNames(@Nonnull PsiClass[] classes) {
+        if (classes.length == 0) {
+            return Collections.emptySet();
+        }
+
+        HashSet<String> names = new HashSet<>();
+        for (PsiClass aClass : classes) {
+            ContainerUtil.addIfNotNull(names, aClass.getName());
+        }
+        return names;
     }
-    return filterByName(className, allClasses);
-  }
 
-  @Nonnull
-  public static PsiClass[] filterByName(@Nonnull String className, @Nonnull PsiClass[] classes) {
-    if (classes.length == 0) {
-      return PsiClass.EMPTY_ARRAY;
+    public boolean processPackageDirectories(
+        @Nonnull PsiJavaPackage psiPackage,
+        @Nonnull GlobalSearchScope scope,
+        @Nonnull Predicate<PsiDirectory> consumer
+    ) {
+        return processPackageDirectories(psiPackage, scope, consumer, false);
     }
-    if (classes.length == 1) {
-      return className.equals(classes[0].getName()) ? classes : PsiClass.EMPTY_ARRAY;
+
+    public boolean processPackageDirectories(
+        @Nonnull PsiJavaPackage psiPackage,
+        @Nonnull GlobalSearchScope scope,
+        @Nonnull Predicate<PsiDirectory> consumer,
+        boolean includeLibrarySources
+    ) {
+        return true;
     }
-    List<PsiClass> foundClasses = new SmartList<PsiClass>();
-    for (PsiClass psiClass : classes) {
-      if (className.equals(psiClass.getName())) {
-        foundClasses.add(psiClass);
-      }
+
+    /**
+     * Returns the list of classes in the specified package and in the specified search scope.
+     *
+     * @param className  short name of the class
+     * @param psiPackage the package to return the list of classes in.
+     * @param scope      the scope in which classes are searched.
+     * @return the list of classes.
+     * @see PsiJavaPackage#getClasses(GlobalSearchScope)
+     */
+    @Nonnull
+    @RequiredReadAction
+    public PsiClass[] getClasses(@Nullable String className, @Nonnull PsiJavaPackage psiPackage, @Nonnull GlobalSearchScope scope) {
+        PsiClass[] allClasses = getClasses(psiPackage, scope);
+        if (className == null) {
+            return allClasses;
+        }
+        return filterByName(className, allClasses);
     }
-    return foundClasses.isEmpty() ? PsiClass.EMPTY_ARRAY : foundClasses.toArray(new PsiClass[foundClasses.size()]);
-  }
 
+    @Nonnull
+    @RequiredReadAction
+    public static PsiClass[] filterByName(@Nonnull String className, @Nonnull PsiClass[] classes) {
+        if (classes.length == 0) {
+            return PsiClass.EMPTY_ARRAY;
+        }
+        if (classes.length == 1) {
+            return className.equals(classes[0].getName()) ? classes : PsiClass.EMPTY_ARRAY;
+        }
+        List<PsiClass> foundClasses = new SmartList<>();
+        for (PsiClass psiClass : classes) {
+            if (className.equals(psiClass.getName())) {
+                foundClasses.add(psiClass);
+            }
+        }
+        return foundClasses.isEmpty() ? PsiClass.EMPTY_ARRAY : foundClasses.toArray(new PsiClass[foundClasses.size()]);
+    }
 }