Package com.intellij.psi

Class PsiReferenceBase<T extends PsiElement>

java.lang.Object

com.intellij.psi.PsiReferenceBase<T>

All Implemented Interfaces:

PsiSymbolReference, SymbolReference, PsiReference

Direct Known Subclasses:

AntDomReferenceBase, BuildoutPartReference, CommandLineArgumentReference, CommandLineCommandReference, CommandLineOptionReference, DelimitedListConverter.MyPsiReference, DocStringParameterReference, GenericDomValueReference, JavaFxColorReference, JavaFxComponentIdReferenceProvider.JavaFxIdReferenceBase, JavaFxEventHandlerReference, JavaFxFieldIdReferenceProvider.JavaFxControllerFieldRef, JavaFxPropertyReference, JavaLangClassMemberReference, JavaLangInvokeHandleReference, JsonSchemaBaseReference, MethodSourceReference, PsiDynaReference, PsiPolyVariantReferenceBase, PsiReferenceBase.Immediate, PsiReferenceBase.Poly, PyDunderSlotsReference, PySubstitutionChunkReference, ResourceBundleReference, SchemaPrefixReference, ShFunctionReference, WebReference, XmlEnumeratedValueReference, YAMLAliasReference

public abstract class PsiReferenceBase<T extends PsiElement>
extends java.lang.Object
implements PsiReference

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PsiReferenceBase.Immediate<T extends PsiElement>
static class	PsiReferenceBase.Poly<T extends PsiElement>

Field Summary

Fields

Modifier and Type	Field and Description
protected T	myElement
protected boolean	mySoft

Fields inherited from interface com.intellij.psi.PsiReference

ARRAY_FACTORY, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
PsiReferenceBase(T element) Reference range is obtained from ElementManipulator.getRangeInElement(PsiElement).
PsiReferenceBase(T element, boolean soft) Reference range is obtained from ElementManipulator.getRangeInElement(PsiElement).
PsiReferenceBase(T element, TextRange rangeInElement)
PsiReferenceBase(T element, TextRange rangeInElement, boolean soft)

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.
protected TextRange	calculateDefaultRangeInElement()
static <T extends PsiElement> PsiReferenceBase<T>	createSelfReference(T element, PsiElement resolveTo)
static <T extends PsiElement> PsiReferenceBase<T>	createSelfReference(T element, TextRange rangeInElement, PsiElement resolveTo)
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).
T	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.
java.lang.String	getValue()
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.
void	setRangeInElement(TextRange rangeInElement)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.psi.PsiReference

getVariants, resolve, resolveReference, resolvesTo

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

getAbsoluteRange

Field Detail

myElement

protected final T extends PsiElement myElement

mySoft

protected boolean mySoft

Constructor Detail

PsiReferenceBase

public PsiReferenceBase(T element,
                        TextRange rangeInElement,
                        boolean soft)

Parameters:

element - Underlying element.

rangeInElement - Reference range relative to given element.

soft - Whether reference may fail to resolve.

PsiReferenceBase

public PsiReferenceBase(T element,
                        TextRange rangeInElement)

Parameters:

element - Underlying element.

rangeInElement - Reference range relative to given element.

PsiReferenceBase

public PsiReferenceBase(T element,
                        boolean soft)

Reference range is obtained from ElementManipulator.getRangeInElement(PsiElement).

Parameters:

element - Underlying element.

soft - Whether reference may fail to resolve.

PsiReferenceBase

public PsiReferenceBase(T element)

Reference range is obtained from ElementManipulator.getRangeInElement(PsiElement).

Parameters:

element - Underlying element.

Method Detail

setRangeInElement

public void setRangeInElement(TextRange rangeInElement)

getValue

public java.lang.String getValue()

getElement

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

calculateDefaultRangeInElement

protected TextRange calculateDefaultRangeInElement()

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.

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.

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.

createSelfReference

public static <T extends PsiElement> PsiReferenceBase<T> createSelfReference(T element,
                                                                             PsiElement resolveTo)

createSelfReference

public static <T extends PsiElement> PsiReferenceBase<T> createSelfReference(T element,
                                                                             TextRange rangeInElement,
                                                                             PsiElement resolveTo)

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.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object