Package com.intellij.psi

Class JavaPsiFacade

java.lang.Object

com.intellij.psi.JavaPsiFacade

Direct Known Subclasses:

JavaPsiFacadeEx

public abstract class JavaPsiFacade
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
JavaPsiFacade()

Method Summary

Modifier and Type	Method and Description
abstract boolean	arePackagesTheSame(PsiElement element1, PsiElement element2) Checks if the specified PSI elements belong to the same package.
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.
abstract PsiJavaModule	findModule(java.lang.String moduleName, GlobalSearchScope scope) Searches the scope for a unique Java module with the given name.
abstract java.util.Collection<PsiJavaModule>	findModules(java.lang.String moduleName, GlobalSearchScope scope) Searches the scope for Java modules with the given name.
abstract 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.
abstract PsiConstantEvaluationHelper	getConstantEvaluationHelper() Returns the constant expression evaluator for the project.
abstract PsiElementFactory	getElementFactory() Returns the element factory for the project, which can be used to create instances of Java elements.
static PsiElementFactory	getElementFactory(Project project)
static JavaPsiFacade	getInstance(Project project)
abstract PsiNameHelper	getNameHelper() Deprecated. use PsiNameHelper.getInstance(Project)
abstract PsiJavaParserFacade	getParserFacade() Returns the factory for the project, which can be used to create instances of certain Java constructs from their textual representation.
abstract Project	getProject()
abstract PsiResolveHelper	getResolveHelper() Returns the resolve helper for the project, which can be used to resolve references and check accessibility of elements.
abstract boolean	isConstantExpression(PsiExpression expression)
abstract boolean	isInPackage(PsiElement element, PsiPackage aPackage) Checks if the specified PSI element belongs to the specified package.
abstract boolean	isPartOfPackagePrefix(java.lang.String packageName) Checks if the specified package name is part of the package prefix for any of the modules in this project.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaPsiFacade

public JavaPsiFacade()

Method Detail

getInstance

public static JavaPsiFacade getInstance(Project project)

getElementFactory

public static PsiElementFactory getElementFactory(Project project)

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.

Returns:

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

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.

Returns:

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

findPackage

public abstract 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.

Returns:

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

findModule

public abstract PsiJavaModule findModule(java.lang.String moduleName,
                                         GlobalSearchScope scope)

Searches the scope for a unique Java module with the given name.

findModules

public abstract java.util.Collection<PsiJavaModule> findModules(java.lang.String moduleName,
                                                                GlobalSearchScope scope)

Searches the scope for Java modules with the given name.

getElementFactory

public abstract PsiElementFactory getElementFactory()

Returns the element factory for the project, which can be used to create instances of Java elements.

getParserFacade

public abstract PsiJavaParserFacade getParserFacade()

Returns the factory for the project, which can be used to create instances of certain Java constructs from their textual representation. Elements created shall not be used to later intermix (like insert into) a PSI parsed from the user codebase since no formatting to the user code style will be performed in this case. Please use getElementFactory() instead, which provides exactly same methods but ensures created instances will get properly formatted.

Returns:

the parser facade.

getResolveHelper

public abstract PsiResolveHelper getResolveHelper()

Returns the resolve helper for the project, which can be used to resolve references and check accessibility of elements.

getNameHelper

@Deprecated
public abstract PsiNameHelper getNameHelper()

Deprecated. use PsiNameHelper.getInstance(Project)

Returns the name helper for the project, which can be used to validate and parse Java identifiers.

getConstantEvaluationHelper

public abstract PsiConstantEvaluationHelper getConstantEvaluationHelper()

Returns the constant expression evaluator for the project.

Returns:

the evaluator instance.

isPartOfPackagePrefix

public abstract boolean isPartOfPackagePrefix(java.lang.String packageName)

Checks if the specified package name is part of the package prefix for any of the modules in this project.

isInPackage

public abstract boolean isInPackage(PsiElement element,
                                    PsiPackage aPackage)

Checks if the specified PSI element belongs to the specified package.

arePackagesTheSame

public abstract boolean arePackagesTheSame(PsiElement element1,
                                           PsiElement element2)

Checks if the specified PSI elements belong to the same package.

getProject

public abstract Project getProject()

isConstantExpression

public abstract boolean isConstantExpression(PsiExpression expression)