Package com.intellij.psi.impl.light

Class JavaIdentifier

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.PsiElementBase

com.intellij.psi.impl.light.LightElement

com.intellij.psi.impl.light.LightIdentifier

com.intellij.psi.impl.light.JavaIdentifier

All Implemented Interfaces:

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

public class JavaIdentifier
extends LightIdentifier

Nested Class Summary

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

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields inherited from class com.intellij.psi.impl.light.LightElement

myManager

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

FLAGS_LOCKED, ICON_PLACEHOLDER

Fields inherited from interface com.intellij.psi.PsiIdentifier

EMPTY_ARRAY

Fields inherited from interface com.intellij.psi.PsiElement

ARRAY_FACTORY

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.psi.NavigatablePsiElement

EMPTY_NAVIGATABLE_ELEMENT_ARRAY

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Constructor Summary

Constructors

Constructor and Description
JavaIdentifier(PsiManager manager, PsiElement element)

Method Summary

Modifier and Type	Method and Description
PsiElement	copy() Creates a copy of the file containing the PSI element and returns the corresponding element in the created copy.
PsiFile	getContainingFile() Returns the file containing the PSI element.
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.
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.
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	isValid() Checks if this PSI element is valid.

Methods inherited from class com.intellij.psi.impl.light.LightIdentifier

accept, getText, getTokenType, toString

Methods inherited from class com.intellij.psi.impl.light.LightElement

add, addAfter, addBefore, checkAdd, checkDelete, delete, findElementAt, getChildren, getLanguage, getManager, getNode, getTextLength, isPhysical, isWritable, replace, setNavigationElement, textMatches, textMatches, textToCharArray

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

acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, delete, deleteChildRange, findElementAt, findReferenceAt, getChildren, getContext, getCopyableUserData, getFirstChild, getLanguage, getLastChild, getManager, getNode, getOriginalElement, getOwnReferences, getProject, getReference, getReferences, getResolveScope, getTextLength, getTextRangeInParent, getUseScope, isEquivalentTo, isPhysical, isWritable, processDeclarations, putCopyableUserData, replace, 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

Constructor Detail

JavaIdentifier

public JavaIdentifier(PsiManager manager,
                      PsiElement element)

Method Detail

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 LightElement

Returns:

the navigation target 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 LightElement

Returns:

true if the element is valid, false otherwise.

See Also:

PsiUtilCore.ensureValid(PsiElement)

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.

Specified by:

getTextRange in interface PsiElement

Overrides:

getTextRange in class LightElement

Returns:

the text range.

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 LightElement

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

getStartOffsetInParent

public int getStartOffsetInParent()

Description copied from interface: PsiElement

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

Specified by:

getStartOffsetInParent in interface PsiElement

Overrides:

getStartOffsetInParent in class LightElement

Returns:

the relative offset.

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

Specified by:

getTextOffset in interface PsiElement

Overrides:

getTextOffset in class LightElement

Returns:

the offset of the PSI element.

getParent

public PsiElement getParent()

Description copied from interface: PsiElement

Returns the parent of the PSI element.

Specified by:

getParent in interface PsiElement

Overrides:

getParent in class LightElement

Returns:

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

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 LightElement

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 LightElement

Returns:

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

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 LightIdentifier

Returns:

the element in the file copy corresponding to this element.