Package com.intellij.openapi.paths

Class PsiDynaReference<T extends PsiElement>

java.lang.Object

com.intellij.psi.PsiReferenceBase<T>

com.intellij.openapi.paths.PsiDynaReference<T>

All Implemented Interfaces:

EmptyResolveMessageProvider, LocalQuickFixProvider, PsiSymbolReference, SymbolReference, FileReferenceOwner, PsiPolyVariantReference, PsiReference

public class PsiDynaReference<T extends PsiElement>
extends PsiReferenceBase<T>
implements FileReferenceOwner, PsiPolyVariantReference, LocalQuickFixProvider, 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 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
PsiDynaReference(T psiElement)

Method Summary

Modifier and Type	Method and Description
void	addReference(PsiReference reference)
void	addReferences(java.util.Collection<? extends PsiReference> references)
PsiElement	bindToElement(PsiElement element) Changes the reference so that it starts to point to the specified element.
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).
PsiFileReference	getLastFileReference()
LocalQuickFix[]	getQuickFixes()
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.util.List<PsiReference>	getReferences()
java.lang.String	getUnresolvedMessagePattern() Returns custom unresolved message pattern.
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.
protected ResolveResult[]	innerResolve(boolean incompleteCode)
boolean	isReferenceTo(PsiElement element) Checks if the reference targets the specified element.
ResolveResult []	multiResolve(boolean incompleteCode) Returns the results of resolving the reference.
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, getElement, getValue, 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.PsiPolyVariantReference

resolveReference

Methods inherited from interface com.intellij.psi.PsiReference

getElement, getVariants, isSoft, resolvesTo

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

getAbsoluteRange

Constructor Detail

PsiDynaReference

public PsiDynaReference(T psiElement)

Method Detail

addReferences

public void addReferences(java.util.Collection<? extends PsiReference> references)

getReferences

public java.util.List<PsiReference> getReferences()

addReference

public void addReference(PsiReference 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

Overrides:

getRangeInElement in class PsiReferenceBase<T extends PsiElement>

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

Overrides:

getCanonicalText in class PsiReferenceBase<T extends PsiElement>

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

Overrides:

handleElementRename in class PsiReferenceBase<T extends 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<T extends 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.

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

Overrides:

isReferenceTo in class PsiReferenceBase<T extends PsiElement>

Parameters:

element - the element to check target for.

Returns:

true if the reference targets that element, false otherwise.

multiResolve

public ResolveResult [] multiResolve(boolean incompleteCode)

Description copied from interface: PsiPolyVariantReference

Returns the results of resolving the reference.

Specified by:

multiResolve in interface PsiPolyVariantReference

Parameters:

incompleteCode - if true, the code in the context of which the reference is being resolved is considered incomplete, and the method may return additional invalid results.

Returns:

the array of results for resolving the reference.

innerResolve

protected ResolveResult[] innerResolve(boolean incompleteCode)

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

getQuickFixes

public LocalQuickFix[] getQuickFixes()

Specified by:

getQuickFixes in interface LocalQuickFixProvider

toString

public java.lang.String toString()

Overrides:

toString in class PsiReferenceBase<T extends PsiElement>

getLastFileReference

public PsiFileReference getLastFileReference()

Specified by:

getLastFileReference in interface FileReferenceOwner