Package com.intellij.psi

Class PsiElementFinder

java.lang.Object

com.intellij.psi.PsiElementFinder

Direct Known Subclasses:

GroovyClassFinder, MigrationElementFinder, NonClasspathClassFinder, PackagePrefixElementFinder, PsiElementFinderImpl

public abstract class PsiElementFinder
extends java.lang.Object

Allows to extend the mechanism of locating classes and packages by full-qualified name. Implementations of this interface need to be registered as extensions in order to be picked up by JavaPsiFacade.

Field Summary

Fields

Modifier and Type	Field and Description
static ProjectExtensionPointName<PsiElementFinder>	EP
static ExtensionPointName<PsiElementFinder>	EP_NAME Deprecated. use EP

Constructor Summary

Constructors

Constructor and Description
PsiElementFinder()

Method Summary

Modifier and Type	Method and Description
static PsiClass []	filterByName(java.lang.String className, PsiClass [] classes)
abstract PsiClass	findClass(java.lang.String qualifiedName, GlobalSearchScope scope) Searches the specified scope within the project for a class with the specified full-qualified name and returns one if it is found.
abstract PsiClass []	findClasses(java.lang.String qualifiedName, GlobalSearchScope scope) Searches the specified scope within the project for classes with the specified full-qualified name and returns all found classes.
PsiPackage	findPackage(java.lang.String qualifiedName) Searches the project for the package with the specified full-qualified name and returns one if it is found.
PsiClass []	getClasses(PsiPackage psiPackage, GlobalSearchScope scope) Returns the list of classes in the specified package and in the specified search scope.
PsiClass []	getClasses(java.lang.String className, PsiPackage psiPackage, GlobalSearchScope scope) Returns the list of classes in the specified package and in the specified search scope.
Condition<PsiClass>	getClassesFilter(GlobalSearchScope scope) Returns the filter to exclude classes, for example derived classes.
protected static java.util.Set<java.lang.String>	getClassNames(PsiClass [] classes)
java.util.Set<java.lang.String>	getClassNames(PsiPackage psiPackage, GlobalSearchScope scope) A method to optimize resolve (to only search classes in a package which might be there)
PsiFile []	getPackageFiles(PsiPackage psiPackage, GlobalSearchScope scope) Returns a list of files belonging to the specified package which are not located in any of the package directories.
Condition<PsiFile>	getPackageFilesFilter(PsiPackage psiPackage, GlobalSearchScope scope) 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.
PsiPackage []	getSubPackages(PsiPackage psiPackage, GlobalSearchScope scope) Returns the list of subpackages of the specified package in the specified search scope.
boolean	processPackageDirectories(PsiPackage psiPackage, GlobalSearchScope scope, Processor<? super PsiDirectory> consumer)
boolean	processPackageDirectories(PsiPackage psiPackage, GlobalSearchScope scope, Processor<? super PsiDirectory> consumer, boolean includeLibrarySources)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EP

public static final ProjectExtensionPointName<PsiElementFinder> EP

EP_NAME

@Deprecated
public static final ExtensionPointName<PsiElementFinder> EP_NAME

Deprecated. use EP

Constructor Detail

PsiElementFinder

public PsiElementFinder()

Method Detail

findClass

public abstract PsiClass findClass(java.lang.String qualifiedName,
                                   GlobalSearchScope scope)

Searches the specified scope within the project for a class with the specified full-qualified name and returns one if it is found.

Parameters:

qualifiedName - the full-qualified name of the class to find.

scope - the scope to search.

Returns:

the PSI class, or null if no class with such name is found.

See Also:

JavaPsiFacade.findClass(String, GlobalSearchScope)

findClasses

public abstract PsiClass [] findClasses(java.lang.String qualifiedName,
                                        GlobalSearchScope scope)

Searches the specified scope within the project for classes with the specified full-qualified name and returns all found classes.

Parameters:

qualifiedName - the full-qualified name of the class to find.

scope - the scope to search.

Returns:

the array of found classes, or an empty array if no classes are found.

See Also:

JavaPsiFacade.findClasses(String, GlobalSearchScope)

findPackage

public PsiPackage findPackage(java.lang.String qualifiedName)

Searches the project for the package with the specified full-qualified name and returns one if it is found.

Parameters:

qualifiedName - the full-qualified name of the package to find.

Returns:

the PSI package, or null if no package with such name is found.

See Also:

JavaPsiFacade.findPackage(String)

getSubPackages

public PsiPackage [] getSubPackages(PsiPackage psiPackage,
                                    GlobalSearchScope scope)

Returns the list of subpackages of the specified package in the specified search scope.

Parameters:

psiPackage - the package to return the list of subpackages for.

scope - the scope in which subpackages are searched.

Returns:

the list of subpackages.

See Also:

PsiPackage.getSubPackages(GlobalSearchScope)

getClasses

public PsiClass [] getClasses(PsiPackage psiPackage,
                              GlobalSearchScope scope)

Returns the list of classes in the specified package and in the specified search scope.

Parameters:

psiPackage - the package to return the list of classes in.

scope - the scope in which classes are searched.

Returns:

the list of classes.

See Also:

PsiPackage.getClasses(GlobalSearchScope)

getClassesFilter

public Condition<PsiClass> getClassesFilter(GlobalSearchScope scope)

Returns the filter to exclude classes, for example derived classes.

Parameters:

scope - the scope in which classes are searched.

Returns:

the filter to use, or null if no additional filtering is necessary

getPackageFiles

public PsiFile [] getPackageFiles(PsiPackage psiPackage,
                                  GlobalSearchScope scope)

Returns a list of files belonging to the specified package which are not located in any of the package directories.

Parameters:

psiPackage - the package to return the list of files for.

scope - the scope in which files are searched.

Returns:

the list of files.

getPackageFilesFilter

public Condition<PsiFile> getPackageFilesFilter(PsiPackage psiPackage,
                                                GlobalSearchScope scope)

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.)

Parameters:

psiPackage - the package for which the list of files is requested.

scope - the scope in which children are requested.

Returns:

the filter to use, or null if no additional filtering is necessary.

getClassNames

public java.util.Set<java.lang.String> getClassNames(PsiPackage psiPackage,
                                                     GlobalSearchScope scope)

A method to optimize resolve (to only search classes in a package which might be there)

getClassNames

protected static java.util.Set<java.lang.String> getClassNames(PsiClass [] classes)

processPackageDirectories

public boolean processPackageDirectories(PsiPackage psiPackage,
                                         GlobalSearchScope scope,
                                         Processor<? super PsiDirectory> consumer)

processPackageDirectories

public boolean processPackageDirectories(PsiPackage psiPackage,
                                         GlobalSearchScope scope,
                                         Processor<? super PsiDirectory> consumer,
                                         boolean includeLibrarySources)

getClasses

public PsiClass [] getClasses(java.lang.String className,
                              PsiPackage psiPackage,
                              GlobalSearchScope scope)

Returns the list of classes in the specified package and in the specified search scope.

Parameters:

className - short name of the class

psiPackage - the package to return the list of classes in.

scope - the scope in which classes are searched.

Returns:

the list of classes.

See Also:

PsiPackage.getClasses(GlobalSearchScope)

filterByName

public static PsiClass [] filterByName(java.lang.String className,
                                       PsiClass [] classes)