Package com.intellij.psi.impl.light

Class LightElement

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.PsiElementBase

com.intellij.psi.impl.light.LightElement

All Implemented Interfaces:

NavigationItem, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, NavigatablePsiElement, PsiElement, java.lang.Cloneable

Direct Known Subclasses:

AbstractLightClass, GrDynamicMethodImpl, GrDynamicPropertyImpl, GrLightAnnotation, GrLightClassReferenceElement, GrLightIdentifier, GrLightMethodBuilder, GrLightModifierList, GrLightParameterListBuilder, GrLightTypeDefinitionBase, GrLightTypeElement, GrLightTypeParameterList, GrSyntheticCodeBlock, GrSyntheticExpression, GrSyntheticReferenceList, GrSyntheticTypeElement, ImplicitModeElement, IncludedXmlElement, LightClassReference, LightClassTypeReference, LightEmptyImplementsList, LightField, LightIdentifier, LightJavaModule, LightJavaToken, LightKeyword, LightMemberReference, LightMethod, LightMethodBuilder, LightModifierList, LightNamedElement, LightPackageReference, LightParameterListBuilder, LightParameterListWrapper, LightParameterWrapper, LightPsiClassBase, LightReferenceList, LightReferenceListBuilder, LightReferenceParameterList, LightTypeElement, LightTypeParameterListBuilder, LightVariableBase, LightVariableBuilder, MigrationClassImpl, PropertyForRename, PyImportedModule, XsltApplyTemplatesImpl, XsltCallTemplateImpl, XsltFunctionImpl, XsltStylesheetImpl, XsltTemplateImpl, XsltVariableImpl, XsltWithParamImpl

public abstract class LightElement
extends PsiElementBase

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.util.Iconable

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields

Modifier and Type	Field and Description
protected PsiManager	myManager

Fields inherited from class com.intellij.psi.impl.ElementBase

FLAGS_LOCKED, ICON_PLACEHOLDER

Fields inherited from interface com.intellij.psi.NavigatablePsiElement

EMPTY_NAVIGATABLE_ELEMENT_ARRAY

Fields inherited from interface com.intellij.psi.PsiElement

ARRAY_FACTORY, EMPTY_ARRAY

Fields inherited from interface com.intellij.openapi.util.Iconable

ICON_FLAG_IGNORE_MASK, ICON_FLAG_OPEN, ICON_FLAG_READ_STATUS, ICON_FLAG_VISIBILITY

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LightElement(PsiManager manager, Language language)

Method Summary

Modifier and Type	Method and Description
void	accept(PsiElementVisitor visitor) Passes the element to the specified visitor.
PsiElement	add(PsiElement element) Adds a child to this PSI element.
PsiElement	addAfter(PsiElement element, PsiElement anchor) Adds a child to this PSI element, after the specified anchor element.
PsiElement	addBefore(PsiElement element, PsiElement anchor) Adds a child to this PSI element, before the specified anchor element.
void	checkAdd(PsiElement element) Checks if it is possible to add the specified element as a child to this element, and throws an exception if the add is not possible.
void	checkDelete() Checks if it is possible to delete the specified element from the tree, and throws an exception if the add is not possible.
PsiElement	copy() Creates a copy of the file containing the PSI element and returns the corresponding element in the created copy.
void	delete() Deletes this PSI element from the tree.
PsiElement	findElementAt(int offset) Finds a leaf PSI element at the specified offset from the start of the text range of this node.
PsiElement []	getChildren() Returns the array of children for the PSI element.
PsiFile	getContainingFile() Returns the file containing the PSI element.
Language	getLanguage() Returns the language of the PSI element.
PsiManager	getManager() Returns the PSI manager for the project to which the PSI element belongs.
PsiElement	getNavigationElement() Returns the PSI element which should be used as a navigation target when navigation to this PSI element is requested.
PsiElement	getNextSibling() Returns the next sibling of the PSI element.
ASTNode	getNode() Returns the AST node corresponding to the element.
PsiElement	getParent() Returns the parent of the PSI element.
PsiElement	getPrevSibling() Returns the previous sibling of the PSI element.
int	getStartOffsetInParent() Returns the text offset of the PSI element relative to its parent.
java.lang.String	getText() Returns the text of the PSI element.
int	getTextLength() Returns the length of text of the PSI element.
int	getTextOffset() Returns the offset in the file to which the caret should be placed when performing the navigation to the element.
TextRange	getTextRange() Returns the text range in the document occupied by the PSI element.
boolean	isPhysical() Checks if an actual source or class file corresponds to the element.
boolean	isValid() Checks if this PSI element is valid.
boolean	isWritable() Checks if the contents of the element can be modified (if it belongs to a non-read-only source file.)
PsiElement	replace(PsiElement newElement) Replaces this PSI element (along with all its children) with another element (along with the children).
void	setNavigationElement(PsiElement navigationElement)
boolean	textMatches(java.lang.CharSequence text) Checks if the text of this PSI element is equal to the specified character sequence.
boolean	textMatches(PsiElement element) Checks if the text of this PSI element is equal to the text of the specified PSI element.
char []	textToCharArray() Returns the text of the PSI element as a character array.
abstract java.lang.String	toString() toString() should never be presented to the user.

Methods inherited from class com.intellij.psi.impl.PsiElementBase

acceptChildren, addRange, addRangeAfter, addRangeBefore, canNavigate, canNavigateToSource, deleteChildRange, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getContext, getFirstChild, getLastChild, getName, getOriginalElement, getPresentation, getProject, getReference, getReferences, getResolveScope, getUseScope, isEquivalentTo, navigate, notNullChild, processDeclarations, textContains

Methods inherited from class com.intellij.psi.impl.ElementBase

buildRowIcon, computeBaseIcon, createLayeredIcon, getAdjustedBaseIcon, getBaseIcon, getElementIcon, getIcon, iconWithVisibilityIfNeeded, isNativeFileType, isVisibilitySupported, overlayIcons, registerIconLayer, transformFlags

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.psi.PsiElement

getCopyableUserData, getOwnReferences, getTextRangeInParent, putCopyableUserData

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Methods inherited from interface com.intellij.openapi.util.Iconable

getIcon

Field Detail

myManager

protected final PsiManager myManager

Constructor Detail

LightElement

protected LightElement(PsiManager manager,
                       Language language)

Method Detail

getLanguage

public Language getLanguage()

Description copied from interface: PsiElement

Returns the language of the PSI element.

Returns:

the language instance.

getManager

public PsiManager getManager()

Description copied from interface: PsiElement

Returns the PSI manager for the project to which the PSI element belongs.

Specified by:

getManager in interface PsiElement

Overrides:

getManager in class PsiElementBase

Returns:

the PSI manager instance.

getParent

public PsiElement getParent()

Description copied from interface: PsiElement

Returns the parent of the PSI element.

Returns:

the parent of the element, or null if the element has no parent.

getChildren

public PsiElement [] getChildren()

Description copied from interface: PsiElement

Returns the array of children for the PSI element. Important: In some implementations children are only composite elements, i.e. not a leaf elements

Returns:

the array of child elements.

getContainingFile

public PsiFile getContainingFile()

Description copied from interface: PsiElement

Returns the file containing the PSI element.

Note: this method might need to traverse the whole AST up, which can be slow in deep trees, so invoking this method should be avoided if possible.

Specified by:

getContainingFile in interface PsiElement

Overrides:

getContainingFile in class PsiElementBase

Returns:

the file instance, or null if the PSI element is not contained in a file (for example, the element represents a package or directory).

getTextRange

public TextRange getTextRange()

Description copied from interface: PsiElement

Returns the text range in the document occupied by the PSI element.

Note: it works in O(tree_depth) time, which can be slow in deep trees, so invoking this method should be avoided if possible.

Returns:

the text range.

getStartOffsetInParent

public int getStartOffsetInParent()

Description copied from interface: PsiElement

Returns the text offset of the PSI element relative to its parent.

Returns:

the relative offset.

getTextLength

public final int getTextLength()

Description copied from interface: PsiElement

Returns the length of text of the PSI element.

Returns:

the text length.

textToCharArray

public char [] textToCharArray()

Description copied from interface: PsiElement

Returns the text of the PSI element as a character array.

Returns:

the element text as a character array.

textMatches

public boolean textMatches(java.lang.CharSequence text)

Description copied from interface: PsiElement

Checks if the text of this PSI element is equal to the specified character sequence.

Specified by:

textMatches in interface PsiElement

Overrides:

textMatches in class PsiElementBase

Parameters:

text - the character sequence to compare with.

Returns:

true if the text is equal, false otherwise.

textMatches

public boolean textMatches(PsiElement element)

Description copied from interface: PsiElement

Checks if the text of this PSI element is equal to the text of the specified PSI element.

Specified by:

textMatches in interface PsiElement

Overrides:

textMatches in class PsiElementBase

Parameters:

element - the element to compare the text with.

Returns:

true if the text is equal, false otherwise.

findElementAt

public PsiElement findElementAt(int offset)

Description copied from interface: PsiElement

Finds a leaf PSI element at the specified offset from the start of the text range of this node.

Parameters:

offset - the relative offset for which the PSI element is requested.

Returns:

the element at the offset, or null if none is found.

getTextOffset

public int getTextOffset()

Description copied from interface: PsiElement

Returns the offset in the file to which the caret should be placed when performing the navigation to the element. (For classes implementing PsiNamedElement, this should return the offset in the file of the name identifier.)

Returns:

the offset of the PSI element.

isValid

public boolean isValid()

Description copied from interface: PsiElement

Checks if this PSI element is valid. Valid elements and their hierarchy members can be accessed for reading and writing. Valid elements can still correspond to underlying documents whose text is different, when those documents have been changed and not yet committed (PsiDocumentManager.commitDocument(com.intellij.openapi.editor.Document)). (In this case an attempt to change PSI will result in an exception). Any access to invalid elements results in PsiInvalidElementAccessException. Once invalid, elements can't become valid again. Elements become invalid in following cases:

• They have been deleted via PSI operation (PsiElement.delete())
• They have been deleted as a result of an incremental reparse (document commit)
• Their containing file has been changed externally, or renamed so that its PSI had to be rebuilt from scratch

Specified by:

isValid in interface PsiElement

Overrides:

isValid in class PsiElementBase

Returns:

true if the element is valid, false otherwise.

See Also:

PsiUtilCore.ensureValid(PsiElement)

isWritable

public boolean isWritable()

Description copied from interface: PsiElement

Checks if the contents of the element can be modified (if it belongs to a non-read-only source file.)

Specified by:

isWritable in interface PsiElement

Overrides:

isWritable in class PsiElementBase

Returns:

true if the element can be modified, false otherwise.

isPhysical

public boolean isPhysical()

Description copied from interface: PsiElement

Checks if an actual source or class file corresponds to the element. Non-physical elements include, for example, PSI elements created for the watch expressions in the debugger. Non-physical elements do not generate tree change events. Also, PsiDocumentManager.getDocument(PsiFile) returns null for non-physical elements. Not to be confused with FileViewProvider.isPhysical().

Specified by:

isPhysical in interface PsiElement

Overrides:

isPhysical in class PsiElementBase

Returns:

true if the element is physical, false otherwise.

toString

public abstract java.lang.String toString()

Description copied from interface: PsiElement

toString() should never be presented to the user.

Specified by:

toString in interface PsiElement

Overrides:

toString in class java.lang.Object

checkAdd

public void checkAdd(PsiElement element)
              throws IncorrectOperationException

Description copied from interface: PsiElement

Checks if it is possible to add the specified element as a child to this element, and throws an exception if the add is not possible. Does not actually modify anything.

Specified by:

checkAdd in interface PsiElement

Overrides:

checkAdd in class PsiElementBase

Parameters:

element - the child element to check the add possibility.

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

add

public PsiElement add(PsiElement element)
               throws IncorrectOperationException

Description copied from interface: PsiElement

Adds a child to this PSI element.

Specified by:

add in interface PsiElement

Overrides:

add in class PsiElementBase

Parameters:

element - the child element to add.

Returns:

the element which was actually added (either element or its copy).

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

addBefore

public PsiElement addBefore(PsiElement element,
                            PsiElement anchor)
                     throws IncorrectOperationException

Description copied from interface: PsiElement

Adds a child to this PSI element, before the specified anchor element.

Specified by:

addBefore in interface PsiElement

Overrides:

addBefore in class PsiElementBase

Parameters:

element - the child element to add.

anchor - the anchor before which the child element is inserted (must be a child of this PSI element)

Returns:

the element which was actually added (either element or its copy).

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

addAfter

public PsiElement addAfter(PsiElement element,
                           PsiElement anchor)
                    throws IncorrectOperationException

Description copied from interface: PsiElement

Adds a child to this PSI element, after the specified anchor element.

Specified by:

addAfter in interface PsiElement

Overrides:

addAfter in class PsiElementBase

Parameters:

element - the child element to add.

anchor - the anchor after which the child element is inserted (must be a child of this PSI element)

Returns:

the element which was actually added (either element or its copy).

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

delete

public void delete()
            throws IncorrectOperationException

Description copied from interface: PsiElement

Deletes this PSI element from the tree.

Specified by:

delete in interface PsiElement

Overrides:

delete in class PsiElementBase

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason (for example, the file containing the element is read-only).

checkDelete

public void checkDelete()
                 throws IncorrectOperationException

Description copied from interface: PsiElement

Checks if it is possible to delete the specified element from the tree, and throws an exception if the add is not possible. Does not actually modify anything.

Specified by:

checkDelete in interface PsiElement

Overrides:

checkDelete in class PsiElementBase

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

replace

public PsiElement replace(PsiElement newElement)
                   throws IncorrectOperationException

Description copied from interface: PsiElement

Replaces this PSI element (along with all its children) with another element (along with the children).

Specified by:

replace in interface PsiElement

Overrides:

replace in class PsiElementBase

Parameters:

newElement - the element to replace this element with.

Returns:

the element which was actually inserted in the tree (either newElement or its copy)

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

getNode

public ASTNode getNode()

Description copied from interface: PsiElement

Returns the AST node corresponding to the element.

Returns:

the AST node instance.

getText

public java.lang.String getText()

Description copied from interface: PsiElement

Returns the text of the PSI element.

Note: This call requires traversing whole subtree, so it can be expensive for composite elements, and should be avoided if possible.

Returns:

the element text.

See Also:

PsiElement.textMatches(java.lang.CharSequence), PsiElement.textContains(char)

accept

public void accept(PsiElementVisitor visitor)

Description copied from interface: PsiElement

Passes the element to the specified visitor.

Specified by:

accept in interface PsiElement

Overrides:

accept in class PsiElementBase

Parameters:

visitor - the visitor to pass the element to.

copy

public PsiElement copy()

Description copied from interface: PsiElement

Creates a copy of the file containing the PSI element and returns the corresponding element in the created copy. Resolve operations performed on elements in the copy of the file will resolve to elements in the copy, not in the original file.

Specified by:

copy in interface PsiElement

Overrides:

copy in class PsiElementBase

Returns:

the element in the file copy corresponding to this element.

getNavigationElement

public PsiElement getNavigationElement()

Description copied from interface: PsiElement

Returns the PSI element which should be used as a navigation target when navigation to this PSI element is requested. The method can either return this or substitute a different element if this element does not have an associated file and offset. (For example, if the source code of a library is attached to a project, the navigation element for a compiled library class is its source class.)

Specified by:

getNavigationElement in interface PsiElement

Overrides:

getNavigationElement in class PsiElementBase

Returns:

the navigation target element.

setNavigationElement

public void setNavigationElement(PsiElement navigationElement)

getPrevSibling

public PsiElement getPrevSibling()

Description copied from interface: PsiElement

Returns the previous sibling of the PSI element.

Specified by:

getPrevSibling in interface PsiElement

Overrides:

getPrevSibling in class PsiElementBase

Returns:

the previous sibling, or null if the node is the first in the list of siblings.

getNextSibling

public PsiElement getNextSibling()

Description copied from interface: PsiElement

Returns the next sibling of the PSI element.

Specified by:

getNextSibling in interface PsiElement

Overrides:

getNextSibling in class PsiElementBase

Returns:

the next sibling, or null if the node is the last in the list of siblings.