Package com.intellij.psi.impl.source.tree

Class CompositePsiElement

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.source.tree.TreeElement

com.intellij.psi.impl.source.tree.CompositeElement

com.intellij.psi.impl.source.tree.CompositePsiElement

All Implemented Interfaces:

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

Direct Known Subclasses:

ExpressionPsiElement, GeneratedParserUtilBase.DummyBlock, MarkdownCodeFenceImpl, PsiArrayInitializerMemberValueImpl, PsiAssertStatementImpl, PsiBlockStatementImpl, PsiBreakStatementImpl, PsiCatchSectionImpl, PsiContinueStatementImpl, PsiDeclarationStatementImpl, PsiDocMethodOrFieldRef, PsiDocParamRef, PsiDocTagImpl, PsiDocTagValueImpl, PsiDoWhileStatementImpl, PsiEmptyStatementImpl, PsiErrorElementImpl, PsiExpressionListImpl, PsiExpressionListStatementImpl, PsiExpressionStatementImpl, PsiForeachStatementImpl, PsiForStatementImpl, PsiIfStatementImpl, PsiImportStaticReferenceElementImpl, PsiInlineDocTagImpl, PsiJavaCodeReferenceElementImpl, PsiJavaModuleReferenceElementImpl, PsiLabeledStatementImpl, PsiLocalVariableImpl, PsiPackageStatementImpl, PsiPatternVariableImpl, PsiReceiverParameterImpl, PsiReferenceParameterListImpl, PsiResourceExpressionImpl, PsiResourceListImpl, PsiReturnStatementImpl, PsiSwitchBlockImpl, PsiSwitchLabelStatementBaseImpl, PsiSynchronizedStatementImpl, PsiThrowStatementImpl, PsiTryStatementImpl, PsiTypeElementImpl, PsiTypeTestPatternImpl, PsiWhileStatementImpl, PsiYieldStatementImpl, XmlElementImpl

public abstract class CompositePsiElement
extends CompositeElement
implements PsiElement, NavigationItem

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 static int	ourHC

Fields inherited from class com.intellij.psi.impl.source.tree.CompositeElement

EMPTY_ARRAY

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

FLAGS_LOCKED, ICON_PLACEHOLDER

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	CompositePsiElement(IElementType type)

Method Summary

Modifier and Type	Method and Description
void	accept(PsiElementVisitor visitor) Passes the element to the specified visitor.
void	acceptChildren(PsiElementVisitor visitor) Passes the children of 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.
PsiElement	addRange(PsiElement first, PsiElement last) Adds a range of elements as children to this PSI element.
PsiElement	addRangeAfter(PsiElement first, PsiElement last, PsiElement anchor) Adds a range of elements as children to this PSI element, after the specified anchor element.
PsiElement	addRangeBefore(PsiElement first, PsiElement last, PsiElement anchor) Adds a range of elements as children to this PSI element, before the specified anchor element.
boolean	canNavigate() Indicates whether this instance supports navigation of any kind.
boolean	canNavigateToSource() Indicates whether this instance supports navigation to source (that means some kind of editor).
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.
CompositePsiElement	clone() Creates and returns a deep copy of the AST tree part starting at this node.
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.
void	deleteChildRange(PsiElement first, PsiElement last) Deletes a range of children of 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.
PsiReference	findReferenceAt(int offset) Finds a reference 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.
PsiElement	getContext() Returns the element which should be used as the parent of this element in a tree up walk during a resolve operation.
PsiElement	getFirstChild() Returns the first child of the PSI element.
Language	getLanguage() Returns the language of the PSI element.
PsiElement	getLastChild() Returns the last child of the PSI element.
java.lang.String	getName()
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	getOriginalElement() Returns the PSI element which corresponds to this element and belongs to either the project source path or class path.
PsiElement	getParent() Returns the parent of the PSI element.
ItemPresentation	getPresentation()
PsiElement	getPrevSibling() Returns the previous sibling of the PSI element.
Project	getProject() Returns the project to which the PSI element belongs.
PsiReference	getReference() Returns the reference from this PSI element to another PSI element (or elements), if one exists.
PsiReference []	getReferences() Returns all references from this PSI element to other PSI elements.
GlobalSearchScope	getResolveScope() Returns the scope in which the declarations for the references in this PSI element are searched.
SearchScope	getUseScope() Returns the scope in which references to this element are searched.
boolean	isEquivalentTo(PsiElement another) This method shouldn't be called by clients directly, because there are no guarantees of it being symmetric.
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.)
void	navigate(boolean requestFocus) Open editor and select/navigate to the object there if possible.
boolean	processDeclarations(PsiScopeProcessor processor, ResolveState state, PsiElement lastParent, PsiElement place) Passes the declarations contained in this PSI element and its children for processing to the specified scope processor.
PsiElement	replace(PsiElement newElement) Replaces this PSI element (along with all its children) with another element (along with the children).
java.lang.String	toString() toString() should never be presented to the user.

Methods inherited from class com.intellij.psi.impl.source.tree.CompositeElement

acceptTree, addChild, addChild, addChildren, addInternal, addLeaf, clearCaches, countChildren, createPsiNoLock, deleteChildInternal, findChildByRole, findChildByRoleAsPsiElement, findChildByType, findChildByType, findChildByType, findChildByType, findLeafElementAt, findPsiChildByType, findPsiChildByType, getCachedLength, getChars, getChildren, getChildrenAsPsiElements, getChildrenAsPsiElements, getChildRole, getChildRole, getFirstChildNode, getLastChildNode, getPsi, getPsi, getText, getTextLength, hc, rawAddChildren, rawAddChildrenWithoutNotifications, rawFirstChild, rawLastChild, rawRemoveAllChildren, removeAllChildren, removeChild, removeRange, replaceAllChildrenToChildrenOf, replaceChild, replaceChildInternal, setPsi, subtreeChanged, textContains, textMatches, textToCharArray

Methods inherited from class com.intellij.psi.impl.source.tree.TreeElement

copyElement, equals, getElementType, getManager, getStartOffset, getStartOffsetInParent, getTextOffset, getTextRange, getTreeNext, getTreeParent, getTreePrev, invalidate, onInvalidated, rawInsertAfterMe, rawInsertBeforeMe, rawRemove, rawRemoveUpTo, rawRemoveUpToLast, rawReplaceWithList, textMatches, textMatches, textMatches

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, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.psi.PsiElement

getCopyableUserData, getManager, getOwnReferences, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, getTextRangeInParent, putCopyableUserData, textContains, textMatches, textMatches, textToCharArray

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

getUserData, putUserData

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

getIcon

Methods inherited from interface com.intellij.lang.ASTNode

getCopyableUserData, putCopyableUserData

Field Detail

ourHC

protected static int ourHC

Constructor Detail

CompositePsiElement

protected CompositePsiElement(IElementType type)

Method Detail

clone

public CompositePsiElement clone()

Description copied from interface: ASTNode

Creates and returns a deep copy of the AST tree part starting at this node.

Specified by:

clone in interface ASTNode

Overrides:

clone in class CompositeElement

Returns:

the top node of the copied tree (as an ASTNode object)

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

Specified by:

getChildren in interface PsiElement

Returns:

the array of child elements.

getFirstChild

public PsiElement getFirstChild()

Description copied from interface: PsiElement

Returns the first child of the PSI element.

Specified by:

getFirstChild in interface PsiElement

Returns:

the first child, or null if the element has no children.

getLastChild

public PsiElement getLastChild()

Description copied from interface: PsiElement

Returns the last child of the PSI element.

Specified by:

getLastChild in interface PsiElement

Returns:

the last child, or null if the element has no children.

acceptChildren

public void acceptChildren(PsiElementVisitor visitor)

Description copied from interface: PsiElement

Passes the children of the element to the specified visitor.

Specified by:

acceptChildren in interface PsiElement

Parameters:

visitor - the visitor to pass the children to.

getParent

public PsiElement getParent()

Description copied from interface: PsiElement

Returns the parent of the PSI element.

Specified by:

getParent in interface PsiElement

Returns:

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

getNextSibling

public PsiElement getNextSibling()

Description copied from interface: PsiElement

Returns the next sibling of the PSI element.

Specified by:

getNextSibling in interface PsiElement

Returns:

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

getPrevSibling

public PsiElement getPrevSibling()

Description copied from interface: PsiElement

Returns the previous sibling of the PSI element.

Specified by:

getPrevSibling in interface PsiElement

Returns:

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

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

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).

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.

Specified by:

findElementAt in interface PsiElement

Parameters:

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

Returns:

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

findReferenceAt

public PsiReference findReferenceAt(int offset)

Description copied from interface: PsiElement

Finds a reference at the specified offset from the start of the text range of this node.

Specified by:

findReferenceAt in interface PsiElement

Parameters:

offset - the relative offset for which the reference is requested.

Returns:

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

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

Returns:

the element in the file copy corresponding to this 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

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

Returns:

true if the element can be modified, false otherwise.

getReference

public PsiReference getReference()

Description copied from interface: PsiElement

Returns the reference from this PSI element to another PSI element (or elements), if one exists. If the element has multiple associated references (see PsiElement.getReferences() for an example), returns the first associated reference.

Specified by:

getReference in interface PsiElement

Returns:

the reference instance, or null if the PSI element does not have any associated references.

See Also:

ReferencesSearch

getReferences

public PsiReference [] getReferences()

Description copied from interface: PsiElement

Returns all references from this PSI element to other PSI elements. An element can have multiple references when, for example, the element is a string literal containing multiple sub-strings which are valid full-qualified class names. If an element contains only one text fragment which acts as a reference but the reference has multiple possible targets, PsiPolyVariantReference should be used instead of returning multiple references.

Actually, it's preferable to call PsiReferenceService.getReferences(com.intellij.psi.PsiElement, com.intellij.psi.PsiReferenceService.Hints) instead as it allows adding references by plugins when the element implements ContributedReferenceHost.

Specified by:

getReferences in interface PsiElement

Returns:

the array of references, or an empty array if the element has no associated references.

See Also:

PsiReferenceService.getReferences(com.intellij.psi.PsiElement, com.intellij.psi.PsiReferenceService.Hints), ReferencesSearch

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

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

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

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.

checkAdd

public final 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

Parameters:

element - the child element to check the add possibility.

Throws:

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

addRange

public final PsiElement addRange(PsiElement first,
                                 PsiElement last)
                          throws IncorrectOperationException

Description copied from interface: PsiElement

Adds a range of elements as children to this PSI element.

Specified by:

addRange in interface PsiElement

Parameters:

first - the first child element to add.

last - the last child element to add (must have the same parent as first)

Returns:

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

Throws:

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

addRangeBefore

public final PsiElement addRangeBefore(PsiElement first,
                                       PsiElement last,
                                       PsiElement anchor)
                                throws IncorrectOperationException

Description copied from interface: PsiElement

Adds a range of elements as children to this PSI element, before the specified anchor element.

Specified by:

addRangeBefore in interface PsiElement

Parameters:

first - the first child element to add.

last - the last child element to add (must have the same parent as first)

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

Returns:

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

Throws:

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

addRangeAfter

public final PsiElement addRangeAfter(PsiElement first,
                                      PsiElement last,
                                      PsiElement anchor)
                               throws IncorrectOperationException

Description copied from interface: PsiElement

Adds a range of elements as children to this PSI element, after the specified anchor element.

Specified by:

addRangeAfter in interface PsiElement

Parameters:

first - the first child element to add.

last - the last child element to add (must have the same parent as first)

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

Returns:

the first child element which was actually added (either first 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

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

Throws:

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

deleteChildRange

public void deleteChildRange(PsiElement first,
                             PsiElement last)
                      throws IncorrectOperationException

Description copied from interface: PsiElement

Deletes a range of children of this PSI element from the tree.

Specified by:

deleteChildRange in interface PsiElement

Parameters:

first - the first child to delete (must be a child of this PSI element)

last - the last child to delete (must be a child of this PSI element)

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

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.

accept

public void accept(PsiElementVisitor visitor)

Description copied from interface: PsiElement

Passes the element to the specified visitor.

Specified by:

accept in interface PsiElement

Parameters:

visitor - the visitor to pass the element to.

processDeclarations

public boolean processDeclarations(PsiScopeProcessor processor,
                                   ResolveState state,
                                   PsiElement lastParent,
                                   PsiElement place)

Description copied from interface: PsiElement

Passes the declarations contained in this PSI element and its children for processing to the specified scope processor.

Specified by:

processDeclarations in interface PsiElement

Parameters:

processor - the processor receiving the declarations.

lastParent - the child of this element has been processed during the previous step of the tree up walk (declarations under this element do not need to be processed again)

place - the original element from which the tree up walk was initiated.

Returns:

true if the declaration processing should continue or false if it should be stopped.

toString

public 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 TreeElement

getContext

public PsiElement getContext()

Description copied from interface: PsiElement

Returns the element which should be used as the parent of this element in a tree up walk during a resolve operation. For most elements, this returns getParent(), but the context can be overridden for some elements like code fragments (see JavaCodeFragmentFactory.createCodeBlockCodeFragment(String, PsiElement, boolean)).

Specified by:

getContext in interface PsiElement

Returns:

the resolve context 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

Returns:

the navigation target element.

getOriginalElement

public PsiElement getOriginalElement()

Description copied from interface: PsiElement

Returns the PSI element which corresponds to this element and belongs to either the project source path or class path. The method can either return this or substitute a different element if this element does not belong to the source path or class path. (For example, the original element for a library source file is the corresponding compiled class file.)

Specified by:

getOriginalElement in interface PsiElement

Returns:

the original element.

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

Returns:

true if the element is physical, false otherwise.

getResolveScope

public GlobalSearchScope getResolveScope()

Description copied from interface: PsiElement

Returns the scope in which the declarations for the references in this PSI element are searched.

Specified by:

getResolveScope in interface PsiElement

Returns:

the resolve scope instance.

getUseScope

public SearchScope getUseScope()

Description copied from interface: PsiElement

Returns the scope in which references to this element are searched.

Specified by:

getUseScope in interface PsiElement

Returns:

the search scope instance.

See Also:

PsiSearchHelper.getUseScope(PsiElement)

getPresentation

public ItemPresentation getPresentation()

Specified by:

getPresentation in interface NavigationItem

getName

public java.lang.String getName()

Specified by:

getName in interface NavigationItem

navigate

public void navigate(boolean requestFocus)

Description copied from interface: Navigatable

Open editor and select/navigate to the object there if possible. Just do nothing if navigation is not possible like in case of a package

Specified by:

navigate in interface Navigatable

Parameters:

requestFocus - true if focus requesting is necessary

canNavigate

public boolean canNavigate()

Description copied from interface: Navigatable

Indicates whether this instance supports navigation of any kind. Usually this method is called to ensure that navigation is possible. Note that it is not called if navigation to source is supported, i.e. Navigatable.canNavigateToSource() returns true. We assume that this method should return true in such case, so implement this method respectively.

Specified by:

canNavigate in interface Navigatable

Returns:

false if navigation is not possible for any reason.

canNavigateToSource

public boolean canNavigateToSource()

Description copied from interface: Navigatable

Indicates whether this instance supports navigation to source (that means some kind of editor). Note that navigation can be supported even if this method returns false. In such cases it is not recommended to do batch navigation for all navigatables available via CommonDataKeys.NAVIGATABLE_ARRAY, because it may lead to opening several modal dialogs. Use OpenSourceUtil.navigate(com.intellij.pom.Navigatable...) to process such arrays correctly.

Specified by:

canNavigateToSource in interface Navigatable

Returns:

false if navigation to source is not possible for any reason.

getProject

public Project getProject()

Description copied from interface: PsiElement

Returns the project to which the PSI element belongs.

Specified by:

getProject in interface PsiElement

Returns:

the project instance.

getLanguage

public Language getLanguage()

Description copied from interface: PsiElement

Returns the language of the PSI element.

Specified by:

getLanguage in interface PsiElement

Returns:

the language instance.

getNode

public ASTNode getNode()

Description copied from interface: PsiElement

Returns the AST node corresponding to the element.

Specified by:

getNode in interface PsiElement

Returns:

the AST node instance.

isEquivalentTo

public boolean isEquivalentTo(PsiElement another)

Description copied from interface: PsiElement

This method shouldn't be called by clients directly, because there are no guarantees of it being symmetric. It's called by PsiManager.areElementsEquivalent(PsiElement, PsiElement) internally, which clients should invoke instead.

Implementations of this method should return true if the parameter is resolve-equivalent to this, i.e. it represents the same entity from the language perspective. See also PsiManager.areElementsEquivalent(PsiElement, PsiElement) documentation.

Specified by:

isEquivalentTo in interface PsiElement