Package com.intellij.psi

Interface PsiReference

All Superinterfaces:

PsiSymbolReference, SymbolReference

All Known Subinterfaces:

BindablePsiReference, FragmentaryPsiReference, GrArgumentLabel, GrCodeReferenceElement, GrDocFieldReference, GrDocMemberReference, GrDocMethodReference, GrDocParameterReference, GroovyDependentReference, GroovyReference, GrQualifiedReference<Qualifier>, GrReferenceElement<Q>, GrReferenceExpression, MultiRangeReference, PossiblePrefixReference, PrefixReference, PsiAnnotatedJavaCodeReferenceElement, PsiCallReference, PsiFileReference, PsiImportStaticReferenceElement, PsiJavaCodeReferenceElement, PsiJavaModuleReference, PsiJavaReference, PsiMethodReferenceExpression, PsiPolyVariantReference, PsiQualifiedReference, PsiQualifiedReferenceElement, PsiReferenceEx, PsiReferenceExpression, XPathVariableReference

All Known Implementing Classes:

AbstractQualifiedReference, AnchorReferenceImpl, AntDomFileReference, AntDomMacrodefAttributeReference, AntDomPropertyReference, AntDomReferenceBase, AttributeValueSelfReference, BaseReference, BasicAttributeValueReference, BuildoutPartReference, CachingReference, ClsJavaCodeReferenceElementImpl, ClsReferenceExpressionImpl, CommandLineArgumentReference, CommandLineCommandReference, CommandLineOptionReference, DefinitionReference, DelimitedListConverter.MyPsiReference, DependentNSReference, DocStringParameterReference, DocStringTypeReference, EncodingReference, FieldFormReference, FileReference, FileReferenceWithOneContext, FormEnumConstantReference, FormPackageReference, GenericDomValueReference, GenericReference, GrArgumentLabelImpl, GrCodeReferenceElementImpl, GrDocFieldReferenceImpl, GrDocMemberReferenceImpl, GrDocMethodReferenceImpl, GrDocParameterReferenceImpl, GrLabelReference, GrLightClassReferenceElement, GrReferenceElementImpl, GrReferenceExpressionImpl, IdReferenceProvider.GlobalAttributeValueSelfReference, IdRefReference, JavaClassReference, JavaFxColorReference, JavaFxComponentIdReferenceProvider.JavaFxIdReferenceBase, JavaFxEventHandlerReference, JavaFxFieldIdReferenceProvider.JavaFxControllerFieldRef, JavaFxPropertyReference, JavaFxStaticPropertyReference, JavaFxTagNameReference, JavaLangClassMemberReference, JavaLangInvokeHandleReference, JsonPointerReferenceProvider.JsonSchemaIdReference, JsonPropertyNameReference, JsonSchemaBaseReference, LightClassReference, LightClassReferenceExpression, LightClassTypeReference, LightMemberReference, LightPackageReference, LightPackageReferenceExpression, MethodPropertyReference, MethodSourceReference, NamedArgumentReference, PrefixBasedPropertyReference, PrefixReference, PropertyReference, PropertyReferenceBase, PsiDelegateReference, PsiDocMethodOrFieldRef.MyReference, PsiDynaReference, PsiImportStaticReferenceElementImpl, PsiJavaCodeReferenceElementImpl, PsiJavaModuleReferenceImpl, PsiLabelReference, PsiMethodReferenceExpressionImpl, PsiMultiReference, PsiPackageReference, PsiPolyVariantCachingReference, PsiPolyVariantReferenceBase, PsiReferenceBase, PsiReferenceBase.Immediate, PsiReferenceBase.Poly, PsiReferenceExpressionImpl, PsiReferenceWrapper, PydevConsoleReference, PyDocReference, PyDunderAllReference, PyDunderSlotsReference, PyFromImportNameReference, PyFromImportSourceReference, PyImportReference, PyKeywordArgumentReference, PyOperatorReference, PyQualifiedReference, PyReferenceImpl, PyStringLiteralReference, PySubstitutionChunkReference, PyTargetReference, QuotedValueConverter.MyPsiReference, ReferenceBase, ReferenceInForm, ResourceBundleFileReference, ResourceBundleKeyReference, ResourceBundleReference, ResourceFileReference, RncNameImpl, SchemaPrefixReference, SchemaReferencesProvider.NameReference, ShFunctionReference, SPIClassProviderReferenceElement, SPIPackageOrClassReferenceElement, TagNameReference, TypeOrElementOrAttributeReference, URLReference, WeakFileReference, WebReference, XmlAttributeReference, XmlEncodingReference, XmlEnumeratedValueReference, XmlValueReference, XPathVariableReferenceImpl, XsltReferenceContributor.SchemaTypeReference, YAMLAliasReference

public interface PsiReference
extends PsiSymbolReference

A reference to a PSI element. For example, the variable name used in an expression. The "Go to Declaration" action can be used to go from a reference to the element it references.

Generally returned from PsiElement.getReferences() and PsiReferenceService.getReferences(com.intellij.psi.PsiElement, com.intellij.psi.PsiReferenceService.Hints), but may be contributed to some elements by third party plugins via PsiReferenceContributor.

See Also:

PsiPolyVariantReference, PsiElement.getReference(), PsiElement.getReferences(), PsiReferenceService.getReferences(PsiElement, PsiReferenceService.Hints), PsiReferenceBase, PsiReferenceContributor

Field Summary

Fields

Modifier and Type	Field and Description
static ArrayFactory<PsiReference>	ARRAY_FACTORY
static PsiReference[]	EMPTY_ARRAY

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.
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.
default 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	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.
PsiElement	resolve() Returns the element which is the target of the reference.
default java.util.Collection<? extends SymbolResolveResult>	resolveReference()
default boolean	resolvesTo(Symbol target) Default implementation checks results from SymbolReference.resolveReference().

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

getAbsoluteRange

Field Detail

EMPTY_ARRAY

static final PsiReference[] EMPTY_ARRAY

ARRAY_FACTORY

static final ArrayFactory<PsiReference> ARRAY_FACTORY

Method Detail

getElement

PsiElement getElement()

Returns the underlying (referencing) element of the reference.

Specified by:

getElement in interface PsiSymbolReference

Returns:

the underlying element of the reference.

getRangeInElement

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.

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

Returns:

Relative range in element

resolve

PsiElement resolve()

Returns the element which is the target of the reference.

Returns:

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

See Also:

PsiPolyVariantReference.multiResolve(boolean)

getCanonicalText

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

Returns:

the canonical text of the reference.

handleElementRename

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

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

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

PsiElement bindToElement(PsiElement element)
                  throws IncorrectOperationException

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.

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.

isReferenceTo

boolean isReferenceTo(PsiElement element)

Checks if the reference targets the specified element.

Parameters:

element - the element to check target for.

Returns:

true if the reference targets that element, false otherwise.

getVariants

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

Returns:

the array of available identifiers.

isSoft

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. For example, a text in an XML file which looks like a full-qualified Java class name is a soft reference.

Returns:

true if the reference is soft, false otherwise.

resolveReference

default java.util.Collection<? extends SymbolResolveResult> resolveReference()

Specified by:

resolveReference in interface SymbolReference

Returns:

collection of referenced symbols with additional data, or empty collection if there are no targets

resolvesTo

default boolean resolvesTo(Symbol target)

Description copied from interface: SymbolReference

Default implementation checks results from SymbolReference.resolveReference(). Override this method to skip actual resolution if this reference cannot ever resolve to this target.

Specified by:

resolvesTo in interface SymbolReference

Returns:

whether this reference resolves to a target