Package com.intellij.psi.impl.source.tree.java

Class PsiReferenceExpressionImpl

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.source.tree.TreeElement

com.intellij.psi.impl.source.tree.CompositeElement

com.intellij.psi.impl.source.tree.CompositePsiElement

com.intellij.psi.impl.source.tree.java.ExpressionPsiElement

com.intellij.psi.impl.source.tree.java.PsiReferenceExpressionImpl

All Implemented Interfaces:

ASTNode, PsiSymbolReference, SymbolReference, NavigationItem, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, SourceJavaCodeReference, PsiAnnotationMemberValue, PsiElement, PsiExpression, PsiJavaCodeReferenceElement, PsiJavaReference, PsiPolyVariantReference, PsiQualifiedReference, PsiQualifiedReferenceElement, PsiReference, PsiReferenceExpression, java.lang.Cloneable

public class PsiReferenceExpressionImpl
extends ExpressionPsiElement
implements PsiReferenceExpression, SourceJavaCodeReference

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PsiReferenceExpressionImpl.OurGenericsResolver

Nested classes/interfaces inherited from interface com.intellij.openapi.util.Iconable

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields inherited from class com.intellij.psi.impl.source.tree.CompositePsiElement

ourHC

Fields inherited from class com.intellij.psi.impl.source.tree.CompositeElement

EMPTY_ARRAY

Fields inherited from class com.intellij.psi.impl.ElementBase

FLAGS_LOCKED, ICON_PLACEHOLDER

Fields inherited from interface com.intellij.psi.PsiExpression

ARRAY_FACTORY, EMPTY_ARRAY, EXPRESSION_TO_TYPE

Fields inherited from interface com.intellij.psi.PsiJavaCodeReferenceElement

ARRAY_FACTORY, EMPTY_ARRAY

Fields inherited from interface com.intellij.openapi.util.Iconable

ICON_FLAG_IGNORE_MASK, ICON_FLAG_OPEN, ICON_FLAG_READ_STATUS, ICON_FLAG_VISIBILITY

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Constructor Summary

Constructors

Constructor and Description
PsiReferenceExpressionImpl()

Method Summary

Modifier and Type	Method and Description
void	accept(PsiElementVisitor visitor) Passes the element to the specified visitor.
JavaResolveResult	advancedResolve(boolean incompleteCode) Resolves the reference and returns the result as a JavaResolveResult instead of a plain PsiElement.
PsiElement	bindToElement(PsiElement element) Changes the reference so that it starts to point to the specified element.
PsiElement	bindToElementViaStaticImport(PsiClass qualifierClass) Creates an import static statement importing the referenced member from the specified class, or qualifies the reference with the class name if that class is already imported by a regular import statement.
static void	bindToElementViaStaticImport(PsiClass qualifierClass, java.lang.String staticName, PsiImportList importList)
void	clearCaches()
static TreeElement	createEmptyRefParameterList(Project project)
void	deleteChildInternal(ASTNode child)
ASTNode	findChildByRole(int role)
void	fullyQualify(PsiClass targetClass) Helper method for ReferenceAdjuster.
java.lang.String	getCanonicalText() Returns the name of the reference target element which does not depend on import statements and other context (for example, the full-qualified name of the class if the reference targets a Java class).
int	getChildRole(ASTNode child)
java.lang.String	getClassNameText()
PsiElement	getElement() Returns the underlying (referencing) element of the reference.
PsiReferenceParameterList	getParameterList() Returns the list of type arguments specified on the reference.
java.lang.String	getQualifiedName() Returns the text of the reference including its qualifier.
PsiElement	getQualifier() Returns the qualifier of the reference (the element representing the content up to the last period).
PsiExpression	getQualifierExpression() Returns the expression used as the qualifier of the reference (the content up to the last period).
TextRange	getRangeInElement() Returns the part of the underlying element which serves as a reference, or the complete text range of the element if the entire element is a reference.
PsiReference	getReference() Returns the reference from this PSI element to another PSI element (or elements), if one exists.
java.lang.String	getReferenceName() Returns the text of the reference not including its qualifier.
PsiElement	getReferenceNameElement() Returns the element representing the name of the referenced element.
int	getTextOffset() Returns the offset in the file to which the caret should be placed when performing the navigation to the element.
PsiType	getType() Returns the type of the expression.
PsiType []	getTypeParameters() Returns the array of types for the type arguments specified on the reference.
PsiElement	handleElementRename(java.lang.String newElementName) Called when the reference target element has been renamed, in order to change the reference text according to the new name.
boolean	isQualified() Checks if the reference is qualified (consists of elements separated with periods).
boolean	isReferenceTo(PsiElement element) Checks if the reference targets the specified element.
boolean	isSoft() Returns false if the underlying element is guaranteed to be a reference, or true if the underlying element is a possible reference which should not be reported as an error if it fails to resolve.
JavaResolveResult []	multiResolve(boolean incompleteCode) Returns the results of resolving the reference.
void	processVariants(PsiScopeProcessor processor) Passes all variants to which the reference may resolve to the specified processor.
PsiElement	resolve() Returns the element which is the target of the reference.
static boolean	seemsScrambled(PsiClass aClass)
static boolean	seemsScrambledByStructure(PsiClass aClass)
void	setQualifierExpression(PsiExpression newQualifier)
java.lang.String	toString() toString() should never be presented to the user.

Methods inherited from class com.intellij.psi.impl.source.tree.java.ExpressionPsiElement

hashCode, replaceChildInternal

Methods inherited from class com.intellij.psi.impl.source.tree.CompositePsiElement

acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, canNavigate, canNavigateToSource, checkAdd, checkDelete, clone, copy, delete, deleteChildRange, findElementAt, findReferenceAt, getChildren, getContainingFile, getContext, getFirstChild, getLanguage, getLastChild, getName, getNavigationElement, getNextSibling, getNode, getOriginalElement, getParent, getPresentation, getPrevSibling, getProject, getReferences, getResolveScope, getUseScope, isEquivalentTo, isPhysical, isValid, isWritable, navigate, processDeclarations, replace

Methods inherited from class com.intellij.psi.impl.source.tree.CompositeElement

acceptTree, addChild, addChild, addChildren, addInternal, addLeaf, countChildren, createPsiNoLock, findChildByRoleAsPsiElement, findChildByType, findChildByType, findChildByType, findChildByType, findLeafElementAt, findPsiChildByType, findPsiChildByType, getCachedLength, getChars, getChildren, getChildrenAsPsiElements, getChildrenAsPsiElements, getChildRole, getFirstChildNode, getLastChildNode, getPsi, getPsi, getText, getTextLength, hc, rawAddChildren, rawAddChildrenWithoutNotifications, rawFirstChild, rawLastChild, rawRemoveAllChildren, removeAllChildren, removeChild, removeRange, replaceAllChildrenToChildrenOf, replaceChild, setPsi, subtreeChanged, textContains, textMatches, textToCharArray

Methods inherited from class com.intellij.psi.impl.source.tree.TreeElement

copyElement, equals, getElementType, getManager, getStartOffset, getStartOffsetInParent, getTextRange, getTreeNext, getTreeParent, getTreePrev, invalidate, onInvalidated, rawInsertAfterMe, rawInsertBeforeMe, rawRemove, rawRemoveUpTo, rawRemoveUpToLast, rawReplaceWithList, textMatches, textMatches, textMatches

Methods inherited from class com.intellij.psi.impl.ElementBase

buildRowIcon, computeBaseIcon, createLayeredIcon, getAdjustedBaseIcon, getBaseIcon, getElementIcon, getIcon, iconWithVisibilityIfNeeded, isNativeFileType, isVisibilitySupported, overlayIcons, registerIconLayer, transformFlags

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.intellij.psi.PsiPolyVariantReference

resolveReference

Methods inherited from interface com.intellij.psi.PsiElement

acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, copy, delete, deleteChildRange, findElementAt, findReferenceAt, getChildren, getContainingFile, getContext, getCopyableUserData, getFirstChild, getLanguage, getLastChild, getManager, getNavigationElement, getNextSibling, getNode, getOriginalElement, getOwnReferences, getParent, getPrevSibling, getProject, getReferences, getResolveScope, getStartOffsetInParent, getText, getTextLength, getTextRange, getTextRangeInParent, getUseScope, isEquivalentTo, isPhysical, isValid, isWritable, processDeclarations, putCopyableUserData, replace, textContains, textMatches, textMatches, textToCharArray

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Methods inherited from interface com.intellij.openapi.util.Iconable

getIcon

Methods inherited from interface com.intellij.psi.PsiReference

getVariants, resolvesTo

Methods inherited from interface com.intellij.model.psi.PsiSymbolReference

getAbsoluteRange

Methods inherited from interface com.intellij.lang.ASTNode

getCopyableUserData, putCopyableUserData

Constructor Detail

PsiReferenceExpressionImpl

public PsiReferenceExpressionImpl()

Method Detail

getQualifierExpression

public PsiExpression getQualifierExpression()

Description copied from interface: PsiReferenceExpression

Returns the expression used as the qualifier of the reference (the content up to the last period).

Specified by:

getQualifierExpression in interface PsiReferenceExpression

Returns:

the qualifier, or null if the reference is not qualified.

bindToElementViaStaticImport

public PsiElement bindToElementViaStaticImport(PsiClass qualifierClass)
                                        throws IncorrectOperationException

Description copied from interface: PsiReferenceExpression

Creates an import static statement importing the referenced member from the specified class, or qualifies the reference with the class name if that class is already imported by a regular import statement.

Specified by:

bindToElementViaStaticImport in interface PsiReferenceExpression

Parameters:

qualifierClass - the class to import.

Returns:

the element corresponding to this element in the PSI tree after the modification.

Throws:

IncorrectOperationException - if the modification failed for some reason.

bindToElementViaStaticImport

public static void bindToElementViaStaticImport(PsiClass qualifierClass,
                                                java.lang.String staticName,
                                                PsiImportList importList)
                                         throws IncorrectOperationException

Throws:

IncorrectOperationException

setQualifierExpression

public void setQualifierExpression(PsiExpression newQualifier)
                            throws IncorrectOperationException

Specified by:

setQualifierExpression in interface PsiReferenceExpression

Throws:

IncorrectOperationException

getQualifier

public PsiElement getQualifier()

Description copied from interface: PsiQualifiedReference

Returns the qualifier of the reference (the element representing the content up to the last period).

Specified by:

getQualifier in interface SourceJavaCodeReference

Specified by:

getQualifier in interface PsiQualifiedReference

Returns:

the qualifier, or null if the reference is not qualified.

getReferenceName

public java.lang.String getReferenceName()

Description copied from interface: PsiQualifiedReference

Returns the text of the reference not including its qualifier.

Specified by:

getReferenceName in interface PsiQualifiedReference

Returns:

the non-qualified text of the reference, or null if the reference element is incomplete.

clearCaches

public void clearCaches()

Overrides:

clearCaches in class CompositeElement

multiResolve

public JavaResolveResult [] multiResolve(boolean incompleteCode)

Description copied from interface: PsiPolyVariantReference

Returns the results of resolving the reference.

Specified by:

multiResolve in interface PsiJavaReference

Specified by:

multiResolve in interface PsiPolyVariantReference

Parameters:

incompleteCode - if true, the code in the context of which the reference is being resolved is considered incomplete, and the method may return additional invalid results.

Returns:

the array of results for resolving the reference.

getCanonicalText

public java.lang.String getCanonicalText()

Description copied from interface: PsiReference

Returns the name of the reference target element which does not depend on import statements and other context (for example, the full-qualified name of the class if the reference targets a Java class).

Specified by:

getCanonicalText in interface PsiReference

Returns:

the canonical text of the reference.

getType

public PsiType getType()

Description copied from interface: PsiExpression

Returns the type of the expression.

Specified by:

getType in interface PsiExpression

Returns:

the expression type, or null if the type is not known.

isReferenceTo

public boolean isReferenceTo(PsiElement element)

Description copied from interface: PsiReference

Checks if the reference targets the specified element.

Specified by:

isReferenceTo in interface PsiReference

Parameters:

element - the element to check target for.

Returns:

true if the reference targets that element, false otherwise.

isSoft

public boolean isSoft()

Description copied from interface: PsiReference

Returns false if the underlying element is guaranteed to be a reference, or true if the underlying element is a possible reference which should not be reported as an error if it fails to resolve. For example, a text in an XML file which looks like a full-qualified Java class name is a soft reference.

Specified by:

isSoft in interface PsiReference

Returns:

true if the reference is soft, false otherwise.

processVariants

public void processVariants(PsiScopeProcessor processor)

Description copied from interface: PsiJavaReference

Passes all variants to which the reference may resolve to the specified processor.

Specified by:

processVariants in interface PsiJavaReference

Parameters:

processor - the processor accepting the variants

advancedResolve

public JavaResolveResult advancedResolve(boolean incompleteCode)

Description copied from interface: PsiJavaReference

Resolves the reference and returns the result as a JavaResolveResult instead of a plain PsiElement.

Specified by:

advancedResolve in interface PsiJavaReference

Parameters:

incompleteCode - if true, the code in the context of which the reference is being resolved is considered incomplete, and the method may return an invalid result.

Returns:

the result of the resolve.

seemsScrambled

public static boolean seemsScrambled(PsiClass aClass)

seemsScrambledByStructure

public static boolean seemsScrambledByStructure(PsiClass aClass)

getReferenceNameElement

public PsiElement getReferenceNameElement()

Description copied from interface: PsiJavaCodeReferenceElement

Returns the element representing the name of the referenced element.

Specified by:

getReferenceNameElement in interface PsiJavaCodeReferenceElement

Returns:

the element, or null if the reference element is not physical (for example, exists in compiled code).

getParameterList

public PsiReferenceParameterList getParameterList()

Description copied from interface: PsiJavaCodeReferenceElement

Returns the list of type arguments specified on the reference.

Specified by:

getParameterList in interface PsiJavaCodeReferenceElement

Returns:

the type argument list, or null if the reference may not have any type arguments (like PsiImportStaticReferenceElement).

getTypeParameters

public PsiType [] getTypeParameters()

Description copied from interface: PsiJavaCodeReferenceElement

Returns the array of types for the type arguments specified on the reference.

Specified by:

getTypeParameters in interface PsiJavaCodeReferenceElement

Returns:

the array of types, or an empty array if the reference does not have any type arguments.

getTextOffset

public int getTextOffset()

Description copied from interface: PsiElement

Returns the offset in the file to which the caret should be placed when performing the navigation to the element. (For classes implementing PsiNamedElement, this should return the offset in the file of the name identifier.)

Specified by:

getTextOffset in interface PsiElement

Overrides:

getTextOffset in class TreeElement

Returns:

the offset of the PSI element.

handleElementRename

public PsiElement handleElementRename(java.lang.String newElementName)
                               throws IncorrectOperationException

Description copied from interface: PsiReference

Called when the reference target element has been renamed, in order to change the reference text according to the new name.

Specified by:

handleElementRename in interface PsiReference

Parameters:

newElementName - the new name of the target element.

Returns:

the new underlying element of the reference.

Throws:

IncorrectOperationException - if the rename cannot be handled for some reason.

bindToElement

public PsiElement bindToElement(PsiElement element)
                         throws IncorrectOperationException

Description copied from interface: PsiReference

Changes the reference so that it starts to point to the specified element. This is called, for example, by the "Create Class from New" quickfix, to bind the (invalid) reference on which the quickfix was called to the newly created class.

Specified by:

bindToElement in interface PsiReference

Parameters:

element - the element which should become the target of the reference.

Returns:

the new underlying element of the reference.

Throws:

IncorrectOperationException - if the rebind cannot be handled for some reason.

deleteChildInternal

public void deleteChildInternal(ASTNode child)

Overrides:

deleteChildInternal in class CompositeElement

createEmptyRefParameterList

public static TreeElement createEmptyRefParameterList(Project project)

findChildByRole

public ASTNode findChildByRole(int role)

Overrides:

findChildByRole in class CompositeElement

getChildRole

public int getChildRole(ASTNode child)

Overrides:

getChildRole in class CompositeElement

getReference

public PsiReference getReference()

Description copied from interface: PsiElement

Returns the reference from this PSI element to another PSI element (or elements), if one exists. If the element has multiple associated references (see PsiElement.getReferences() for an example), returns the first associated reference.

Specified by:

getReference in interface PsiElement

Overrides:

getReference in class CompositePsiElement

Returns:

the reference instance, or null if the PSI element does not have any associated references.

See Also:

ReferencesSearch

accept

public void accept(PsiElementVisitor visitor)

Description copied from interface: PsiElement

Passes the element to the specified visitor.

Specified by:

accept in interface PsiElement

Overrides:

accept in class CompositePsiElement

Parameters:

visitor - the visitor to pass the element to.

getElement

public PsiElement getElement()

Description copied from interface: PsiReference

Returns the underlying (referencing) element of the reference.

Specified by:

getElement in interface PsiSymbolReference

Specified by:

getElement in interface PsiReference

Returns:

the underlying element of the reference.

getRangeInElement

public TextRange getRangeInElement()

Description copied from interface: PsiReference

Returns the part of the underlying element which serves as a reference, or the complete text range of the element if the entire element is a reference.

Sample: PsiElement representing a fully qualified name with multiple dedicated PsiReferences, each bound to the range it resolves to (skipping the '.' separator).

 PsiElement text: qualified.LongName
 PsiReferences:   [Ref1---]X[Ref2--]
 

where Ref1 would resolve to a "namespace" and Ref2 to an "element".

Specified by:

getRangeInElement in interface PsiSymbolReference

Specified by:

getRangeInElement in interface PsiReference

Returns:

Relative range in element

resolve

public PsiElement resolve()

Description copied from interface: PsiReference

Returns the element which is the target of the reference.

Specified by:

resolve in interface PsiReference

Returns:

the target element, or null if it was not possible to resolve the reference to a valid target.

See Also:

PsiPolyVariantReference.multiResolve(boolean)

getClassNameText

public java.lang.String getClassNameText()

Specified by:

getClassNameText in interface SourceJavaCodeReference

Returns:

text of class name (as much as there is in reference text, that is with qualifications if they are present)

fullyQualify

public void fullyQualify(PsiClass targetClass)

Description copied from interface: SourceJavaCodeReference

Helper method for ReferenceAdjuster. Tries to qualify this reference as if it references targetClass. Does not check that it indeed references targetClass

Specified by:

fullyQualify in interface SourceJavaCodeReference

isQualified

public boolean isQualified()

Description copied from interface: PsiJavaCodeReferenceElement

Checks if the reference is qualified (consists of elements separated with periods).

Specified by:

isQualified in interface SourceJavaCodeReference

Specified by:

isQualified in interface PsiJavaCodeReferenceElement

Returns:

true if the reference is qualified, false otherwise.

getQualifiedName

public java.lang.String getQualifiedName()

Description copied from interface: PsiJavaCodeReferenceElement

Returns the text of the reference including its qualifier.

Specified by:

getQualifiedName in interface PsiJavaCodeReferenceElement

Returns:

the qualified text of the reference.

toString

public java.lang.String toString()

Description copied from interface: PsiElement

toString() should never be presented to the user.

Specified by:

toString in interface PsiElement

Overrides:

toString in class CompositePsiElement