Package com.intellij.psi

Class SmartPointerManager

java.lang.Object

com.intellij.psi.SmartPointerManager

Direct Known Subclasses:

SmartPointerManagerImpl

public abstract class SmartPointerManager
extends java.lang.Object

Allows to create references to PSI elements that can survive a reparse and return the corresponding element in the PSI tree after the reparse.

Constructor Summary

Constructors

Constructor and Description
SmartPointerManager()

Method Summary

Modifier and Type	Method and Description
<E extends PsiElement> SmartPsiElementPointer<E>	createLazyPointer(E element) Deprecated. use createSmartPsiElementPointer(PsiElement) instead
static <E extends PsiElement> SmartPsiElementPointer<E>	createPointer(E element) Creates a smart pointer to the specified PSI element using a manager that corresponds to the element's project.
abstract <E extends PsiElement> SmartPsiElementPointer<E>	createSmartPsiElementPointer(E element) Creates a smart pointer to the specified PSI element.
abstract <E extends PsiElement> SmartPsiElementPointer<E>	createSmartPsiElementPointer(E element, PsiFile containingFile) Creates a smart pointer to the specified PSI element.
abstract SmartPsiFileRange	createSmartPsiFileRangePointer(PsiFile file, TextRange range)
static SmartPointerManager	getInstance(Project project)
abstract boolean	pointToTheSameElement(SmartPsiElementPointer<?> pointer1, SmartPsiElementPointer<?> pointer2) This method is cheaper than dereferencing both pointers and comparing the result.
abstract void	removePointer(SmartPsiElementPointer<?> pointer) Disposes a smart pointer and frees the resources associated with it.

Methods inherited from class java.lang.Object

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

Constructor Detail

SmartPointerManager

public SmartPointerManager()

Method Detail

createSmartPsiFileRangePointer

public abstract SmartPsiFileRange createSmartPsiFileRangePointer(PsiFile file,
                                                                 TextRange range)

getInstance

public static SmartPointerManager getInstance(Project project)

createPointer

public static <E extends PsiElement> SmartPsiElementPointer<E> createPointer(E element)

Creates a smart pointer to the specified PSI element using a manager that corresponds to the element's project.

Type Parameters:

E - the specific type of the given element

Parameters:

element - the element to create a pointer to

Returns:

a pointer to the specified element which can survive PSI reparse

See Also:

createSmartPsiElementPointer(PsiElement)

createSmartPsiElementPointer

public abstract <E extends PsiElement> SmartPsiElementPointer<E> createSmartPsiElementPointer(E element)

Creates a smart pointer to the specified PSI element. If the element's containing file is known, it's more preferable to use createSmartPsiElementPointer(PsiElement, PsiFile).

Parameters:

element - the element to create a pointer to.

Returns:

the smart pointer instance.

createSmartPsiElementPointer

public abstract <E extends PsiElement> SmartPsiElementPointer<E> createSmartPsiElementPointer(E element,
                                                                                              PsiFile containingFile)

Creates a smart pointer to the specified PSI element.

Parameters:

element - the element to create a pointer to.

containingFile - the result of element.getContainingFile().

Returns:

the smart pointer instance.

createLazyPointer

@Deprecated
public <E extends PsiElement> SmartPsiElementPointer<E> createLazyPointer(E element)

Deprecated. use createSmartPsiElementPointer(PsiElement) instead

Creates a smart pointer to the specified PSI element which doesn't hold a strong reference to the PSI element.

Parameters:

element - the element to create a pointer to.

Returns:

the smart pointer instance.

pointToTheSameElement

public abstract boolean pointToTheSameElement(SmartPsiElementPointer<?> pointer1,
                                              SmartPsiElementPointer<?> pointer2)

This method is cheaper than dereferencing both pointers and comparing the result.

Parameters:

pointer1 - smart pointer to compare

pointer2 - smart pointer to compare

Returns:

true if both pointers point to the same PSI element.

removePointer

public abstract void removePointer(SmartPsiElementPointer<?> pointer)

Disposes a smart pointer and frees the resources associated with it. Calling this method is not obligatory: pointers are freed correctly when they're not used anymore. But disposing the pointers explicitly might be beneficial for performance.