Package com.intellij.psi.impl.light

Class LightPackageReference

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.PsiElementBase

com.intellij.psi.impl.light.LightElement

com.intellij.psi.impl.light.LightPackageReference

All Implemented Interfaces:

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

Direct Known Subclasses:

LightPackageReferenceExpression

public class LightPackageReference
extends LightElement
implements PsiJavaCodeReferenceElement

Nested Class Summary

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.light.LightElement

myManager

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

FLAGS_LOCKED, ICON_PLACEHOLDER

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

EMPTY_NAVIGATABLE_ELEMENT_ARRAY

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Constructor Summary

Constructors

Constructor and Description
LightPackageReference(PsiManager manager, PsiPackage refPackage)
LightPackageReference(PsiManager manager, java.lang.String packageName)

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	copy() Creates a copy of the file containing the PSI element and returns the corresponding element in the created copy.
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.
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).
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.
java.lang.String	getText() Returns the text of the PSI element.
PsiType []	getTypeParameters() Returns the array of types for the type arguments specified on the reference.
java.lang.Object []	getVariants() Returns the array of String, PsiElement and/or LookupElement instances representing all identifiers that are visible at the location of 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.
boolean	isValid() Checks if this PSI element is valid.
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.
java.lang.String	toString() toString() should never be presented to the user.

Methods inherited from class com.intellij.psi.impl.light.LightElement

add, addAfter, addBefore, checkAdd, checkDelete, delete, findElementAt, getChildren, getContainingFile, getLanguage, getManager, getNavigationElement, getNextSibling, getNode, getParent, getPrevSibling, getStartOffsetInParent, getTextLength, getTextOffset, getTextRange, isPhysical, isWritable, replace, setNavigationElement, textMatches, textMatches, textToCharArray

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

acceptChildren, addRange, addRangeAfter, addRangeBefore, canNavigate, canNavigateToSource, deleteChildRange, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getContext, getFirstChild, getLastChild, getName, getOriginalElement, getPresentation, getProject, getReferences, getResolveScope, getUseScope, isEquivalentTo, navigate, notNullChild, processDeclarations, textContains

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, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, 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

acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, delete, deleteChildRange, findElementAt, findReferenceAt, getChildren, getContainingFile, getContext, getCopyableUserData, getFirstChild, getLanguage, getLastChild, getManager, getNavigationElement, getNextSibling, getNode, getOriginalElement, getOwnReferences, getParent, getPrevSibling, getProject, getReferences, getResolveScope, getStartOffsetInParent, getTextLength, getTextOffset, getTextRange, getTextRangeInParent, getUseScope, isEquivalentTo, isPhysical, 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

resolvesTo

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

getAbsoluteRange

Constructor Detail

LightPackageReference

public LightPackageReference(PsiManager manager,
                             PsiPackage refPackage)

LightPackageReference

public LightPackageReference(PsiManager manager,
                             java.lang.String packageName)

Method Detail

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)

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.

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.

getText

public java.lang.String getText()

Description copied from interface: PsiElement

Returns the text of the PSI element.

Note: This call requires traversing whole subtree, so it can be expensive for composite elements, and should be avoided if possible.

Specified by:

getText in interface PsiElement

Overrides:

getText in class LightElement

Returns:

the element text.

See Also:

PsiElement.textMatches(java.lang.CharSequence), PsiElement.textContains(char)

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 PsiElementBase

Returns:

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

See Also:

ReferencesSearch

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.

copy

public PsiElement copy()

Description copied from interface: PsiElement

Creates a copy of the file containing the PSI element and returns the corresponding element in the created copy. Resolve operations performed on elements in the copy of the file will resolve to elements in the copy, not in the original file.

Specified by:

copy in interface PsiElement

Overrides:

copy in class LightElement

Returns:

the element in the file copy corresponding to this 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.

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 LightElement

Parameters:

visitor - the visitor to pass the element to.

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

Specified by:

toString in class LightElement

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.

getVariants

public java.lang.Object [] getVariants()

Description copied from interface: PsiReference

Returns the array of String, PsiElement and/or LookupElement instances representing all identifiers that are visible at the location of the reference. The contents of the returned array is used to build the lookup list for basic code completion. (The list of visible identifiers may not be filtered by the completion prefix string - the filtering is performed later by the IDE.)

This method is default since 2018.3.

Specified by:

getVariants in interface PsiReference

Returns:

the array of available identifiers.

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

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

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.

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.

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

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.

isValid

public boolean isValid()

Description copied from interface: PsiElement

Checks if this PSI element is valid. Valid elements and their hierarchy members can be accessed for reading and writing. Valid elements can still correspond to underlying documents whose text is different, when those documents have been changed and not yet committed (PsiDocumentManager.commitDocument(com.intellij.openapi.editor.Document)). (In this case an attempt to change PSI will result in an exception). Any access to invalid elements results in PsiInvalidElementAccessException. Once invalid, elements can't become valid again. Elements become invalid in following cases:

• They have been deleted via PSI operation (PsiElement.delete())
• They have been deleted as a result of an incremental reparse (document commit)
• Their containing file has been changed externally, or renamed so that its PSI had to be rebuilt from scratch

Specified by:

isValid in interface PsiElement

Overrides:

isValid in class LightElement

Returns:

true if the element is valid, false otherwise.

See Also:

PsiUtilCore.ensureValid(PsiElement)

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.

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 PsiQualifiedReference

Returns:

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

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 PsiJavaCodeReferenceElement

Returns:

true if the reference is qualified, false otherwise.