Package com.intellij.psi

Class PsiReferenceWrapper

java.lang.Object

com.intellij.psi.PsiReferenceWrapper

All Implemented Interfaces:

PsiSymbolReference, SymbolReference, PsiReference

public class PsiReferenceWrapper
extends java.lang.Object
implements PsiReference

Field Summary

Fields inherited from interface com.intellij.psi.PsiReference

ARRAY_FACTORY, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
PsiReferenceWrapper(PsiReference originalPsiReference)

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.
<T extends PsiReference> T	cast(java.lang.Class<T> clazz)
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.
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.
<T extends PsiReference> boolean	isInstance(java.lang.Class<T> clazz)
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.psi.PsiReference

resolveReference, resolvesTo

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

getAbsoluteRange

Constructor Detail

PsiReferenceWrapper

public PsiReferenceWrapper(PsiReference originalPsiReference)

Method Detail

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.

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

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)

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.

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.

isInstance

public <T extends PsiReference> boolean isInstance(java.lang.Class<T> clazz)

cast

public <T extends PsiReference> T cast(java.lang.Class<T> clazz)