Package com.intellij.model

Interface 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, PsiReference, PsiReferenceEx, PsiReferenceExpression, PsiSymbolReference, 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, SingleResultReference, SingleTargetReference, SPIClassProviderReferenceElement, SPIPackageOrClassReferenceElement, TagNameReference, TargetEvaluatorAwareReference, TypeOrElementOrAttributeReference, URLReference, WeakFileReference, WebReference, XmlAttributeReference, XmlEncodingReference, XmlEnumeratedValueReference, XmlValueReference, XPathVariableReferenceImpl, XsltReferenceContributor.SchemaTypeReference, YAMLAliasReference

public interface SymbolReference

A reference to a Symbol or possibly several Symbols.

SymbolReference may be backed by a PsiElement but is not required to.

Examples:

• the variable name used in an expression is a SymbolReference backed by a PsiElement which represent the expression
• fully qualified name of a class in Application or Test Run Configuration is a SymbolReference which is not backed by a PsiElement, but may be searched for and/or renamed

See Also:

com.intellij.model, PsiSymbolReference

Method Summary

Modifier and Type	Method and Description
java.util.Collection<? extends SymbolResolveResult>	resolveReference()
default boolean	resolvesTo(Symbol target) Default implementation checks results from resolveReference().

Method Detail

resolveReference

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

Returns:

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

resolvesTo

default boolean resolvesTo(Symbol target)

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

Returns:

whether this reference resolves to a target