Package com.intellij.psi

Class PsiReferenceRegistrar

java.lang.Object

com.intellij.psi.PsiReferenceRegistrar

All Implemented Interfaces:

UserDataHolder

Direct Known Subclasses:

PsiReferenceRegistrarImpl

public abstract class PsiReferenceRegistrar
extends java.lang.Object
implements UserDataHolder

Allows to register reference providers for specific locations.

The locations are described by ElementPatterns. If a pattern matches some PSI element, then the corresponding PsiReferenceProvider.getReferencesByElement(PsiElement, com.intellij.util.ProcessingContext) is executed, from which one can return the references whose PsiReference.getElement() is the same as the first parameter of PsiReferenceProvider.getReferencesByElement(PsiElement, com.intellij.util.ProcessingContext).

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_PRIORITY
static double	HIGHER_PRIORITY
static double	LOWER_PRIORITY

Constructor Summary

Constructors

Constructor and Description
PsiReferenceRegistrar()

Method Summary

Modifier and Type	Method and Description
<T> T	getUserData(Key<T> key)
<T> void	putUserData(Key<T> key, T value) Add a new user data value to this object.
void	registerReferenceProvider(ElementPattern<? extends PsiElement> pattern, PsiReferenceProvider provider) Register reference provider with default priority (DEFAULT_PRIORITY).
abstract <T extends PsiElement> void	registerReferenceProvider(ElementPattern<T> pattern, PsiReferenceProvider provider, double priority) Register reference provider with custom priority.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PRIORITY

public static final double DEFAULT_PRIORITY

See Also:

Constant Field Values

HIGHER_PRIORITY

public static final double HIGHER_PRIORITY

See Also:

Constant Field Values

LOWER_PRIORITY

public static final double LOWER_PRIORITY

See Also:

Constant Field Values

Constructor Detail

PsiReferenceRegistrar

public PsiReferenceRegistrar()

Method Detail

registerReferenceProvider

public void registerReferenceProvider(ElementPattern<? extends PsiElement> pattern,
                                      PsiReferenceProvider provider)

Register reference provider with default priority (DEFAULT_PRIORITY).

Parameters:

pattern - reference place description. See StandardPatterns, PlatformPatterns and their extenders.

provider - provider to be registered

registerReferenceProvider

public abstract <T extends PsiElement> void registerReferenceProvider(ElementPattern<T> pattern,
                                                                      PsiReferenceProvider provider,
                                                                      double priority)

Register reference provider with custom priority.

Parameters:

pattern - reference place description. See StandardPatterns, PlatformPatterns and their extenders.

provider - provider to be registered

priority - see #DEFAULT_PRIORITY), {@link #HIGHER_PRIORITY}, {@link #LOWER_PRIORITY}

getUserData

public <T> T getUserData(Key<T> key)

Specified by:

getUserData in interface UserDataHolder

Returns:

a user data value associated with this object. Doesn't require read action.

putUserData

public <T> void putUserData(Key<T> key,
                            T value)

Description copied from interface: UserDataHolder

Add a new user data value to this object. Doesn't require write action.

Specified by:

putUserData in interface UserDataHolder