Package com.intellij.psi

Class AbstractQualifiedReference<T extends AbstractQualifiedReference<T>>

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.PsiElementBase

com.intellij.extapi.psi.ASTDelegatePsiElement

com.intellij.extapi.psi.ASTWrapperPsiElement

com.intellij.psi.AbstractQualifiedReference<T>

All Implemented Interfaces:

PsiSymbolReference, SymbolReference, NavigationItem, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, NavigatablePsiElement, PsiElement, PsiPolyVariantReference, PsiQualifiedReference, PsiQualifiedReferenceElement, PsiReference, java.lang.Cloneable

public abstract class AbstractQualifiedReference<T extends AbstractQualifiedReference<T>>
extends ASTWrapperPsiElement
implements PsiPolyVariantReference, PsiQualifiedReferenceElement

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractQualifiedReference.AbstractQualifiedReferenceResolvingProcessor

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

FLAGS_LOCKED, ICON_PLACEHOLDER

Fields inherited from interface com.intellij.psi.PsiElement

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.psi.NavigatablePsiElement

EMPTY_NAVIGATABLE_ELEMENT_ARRAY

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractQualifiedReference(ASTNode node)

Method Summary

Modifier and Type	Method and Description
PsiElement	bindToElement(PsiElement element) Changes the reference so that it starts to point to the specified element.
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).
PsiElement	getElement() Returns the underlying (referencing) element of the reference.
T	getQualifier() Returns the qualifier of the reference (the element representing 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.
protected abstract PsiElement	getReferenceNameElement()
protected abstract PsiElement	getSeparator()
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.
protected boolean	isAccessible(PsiElement element)
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.
ResolveResult []	multiResolve(boolean incompleteCode) Returns the results of resolving the reference.
protected abstract T	parseReference(java.lang.String newText)
protected boolean	processUnqualifiedVariants(PsiScopeProcessor processor)
protected boolean	processVariantsInner(PsiScopeProcessor processor)
protected AbstractQualifiedReference	replaceReference(java.lang.String newText)
PsiElement	resolve() Returns the element which is the target of the reference.
protected abstract ResolveResult []	resolveInner()
protected AbstractQualifiedReference	shortenReferences()

Methods inherited from class com.intellij.extapi.psi.ASTWrapperPsiElement

getNode, getParent, toString

Methods inherited from class com.intellij.extapi.psi.ASTDelegatePsiElement

add, addAfter, addBefore, addInternal, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, copy, delete, deleteChildInternal, deleteChildRange, findChildByFilter, findChildByType, findChildByType, findChildrenByType, findChildrenByType, findChildrenByType, findChildrenByType, findElementAt, findLastChildByType, findNotNullChildByType, findNotNullChildByType, getChildren, getContainingFile, getCopyableUserData, getFirstChild, getLanguage, getLastChild, getManager, getNextSibling, getPrevSibling, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, putCopyableUserData, replace, replaceChildInternal, subtreeChanged, textContains, textMatches, textToCharArray

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

accept, acceptChildren, canNavigate, canNavigateToSource, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getContext, getName, getNavigationElement, getOriginalElement, getPresentation, getProject, getReferences, getResolveScope, getUseScope, isEquivalentTo, isPhysical, isValid, isWritable, navigate, notNullChild, processDeclarations, 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, clone, copyCopyableDataTo, copyUserDataTo, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.psi.PsiPolyVariantReference

resolveReference

Methods inherited from interface com.intellij.psi.PsiElement

accept, 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, getTextOffset, getTextRange, getTextRangeInParent, getUseScope, isEquivalentTo, isPhysical, isValid, isWritable, processDeclarations, putCopyableUserData, replace, textContains, textMatches, textMatches, textToCharArray, toString

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

Constructor Detail

AbstractQualifiedReference

protected AbstractQualifiedReference(ASTNode node)

Method Detail

getReference

public final 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 PsiElementBase

Returns:

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

See Also:

ReferencesSearch

getElement

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

resolveInner

protected abstract ResolveResult [] resolveInner()

multiResolve

public final ResolveResult [] multiResolve(boolean incompleteCode)

Description copied from interface: PsiPolyVariantReference

Returns the results of resolving the reference.

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.

resolve

public final 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)

processVariantsInner

protected boolean processVariantsInner(PsiScopeProcessor processor)

processUnqualifiedVariants

protected boolean processUnqualifiedVariants(PsiScopeProcessor processor)

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.

getQualifier

public T 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 PsiQualifiedReference

Returns:

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

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.

replaceReference

protected final AbstractQualifiedReference replaceReference(java.lang.String newText)

parseReference

protected abstract T parseReference(java.lang.String newText)

isAccessible

protected boolean isAccessible(PsiElement element)

shortenReferences

protected AbstractQualifiedReference shortenReferences()

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.

getSeparator

protected abstract PsiElement getSeparator()

getReferenceNameElement

protected abstract PsiElement getReferenceNameElement()

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

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.

isSoft

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