Package com.intellij.util.xml

Class ResolvingConverter<T>

java.lang.Object

com.intellij.util.xml.Converter<T>

com.intellij.util.xml.ResolvingConverter<T>

All Implemented Interfaces:

ResolvingHint

Direct Known Subclasses:

AbstractMemberResolveConverter, AbstractMethodResolveConverter, BooleanValueConverter, DelimitedListConverter, DomResolveConverter, EnumConverter, NumberValueConverter, QuotedValueConverter, ResolvingConverter.StringConverter, ResolvingConverter.WrappedResolvingConverter

public abstract class ResolvingConverter<T>
extends Converter<T>
implements ResolvingHint

If converter extends this class, the corresponding XML PsiReference will take completion variants from getVariants(ConvertContext) method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResolvingConverter.StringConverter Adds getVariants(ConvertContext) functionality to a simple String value.
static class	ResolvingConverter.WrappedResolvingConverter<T> Adds getVariants(ConvertContext) functionality to an existing converter.

Field Summary

Fields

Modifier and Type	Field and Description
static Converter<java.lang.Boolean>	BOOLEAN_CONVERTER Deprecated. see BooleanValueConverter
static ResolvingConverter	EMPTY_CONVERTER Deprecated. unnecessary

Fields inherited from class com.intellij.util.xml.Converter

INTEGER_CONVERTER

Constructor Summary

Constructors

Constructor and Description
ResolvingConverter()

Method Summary

Modifier and Type	Method and Description
void	bindReference(GenericDomValue<T> genericValue, ConvertContext context, PsiElement newTarget) Delegate from PsiReference.bindToElement(com.intellij.psi.PsiElement)
boolean	canResolveTo(java.lang.Class<? extends PsiElement> elementClass)
LookupElement	createLookupElement(T t) Override to provide custom lookup elements in completion.
java.util.Set<java.lang.String>	getAdditionalVariants() Deprecated. implement getAdditionalVariants(ConvertContext)
java.util.Set<java.lang.String>	getAdditionalVariants(ConvertContext context)
java.lang.String	getErrorMessage(java.lang.String s, ConvertContext context)
PsiElement	getPsiElement(T resolvedValue)
LocalQuickFix[]	getQuickFixes(ConvertContext context)
abstract java.util.Collection<? extends T>	getVariants(ConvertContext context)
void	handleElementRename(GenericDomValue<T> genericValue, ConvertContext context, java.lang.String newElementName) Delegate from PsiReference.handleElementRename(String)
boolean	isReferenceTo(PsiElement element, java.lang.String stringValue, T resolveResult, ConvertContext context) Delegate from PsiReference.isReferenceTo(com.intellij.psi.PsiElement)
PsiElement	resolve(T o, ConvertContext context) Delegate from PsiReference.resolve()

Methods inherited from class com.intellij.util.xml.Converter

fromString, toString

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_CONVERTER

@Deprecated
public static final ResolvingConverter EMPTY_CONVERTER

Deprecated. unnecessary

BOOLEAN_CONVERTER

@Deprecated
public static final Converter<java.lang.Boolean> BOOLEAN_CONVERTER

Deprecated. see BooleanValueConverter

Constructor Detail

ResolvingConverter

public ResolvingConverter()

Method Detail

getErrorMessage

public java.lang.String getErrorMessage(java.lang.String s,
                                        ConvertContext context)

Overrides:

getErrorMessage in class Converter<T>

Parameters:

s - string value that couldn't be resolved

context - context

Returns:

error message used to highlight the errors somewhere in the UI, most often - like unresolved references in XML

getVariants

public abstract java.util.Collection<? extends T> getVariants(ConvertContext context)

Parameters:

context - context

Returns:

reference completion variants

getAdditionalVariants

@Deprecated
public java.util.Set<java.lang.String> getAdditionalVariants()

Deprecated. implement getAdditionalVariants(ConvertContext)

Returns:

additional reference variants. They won't resolve to anywhere, but won't be highlighted as errors. They will also appear in the completion dropdown.

getAdditionalVariants

public java.util.Set<java.lang.String> getAdditionalVariants(ConvertContext context)

Returns:

additional reference variants. They won't resolve to anywhere, but won't be highlighted as errors. They will also appear in the completion dropdown.

handleElementRename

public void handleElementRename(GenericDomValue<T> genericValue,
                                ConvertContext context,
                                java.lang.String newElementName)

Delegate from PsiReference.handleElementRename(String)

Parameters:

genericValue - generic value

context - context

newElementName - new element name

bindReference

public void bindReference(GenericDomValue<T> genericValue,
                          ConvertContext context,
                          PsiElement newTarget)

Delegate from PsiReference.bindToElement(com.intellij.psi.PsiElement)

Parameters:

genericValue - generic value

context - context

newTarget - new target

getPsiElement

public PsiElement getPsiElement(T resolvedValue)

Parameters:

resolvedValue - Converter.fromString(String, ConvertContext) result

Returns:

the PSI element to which the PsiReference will resolve

isReferenceTo

public boolean isReferenceTo(PsiElement element,
                             java.lang.String stringValue,
                             T resolveResult,
                             ConvertContext context)

Delegate from PsiReference.isReferenceTo(com.intellij.psi.PsiElement)

Parameters:

element - element

stringValue - string value

resolveResult - resolve result

context - context

Returns:

is reference to?

canResolveTo

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

Specified by:

canResolveTo in interface ResolvingHint

resolve

public PsiElement resolve(T o,
                          ConvertContext context)

Delegate from PsiReference.resolve()

Parameters:

o - Converter.fromString(String, ConvertContext) result

context - context

Returns:

PSI element to resolve to. By default calls getPsiElement(Object) method

getQuickFixes

public LocalQuickFix[] getQuickFixes(ConvertContext context)

Parameters:

context - context

Returns:

LocalQuickFix'es to correct non-resolved value (e.g. 'create from usage')

createLookupElement

public LookupElement createLookupElement(T t)

Override to provide custom lookup elements in completion.

Default is null which will create lookup via ElementPresentationManager.createVariant(java.lang.Object, java.lang.String, com.intellij.psi.PsiElement).

Parameters:

t - DOM to create lookup element for.

Returns:

Lookup element.