Package com.intellij.util.xml.converters

Class DelimitedListConverter.MyPsiReference

java.lang.Object

com.intellij.psi.PsiReferenceBase<PsiElement>

com.intellij.util.xml.converters.DelimitedListConverter.MyPsiReference

All Implemented Interfaces:

EmptyResolveMessageProvider, PsiSymbolReference, SymbolReference, PsiReference

Enclosing class:

DelimitedListConverter<T>

protected class DelimitedListConverter.MyPsiReference
extends PsiReferenceBase<PsiElement>
implements EmptyResolveMessageProvider

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.psi.PsiReferenceBase

PsiReferenceBase.Immediate<T extends PsiElement>, PsiReferenceBase.Poly<T extends PsiElement>

Field Summary

Fields

Modifier and Type	Field and Description
protected ConvertContext	myContext
protected GenericDomValue<java.util.List<T>>	myGenericDomValue

Fields inherited from class com.intellij.psi.PsiReferenceBase

myElement, mySoft

Fields inherited from interface com.intellij.psi.PsiReference

ARRAY_FACTORY, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
MyPsiReference(PsiElement element, TextRange range, ConvertContext context, GenericDomValue<java.util.List<T>> genericDomValue, boolean delimitersOnly)
MyPsiReference(PsiElement element, TextRange range, ConvertContext context, GenericDomValue<java.util.List<T>> genericDomValue, boolean soft, boolean delimitersOnly)

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	getUnresolvedMessagePattern() Returns custom unresolved message pattern.
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.
PsiElement	resolve() Returns the element which is the target of the reference.
java.lang.String	toString()

Methods inherited from class com.intellij.psi.PsiReferenceBase

calculateDefaultRangeInElement, createSelfReference, createSelfReference, getCanonicalText, getElement, getRangeInElement, getValue, isReferenceTo, isSoft, setRangeInElement

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

resolveReference, resolvesTo

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

getAbsoluteRange

Field Detail

myContext

protected final ConvertContext myContext

myGenericDomValue

protected final GenericDomValue<java.util.List<T>> myGenericDomValue

Constructor Detail

MyPsiReference

public MyPsiReference(PsiElement element,
                      TextRange range,
                      ConvertContext context,
                      GenericDomValue<java.util.List<T>> genericDomValue,
                      boolean delimitersOnly)

MyPsiReference

public MyPsiReference(PsiElement element,
                      TextRange range,
                      ConvertContext context,
                      GenericDomValue<java.util.List<T>> genericDomValue,
                      boolean soft,
                      boolean delimitersOnly)

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)

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.

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

Overrides:

handleElementRename in class PsiReferenceBase<PsiElement>

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

Overrides:

bindToElement in class PsiReferenceBase<PsiElement>

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.

toString

public java.lang.String toString()

Overrides:

toString in class PsiReferenceBase<PsiElement>

getUnresolvedMessagePattern

public java.lang.String getUnresolvedMessagePattern()

Description copied from interface: EmptyResolveMessageProvider

Returns custom unresolved message pattern. First, returned value is used as pattern in MessageFormat.format() call. If the call fails, returned value is used as is. Resulting text should have Sentence capitalization.

Specified by:

getUnresolvedMessagePattern in interface EmptyResolveMessageProvider

Returns:

pattern or message