Package com.intellij.psi

Interface SmartPsiElementPointer<E extends PsiElement>

All Superinterfaces:

Pointer<E>

All Known Subinterfaces:

SmartPointerEx<E>, SmartPsiFileRange

public interface SmartPsiElementPointer<E extends PsiElement>
extends Pointer<E>

A pointer to a PSI element which can survive PSI reparse.

See Also:

SmartPointerManager.createSmartPsiElementPointer(PsiElement)

Method Summary

Modifier and Type	Method and Description
default E	dereference()
PsiFile	getContainingFile()
E	getElement() Returns the PSI element corresponding to the one from which the smart pointer was created in the current state of the PSI file.
Project	getProject()
Segment	getPsiRange()
Segment	getRange()
VirtualFile	getVirtualFile()

Methods inherited from interface com.intellij.model.Pointer

equals, hardPointer, hashCode

Method Detail

getElement

E getElement()

Returns the PSI element corresponding to the one from which the smart pointer was created in the current state of the PSI file.

Returns:

the PSI element, or null if the PSI reparse has completely invalidated the pointer (for example, the element referenced by the pointer has been deleted).

dereference

default E dereference()

Specified by:

dereference in interface Pointer<E extends PsiElement>

Returns:

value or null if the value was invalidated or cannot be restored

getContainingFile

PsiFile getContainingFile()

getProject

Project getProject()

getVirtualFile

VirtualFile getVirtualFile()

getRange

Segment getRange()

Returns:

the range in the document. For committed document, it's the same as getPsiRange(), for non-committed documents the ranges may be changed (like in RangeMarker) or even invalidated. In the latter case returns null. Returns null for invalid pointers.

getPsiRange

Segment getPsiRange()

Returns:

the range in the committed PSI file. May be different from getRange() result when the document has been changed since commit. Returns null for invalid pointers.