Package com.intellij.xml.util

Class XmlEnumeratedValueReference

java.lang.Object

com.intellij.psi.PsiReferenceBase<XmlElement>

com.intellij.xml.util.XmlEnumeratedValueReference

All Implemented Interfaces:

EmptyResolveMessageProvider, PsiSymbolReference, SymbolReference, PsiReference, ResolvingHint

public class XmlEnumeratedValueReference
extends PsiReferenceBase<XmlElement>
implements EmptyResolveMessageProvider, ResolvingHint

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 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
XmlEnumeratedValueReference(XmlElement value, XmlEnumerationDescriptor descriptor)
XmlEnumeratedValueReference(XmlElement value, XmlEnumerationDescriptor descriptor, TextRange range)

Method Summary

Modifier and Type	Method and Description
boolean	canResolveTo(java.lang.Class<? extends PsiElement> elementClass)
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	resolve() Returns the element which is the target of the reference.

Methods inherited from class com.intellij.psi.PsiReferenceBase

bindToElement, calculateDefaultRangeInElement, createSelfReference, createSelfReference, getCanonicalText, getElement, getRangeInElement, getValue, handleElementRename, isReferenceTo, isSoft, setRangeInElement, 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

resolveReference, resolvesTo

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

getAbsoluteRange

Constructor Detail

XmlEnumeratedValueReference

public XmlEnumeratedValueReference(XmlElement value,
                                   XmlEnumerationDescriptor descriptor)

XmlEnumeratedValueReference

public XmlEnumeratedValueReference(XmlElement value,
                                   XmlEnumerationDescriptor descriptor,
                                   TextRange range)

Method Detail

canResolveTo

public boolean canResolveTo(java.lang.Class<? extends PsiElement> elementClass)

Specified by:

canResolveTo in interface ResolvingHint

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.

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