Package com.intellij.psi

Class NonClasspathClassFinder

java.lang.Object

com.intellij.psi.PsiElementFinder

com.intellij.psi.NonClasspathClassFinder

Direct Known Subclasses:

AlternativeJreClassFinder, GantClassFinder, IdeaOpenApiClassFinder

public abstract class NonClasspathClassFinder
extends PsiElementFinder

Field Summary

Fields

Modifier and Type	Field and Description
protected Project	myProject

Fields inherited from class com.intellij.psi.PsiElementFinder

EP, EP_NAME

Constructor Summary

Constructors

Constructor and Description
NonClasspathClassFinder(Project project, java.lang.String... fileExtensions)

Method Summary

Modifier and Type	Method and Description
static GlobalSearchScope	addNonClasspathScope(Project project, GlobalSearchScope base)
protected abstract java.util.List<VirtualFile>	calcClassRoots()
void	clearCache()
protected static PackageDirectoryCache	createCache(java.util.List<? extends VirtualFile> roots) Deprecated. use PackageDirectoryCache.createCache(List)
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.
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.
protected PackageDirectoryCache	getCache(GlobalSearchScope scope)
PsiClass []	getClasses(PsiPackage psiPackage, GlobalSearchScope scope) Returns the list of classes in the specified package and in the specified search scope.
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)
java.util.List<VirtualFile>	getClassRoots()
protected java.util.List<VirtualFile>	getClassRoots(GlobalSearchScope scope)
PsiManager	getPsiManager()
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 includeLibrarySources)

Methods inherited from class com.intellij.psi.PsiElementFinder

filterByName, getClasses, getClassesFilter, getClassNames, getPackageFiles, getPackageFilesFilter, processPackageDirectories

Methods inherited from class java.lang.Object

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

Field Detail

myProject

protected final Project myProject

Constructor Detail

NonClasspathClassFinder

public NonClasspathClassFinder(Project project,
                               java.lang.String... fileExtensions)

Method Detail

getCache

protected PackageDirectoryCache getCache(GlobalSearchScope scope)

createCache

@Deprecated
protected static PackageDirectoryCache createCache(java.util.List<? extends VirtualFile> roots)

Deprecated. use PackageDirectoryCache.createCache(List)

clearCache

public void clearCache()

getClassRoots

protected java.util.List<VirtualFile> getClassRoots(GlobalSearchScope scope)

getClassRoots

public java.util.List<VirtualFile> getClassRoots()

findClass

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

Description copied from class: PsiElementFinder

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

Specified by:

findClass in class PsiElementFinder

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)

calcClassRoots

protected abstract java.util.List<VirtualFile> calcClassRoots()

getClasses

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

Description copied from class: PsiElementFinder

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

Overrides:

getClasses in class PsiElementFinder

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)

getClassNames

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

Description copied from class: PsiElementFinder

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

Overrides:

getClassNames in class PsiElementFinder

findPackage

public PsiPackage findPackage(java.lang.String qualifiedName)

Description copied from class: PsiElementFinder

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

Overrides:

findPackage in class PsiElementFinder

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)

processPackageDirectories

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

Overrides:

processPackageDirectories in class PsiElementFinder

getSubPackages

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

Description copied from class: PsiElementFinder

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

Overrides:

getSubPackages in class PsiElementFinder

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)

findClasses

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

Description copied from class: PsiElementFinder

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

Specified by:

findClasses in class PsiElementFinder

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)

addNonClasspathScope

public static GlobalSearchScope addNonClasspathScope(Project project,
                                                     GlobalSearchScope base)

getPsiManager

public PsiManager getPsiManager()