Package com.intellij.psi.util

Class PsiUtil

java.lang.Object

com.intellij.psi.util.PsiUtilCore

com.intellij.psi.util.PsiUtil

public final class PsiUtil
extends PsiUtilCore

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PsiUtil.AccessLevel
static interface	PsiUtil.ApplicabilityChecker

Nested classes/interfaces inherited from class com.intellij.psi.util.PsiUtilCore

PsiUtilCore.NullPsiElement

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACCESS_LEVEL_PACKAGE_LOCAL
static int	ACCESS_LEVEL_PRIVATE
static int	ACCESS_LEVEL_PROTECTED
static int	ACCESS_LEVEL_PUBLIC
static java.util.Comparator<PsiElement>	BY_POSITION
static Key<LanguageLevel>	FILE_LANGUAGE_LEVEL_KEY
static Key<java.lang.Boolean>	VALID_VOID_TYPE_IN_CODE_FRAGMENT

Fields inherited from class com.intellij.psi.util.PsiUtilCore

NULL_PSI_ELEMENT, NULL_PSI_FILE

Method Summary

Modifier and Type	Method and Description
static void	addException(PsiMethod method, PsiClass exceptionClass)
static void	addException(PsiMethod method, java.lang.String exceptionFQName)
static PsiElement	addModuleStatement(PsiJavaModule module, java.lang.String text)
static boolean	allMethodsHaveSameSignature(PsiMethod [] methods)
static boolean	canBeOverridden(PsiMethod method)
static PsiType	captureToplevelWildcards(PsiType type, PsiElement context) Applies capture conversion to the type in context
static void	checkIsIdentifier(PsiManager manager, java.lang.String text)
static boolean	checkName(PsiElement element, java.lang.String name, PsiElement context)
static PsiType	convertAnonymousToBaseType(PsiType type)
static PsiExpression	deparenthesizeExpression(PsiExpression expression)
static void	ensureValidType(PsiType type)
static void	ensureValidType(PsiType type, java.lang.String customMessage)
static boolean	equalOnEquivalentClasses(PsiClassType thisClassType, PsiClass aClass, PsiClassType otherClassType, PsiClass bClass) Compares types with respect to type parameter bounds: e.g.
static PsiType	extractIterableTypeParameter(PsiType psiType, boolean eraseTypeParameter)
static PsiMember	findEnclosingConstructorOrInitializer(PsiElement expression)
static PsiElement	findModifierInList(PsiModifierList modifierList, java.lang.String modifier)
static PsiReturnStatement []	findReturnStatements(PsiCodeBlock body)
static PsiReturnStatement []	findReturnStatements(PsiMethod method)
static int	getAccessLevel(PsiModifierList modifierList)
static java.lang.String	getAccessModifier(int accessLevel)
static JavaResolveResult	getAccessObjectClass(PsiExpression expression)
static int	getApplicabilityLevel(PsiMethod method, PsiSubstitutor substitutorForMethod, PsiExpressionList argList)
static int	getApplicabilityLevel(PsiMethod method, PsiSubstitutor substitutorForMethod, PsiType [] args, LanguageLevel languageLevel)
static int	getApplicabilityLevel(PsiMethod method, PsiSubstitutor substitutorForMethod, PsiType [] args, LanguageLevel languageLevel, boolean allowUncheckedConversion, boolean checkVarargs, PsiUtil.ApplicabilityChecker function)
static PsiElement	getElementInclusiveRange(PsiElement scope, TextRange range)
static PsiElement	getEnclosingStatement(PsiElement element)
static PsiModifierListOwner	getEnclosingStaticElement(PsiElement place, PsiClass aClass)
static VirtualFile	getJarFile(PsiElement candidate)
static LanguageLevel	getLanguageLevel(Project project)
static LanguageLevel	getLanguageLevel(PsiElement element)
static java.lang.String	getMaximumModifierForMember(PsiClass aClass, boolean allowPublicAbstract)
static java.lang.String	getMemberQualifiedName(PsiMember member)
static java.lang.String	getPackageName(PsiClass aClass)
static java.util.List<PsiTypeElement>	getParameterTypeElements(PsiParameter parameter)
static PsiMethod []	getResourceCloserMethodsForType(PsiClassType resourceType)
static java.util.List<PsiExpression>	getSwitchResultExpressions(PsiSwitchExpression switchExpression)
static PsiClass	getTopLevelClass(PsiElement element)
static PsiElement	getTopLevelEnclosingCodeBlock(PsiElement element, PsiElement scope)
static PsiType	getTypeByPsiElement(PsiElement element)
static PsiElement	getVariableCodeBlock(PsiVariable variable, PsiElement context)
static boolean	hasDefaultConstructor(PsiClass clazz)
static boolean	hasDefaultConstructor(PsiClass clazz, boolean allowProtected)
static boolean	hasDefaultConstructor(PsiClass clazz, boolean allowProtected, boolean allowPrivateAndPackagePrivate)
static boolean	isAbstractClass(PsiClass clazz)
static boolean	isAccessedForReading(PsiExpression expr)
static boolean	isAccessedForWriting(PsiExpression expr)
static boolean	isAccessible(Project project, PsiMember member, PsiElement place, PsiClass accessObjectClass) Checks that a *resolved* to member reference at place is accessible: it's visible by visibility rules as well as by module (java) rules.
static boolean	isAccessible(PsiMember member, PsiElement place, PsiClass accessObjectClass)
static boolean	isAccessibleFromPackage(PsiModifierListOwner element, PsiPackage aPackage)
static boolean	isAnnotationMethod(PsiElement element)
static boolean	isApplicable(PsiMethod method, PsiSubstitutor substitutorForMethod, PsiExpression [] argList)
static boolean	isApplicable(PsiMethod method, PsiSubstitutor substitutorForMethod, PsiExpressionList argList)
static boolean	isArrayClass(PsiElement psiClass)
static boolean	isCatchParameter(PsiElement element)
static boolean	isCompileTimeConstant(PsiVariable field) JLS 15.28
static boolean	isCondition(PsiElement expr, PsiElement parent)
static boolean	isConstantExpression(PsiExpression expression)
static boolean	isElseBlock(PsiElement element)
static boolean	isFromDefaultPackage(PsiClass aClass)
static boolean	isFromDefaultPackage(PsiElement element)
static boolean	isIgnoredName(java.lang.String name)
static boolean	isIncrementDecrementOperation(PsiElement element)
static boolean	isInnerClass(PsiClass aClass) Checks whether given class is inner (as opposed to nested)
static boolean	isInsideJavadocComment(PsiElement element)
static boolean	isInstantiatable(PsiClass clazz)
static boolean	isJavaToken(PsiElement element, IElementType type)
static boolean	isJavaToken(PsiElement element, TokenSet types)
static boolean	isJvmLocalVariable(PsiElement variable)
static boolean	isLanguageLevel10OrHigher(PsiElement element)
static boolean	isLanguageLevel11OrHigher(PsiElement element)
static boolean	isLanguageLevel5OrHigher(PsiElement element)
static boolean	isLanguageLevel6OrHigher(PsiElement element)
static boolean	isLanguageLevel7OrHigher(PsiElement element)
static boolean	isLanguageLevel8OrHigher(PsiElement element)
static boolean	isLanguageLevel9OrHigher(PsiElement element)
static boolean	isLocalClass(PsiClass psiClass)
static boolean	isLocalOrAnonymousClass(PsiClass psiClass)
static boolean	isMemberAccessibleAt(PsiMember member, PsiElement place) Checks that reference on member inserted at place will be resolved and accessible
static boolean	isModuleFile(PsiFile file)
static boolean	isOnAssignmentLeftHand(PsiExpression expr)
static boolean	isPackageEmpty(PsiDirectory [] directories, java.lang.String packageName)
static boolean	isRawSubstitutor(PsiTypeParameterListOwner owner, PsiSubstitutor substitutor)
static boolean	isStatement(PsiElement element)
static boolean	isTryBlock(PsiElement element)
static boolean	isVariableNameUnique(java.lang.String name, PsiElement place)
static PsiElement []	mapElements(ResolveResult [] candidates)
static PsiModifierListOwner	preferCompiledElement(PsiModifierListOwner element)
static void	removeException(PsiMethod method, java.lang.String exceptionClass)
static PsiClass	resolveClassInClassTypeOnly(PsiType type)
static PsiClass	resolveClassInType(PsiType type)
static PsiClassType.ClassResolveResult	resolveGenericsClassInType(PsiType type)
static void	setModifierProperty(PsiModifierListOwner owner, java.lang.String property, boolean value)
static PsiExpression	skipParenthesizedExprDown(PsiExpression expression)
static PsiElement	skipParenthesizedExprUp(PsiElement parent)
static PsiType	substituteTypeParameter(PsiType psiType, PsiClass superClass, int typeParamIndex, boolean eraseTypeParameter)
static PsiType	substituteTypeParameter(PsiType psiType, java.lang.String superClass, int typeParamIndex, boolean eraseTypeParameter)
static java.lang.Iterable<PsiTypeParameter>	typeParametersIterable(PsiTypeParameterListOwner owner)
static java.util.Iterator<PsiTypeParameter>	typeParametersIterator(PsiTypeParameterListOwner owner)

Methods inherited from class com.intellij.psi.util.PsiUtilCore

compareElementsByPosition, ensureValid, findFileSystemItem, findLanguageFromElement, getDialect, getElementAtOffset, getElementType, getElementType, getLanguageAtOffset, getName, getNotAnyLanguage, getOriginalElement, getProjectInReadAction, getPsiFile, getQualifiedNameAfterRename, getTemplateLanguageFile, getVirtualFile, hasErrorElementChild, narrowLanguage, toPsiElementArray, toPsiFileArray, toPsiFiles

Methods inherited from class java.lang.Object

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

Field Detail

ACCESS_LEVEL_PUBLIC

public static final int ACCESS_LEVEL_PUBLIC

See Also:

Constant Field Values

ACCESS_LEVEL_PROTECTED

public static final int ACCESS_LEVEL_PROTECTED

See Also:

Constant Field Values

ACCESS_LEVEL_PACKAGE_LOCAL

public static final int ACCESS_LEVEL_PACKAGE_LOCAL

See Also:

Constant Field Values

ACCESS_LEVEL_PRIVATE

public static final int ACCESS_LEVEL_PRIVATE

See Also:

Constant Field Values

VALID_VOID_TYPE_IN_CODE_FRAGMENT

public static final Key<java.lang.Boolean> VALID_VOID_TYPE_IN_CODE_FRAGMENT

FILE_LANGUAGE_LEVEL_KEY

public static final Key<LanguageLevel> FILE_LANGUAGE_LEVEL_KEY

BY_POSITION

public static final java.util.Comparator<PsiElement> BY_POSITION

Method Detail

isOnAssignmentLeftHand

public static boolean isOnAssignmentLeftHand(PsiExpression expr)

isAccessibleFromPackage

public static boolean isAccessibleFromPackage(PsiModifierListOwner element,
                                              PsiPackage aPackage)

isAccessedForWriting

public static boolean isAccessedForWriting(PsiExpression expr)

isAccessedForReading

public static boolean isAccessedForReading(PsiExpression expr)

isAccessible

public static boolean isAccessible(PsiMember member,
                                   PsiElement place,
                                   PsiClass accessObjectClass)

isAccessible

public static boolean isAccessible(Project project,
                                   PsiMember member,
                                   PsiElement place,
                                   PsiClass accessObjectClass)

Checks that a *resolved* to member reference at place is accessible: it's visible by visibility rules as well as by module (java) rules.

NOTE:

If there is no module (IDEA's) dependency from module with place on a module with member, then reference won't be resolved and this method will return true. Please use isMemberAccessibleAt(PsiMember, PsiElement) to catch these cases as well

isMemberAccessibleAt

public static boolean isMemberAccessibleAt(PsiMember member,
                                           PsiElement place)

Checks that reference on member inserted at place will be resolved and accessible

getAccessObjectClass

public static JavaResolveResult getAccessObjectClass(PsiExpression expression)

isConstantExpression

public static boolean isConstantExpression(PsiExpression expression)

addException

public static void addException(PsiMethod method,
                                java.lang.String exceptionFQName)
                         throws IncorrectOperationException

Throws:

IncorrectOperationException

addException

public static void addException(PsiMethod method,
                                PsiClass exceptionClass)
                         throws IncorrectOperationException

Throws:

IncorrectOperationException

removeException

public static void removeException(PsiMethod method,
                                   java.lang.String exceptionClass)
                            throws IncorrectOperationException

Throws:

IncorrectOperationException

isVariableNameUnique

public static boolean isVariableNameUnique(java.lang.String name,
                                           PsiElement place)

getTopLevelEnclosingCodeBlock

public static PsiElement getTopLevelEnclosingCodeBlock(PsiElement element,
                                                       PsiElement scope)

Returns:

enclosing outermost (method or class initializer) body but not higher than scope

isLocalOrAnonymousClass

public static boolean isLocalOrAnonymousClass(PsiClass psiClass)

isLocalClass

public static boolean isLocalClass(PsiClass psiClass)

isAbstractClass

public static boolean isAbstractClass(PsiClass clazz)

getVariableCodeBlock

public static PsiElement getVariableCodeBlock(PsiVariable variable,
                                              PsiElement context)

Returns:

topmost code block where variable makes sense

isIncrementDecrementOperation

public static boolean isIncrementDecrementOperation(PsiElement element)

getSwitchResultExpressions

public static java.util.List<PsiExpression> getSwitchResultExpressions(PsiSwitchExpression switchExpression)

getAccessLevel

public static int getAccessLevel(PsiModifierList modifierList)

getAccessModifier

public static java.lang.String getAccessModifier(int accessLevel)

See Also:

for JVM language analogue.

isStatement

public static boolean isStatement(PsiElement element)

Returns:

true if element specified is statement or expression statement. see JLS 14.5-14.8

getEnclosingStatement

public static PsiElement getEnclosingStatement(PsiElement element)

getElementInclusiveRange

public static PsiElement getElementInclusiveRange(PsiElement scope,
                                                  TextRange range)

resolveClassInType

public static PsiClass resolveClassInType(PsiType type)

resolveClassInClassTypeOnly

public static PsiClass resolveClassInClassTypeOnly(PsiType type)

resolveGenericsClassInType

public static PsiClassType.ClassResolveResult resolveGenericsClassInType(PsiType type)

convertAnonymousToBaseType

public static PsiType convertAnonymousToBaseType(PsiType type)

isApplicable

public static boolean isApplicable(PsiMethod method,
                                   PsiSubstitutor substitutorForMethod,
                                   PsiExpressionList argList)

isApplicable

public static boolean isApplicable(PsiMethod method,
                                   PsiSubstitutor substitutorForMethod,
                                   PsiExpression [] argList)

getApplicabilityLevel

public static int getApplicabilityLevel(PsiMethod method,
                                        PsiSubstitutor substitutorForMethod,
                                        PsiExpressionList argList)

getApplicabilityLevel

public static int getApplicabilityLevel(PsiMethod method,
                                        PsiSubstitutor substitutorForMethod,
                                        PsiType [] args,
                                        LanguageLevel languageLevel)

getApplicabilityLevel

public static int getApplicabilityLevel(PsiMethod method,
                                        PsiSubstitutor substitutorForMethod,
                                        PsiType [] args,
                                        LanguageLevel languageLevel,
                                        boolean allowUncheckedConversion,
                                        boolean checkVarargs,
                                        PsiUtil.ApplicabilityChecker function)

equalOnEquivalentClasses

public static boolean equalOnEquivalentClasses(PsiClassType thisClassType,
                                               PsiClass aClass,
                                               PsiClassType otherClassType,
                                               PsiClass bClass)

Compares types with respect to type parameter bounds: e.g. for class Foo<T extends Number>{} types Foo<?> and Foo<? extends Number> would be equivalent

isCompileTimeConstant

public static boolean isCompileTimeConstant(PsiVariable field)

JLS 15.28

allMethodsHaveSameSignature

public static boolean allMethodsHaveSameSignature(PsiMethod [] methods)

deparenthesizeExpression

public static PsiExpression deparenthesizeExpression(PsiExpression expression)

isInnerClass

public static boolean isInnerClass(PsiClass aClass)

Checks whether given class is inner (as opposed to nested)

findModifierInList

public static PsiElement findModifierInList(PsiModifierList modifierList,
                                            java.lang.String modifier)

getTopLevelClass

public static PsiClass getTopLevelClass(PsiElement element)

getPackageName

public static java.lang.String getPackageName(PsiClass aClass)

getEnclosingStaticElement

public static PsiModifierListOwner getEnclosingStaticElement(PsiElement place,
                                                             PsiClass aClass)

Parameters:

place - place to start traversal

aClass - level to stop traversal

Returns:

element with static modifier enclosing place and enclosed by aClass (if not null)

getTypeByPsiElement

public static PsiType getTypeByPsiElement(PsiElement element)

captureToplevelWildcards

public static PsiType captureToplevelWildcards(PsiType type,
                                               PsiElement context)

Applies capture conversion to the type in context

isInsideJavadocComment

public static boolean isInsideJavadocComment(PsiElement element)

getParameterTypeElements

public static java.util.List<PsiTypeElement> getParameterTypeElements(PsiParameter parameter)

checkIsIdentifier

public static void checkIsIdentifier(PsiManager manager,
                                     java.lang.String text)
                              throws IncorrectOperationException

Throws:

IncorrectOperationException

getJarFile

public static VirtualFile getJarFile(PsiElement candidate)

isAnnotationMethod

public static boolean isAnnotationMethod(PsiElement element)

getMaximumModifierForMember

public static java.lang.String getMaximumModifierForMember(PsiClass aClass,
                                                           boolean allowPublicAbstract)

typeParametersIterator

public static java.util.Iterator<PsiTypeParameter> typeParametersIterator(PsiTypeParameterListOwner owner)

typeParametersIterable

public static java.lang.Iterable<PsiTypeParameter> typeParametersIterable(PsiTypeParameterListOwner owner)

canBeOverridden

public static boolean canBeOverridden(PsiMethod method)

mapElements

public static PsiElement [] mapElements(ResolveResult [] candidates)

findEnclosingConstructorOrInitializer

public static PsiMember findEnclosingConstructorOrInitializer(PsiElement expression)

checkName

public static boolean checkName(PsiElement element,
                                java.lang.String name,
                                PsiElement context)

isRawSubstitutor

public static boolean isRawSubstitutor(PsiTypeParameterListOwner owner,
                                       PsiSubstitutor substitutor)

isLanguageLevel5OrHigher

public static boolean isLanguageLevel5OrHigher(PsiElement element)

isLanguageLevel6OrHigher

public static boolean isLanguageLevel6OrHigher(PsiElement element)

isLanguageLevel7OrHigher

public static boolean isLanguageLevel7OrHigher(PsiElement element)

isLanguageLevel8OrHigher

public static boolean isLanguageLevel8OrHigher(PsiElement element)

isLanguageLevel9OrHigher

public static boolean isLanguageLevel9OrHigher(PsiElement element)

isLanguageLevel10OrHigher

public static boolean isLanguageLevel10OrHigher(PsiElement element)

isLanguageLevel11OrHigher

public static boolean isLanguageLevel11OrHigher(PsiElement element)

getLanguageLevel

public static LanguageLevel getLanguageLevel(PsiElement element)

getLanguageLevel

public static LanguageLevel getLanguageLevel(Project project)

isInstantiatable

public static boolean isInstantiatable(PsiClass clazz)

hasDefaultConstructor

public static boolean hasDefaultConstructor(PsiClass clazz)

hasDefaultConstructor

public static boolean hasDefaultConstructor(PsiClass clazz,
                                            boolean allowProtected)

hasDefaultConstructor

public static boolean hasDefaultConstructor(PsiClass clazz,
                                            boolean allowProtected,
                                            boolean allowPrivateAndPackagePrivate)

extractIterableTypeParameter

public static PsiType extractIterableTypeParameter(PsiType psiType,
                                                   boolean eraseTypeParameter)

substituteTypeParameter

public static PsiType substituteTypeParameter(PsiType psiType,
                                              java.lang.String superClass,
                                              int typeParamIndex,
                                              boolean eraseTypeParameter)

substituteTypeParameter

public static PsiType substituteTypeParameter(PsiType psiType,
                                              PsiClass superClass,
                                              int typeParamIndex,
                                              boolean eraseTypeParameter)

setModifierProperty

public static void setModifierProperty(PsiModifierListOwner owner,
                                       java.lang.String property,
                                       boolean value)

isTryBlock

public static boolean isTryBlock(PsiElement element)

isElseBlock

public static boolean isElseBlock(PsiElement element)

isJavaToken

public static boolean isJavaToken(PsiElement element,
                                  IElementType type)

isJavaToken

public static boolean isJavaToken(PsiElement element,
                                  TokenSet types)

isCatchParameter

public static boolean isCatchParameter(PsiElement element)

isIgnoredName

public static boolean isIgnoredName(java.lang.String name)

getResourceCloserMethodsForType

public static PsiMethod [] getResourceCloserMethodsForType(PsiClassType resourceType)

skipParenthesizedExprDown

public static PsiExpression skipParenthesizedExprDown(PsiExpression expression)

skipParenthesizedExprUp

public static PsiElement skipParenthesizedExprUp(PsiElement parent)

ensureValidType

public static void ensureValidType(PsiType type)

ensureValidType

public static void ensureValidType(PsiType type,
                                   java.lang.String customMessage)

getMemberQualifiedName

public static java.lang.String getMemberQualifiedName(PsiMember member)

isFromDefaultPackage

public static boolean isFromDefaultPackage(PsiClass aClass)

isFromDefaultPackage

public static boolean isFromDefaultPackage(PsiElement element)

isCondition

public static boolean isCondition(PsiElement expr,
                                  PsiElement parent)

findReturnStatements

public static PsiReturnStatement [] findReturnStatements(PsiMethod method)

findReturnStatements

public static PsiReturnStatement [] findReturnStatements(PsiCodeBlock body)

isModuleFile

public static boolean isModuleFile(PsiFile file)

isPackageEmpty

public static boolean isPackageEmpty(PsiDirectory [] directories,
                                     java.lang.String packageName)

preferCompiledElement

public static PsiModifierListOwner preferCompiledElement(PsiModifierListOwner element)

addModuleStatement

public static PsiElement addModuleStatement(PsiJavaModule module,
                                            java.lang.String text)

isArrayClass

public static boolean isArrayClass(PsiElement psiClass)

isJvmLocalVariable

public static boolean isJvmLocalVariable(PsiElement variable)

Parameters:

variable - variable to test

Returns:

true if variable corresponds to JVM local variable defined inside the method