Package com.intellij.psi.impl.source

Class JavaStubPsiElement<T extends StubElement>

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.PsiElementBase

com.intellij.extapi.psi.ASTDelegatePsiElement

com.intellij.extapi.psi.StubBasedPsiElementBase<T>

com.intellij.psi.impl.source.JavaStubPsiElement<T>

All Implemented Interfaces:

NavigationItem, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, NavigatablePsiElement, PsiElement, StubBasedPsiElement<T>, java.lang.Cloneable

Direct Known Subclasses:

PsiAnnotationImpl, PsiAnnotationParamListImpl, PsiClassImpl, PsiClassInitializerImpl, PsiEnumConstantImpl, PsiFieldImpl, PsiImportListImpl, PsiImportStatementBaseImpl, PsiJavaModuleImpl, PsiLambdaExpressionImpl, PsiLiteralExpressionImpl, PsiMethodImpl, PsiMethodReferenceExpressionImpl, PsiModifierListImpl, PsiNameValuePairImpl, PsiPackageAccessibilityStatementImpl, PsiParameterImpl, PsiParameterListImpl, PsiProvidesStatementImpl, PsiRecordComponentImpl, PsiRecordHeaderImpl, PsiReferenceListImpl, PsiRequiresStatementImpl, PsiTypeParameterImpl, PsiTypeParameterListImpl, PsiUsesStatementImpl

public abstract class JavaStubPsiElement<T extends StubElement>
extends StubBasedPsiElementBase<T>
implements StubBasedPsiElement<T>

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.extapi.psi.StubBasedPsiElementBase

CREATION_TRACE, ourTraceStubAstBinding

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

EMPTY_NAVIGATABLE_ELEMENT_ARRAY

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Constructor Summary

Constructors

Constructor and Description
JavaStubPsiElement(ASTNode node)
JavaStubPsiElement(T stub, IStubElementType nodeType)

Method Summary

Modifier and Type	Method and Description
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.
protected CompositeElement	calcTreeElement()
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.
protected java.lang.Object	clone()
protected StubBasedPsiElementBase	cloneImpl(CompositeElement treeElementClone)
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 []	getChildren() Returns the array of children for the PSI element.
Language	getLanguage() Returns the language 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.
PsiElement	replace(PsiElement newElement) Replaces this PSI element (along with all its children) with another element (along with the children).

Methods inherited from class com.intellij.extapi.psi.StubBasedPsiElementBase

getContainingFile, getContext, getElementType, getGreenStub, getManager, getNode, getParent, getParentByStub, getParentByTree, getProject, getRequiredStubOrPsiChild, getStub, getStubOrPsiChild, getStubOrPsiChildren, getStubOrPsiChildren, getStubOrPsiChildren, getStubOrPsiChildren, getStubOrPsiParentOfType, isPhysical, isValid, isWritable, setNode, setSubstrateRef

Methods inherited from class com.intellij.extapi.psi.ASTDelegatePsiElement

addInternal, addRange, addRangeAfter, addRangeBefore, checkDelete, copy, deleteChildInternal, findChildByFilter, findChildByType, findChildByType, findChildrenByType, findChildrenByType, findChildrenByType, findChildrenByType, findElementAt, findLastChildByType, findNotNullChildByType, findNotNullChildByType, getCopyableUserData, getFirstChild, getLastChild, getNextSibling, getPrevSibling, getStartOffsetInParent, getText, getTextLength, getTextRange, putCopyableUserData, replaceChildInternal, subtreeChanged, textContains, textMatches, textToCharArray

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

accept, canNavigate, canNavigateToSource, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getName, getNavigationElement, getOriginalElement, getPresentation, getReference, getReferences, getResolveScope, getUseScope, isEquivalentTo, navigate, notNullChild, processDeclarations, 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, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.psi.StubBasedPsiElement

getElementType, getStub

Methods inherited from interface com.intellij.psi.PsiElement

accept, addRange, addRangeAfter, addRangeBefore, checkDelete, copy, findElementAt, findReferenceAt, getContainingFile, getContext, getCopyableUserData, getFirstChild, getLastChild, getManager, getNavigationElement, getNextSibling, getNode, getOriginalElement, getOwnReferences, getParent, getPrevSibling, getProject, getReference, getReferences, getResolveScope, getStartOffsetInParent, getText, getTextLength, getTextRange, getTextRangeInParent, getUseScope, isEquivalentTo, isPhysical, isValid, isWritable, processDeclarations, putCopyableUserData, textContains, textMatches, textMatches, textToCharArray, toString

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

getUserData, putUserData

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

getIcon

Constructor Detail

JavaStubPsiElement

public JavaStubPsiElement(T stub,
                          IStubElementType nodeType)

JavaStubPsiElement

public JavaStubPsiElement(ASTNode node)

Method Detail

getLanguage

public Language getLanguage()

Description copied from interface: PsiElement

Returns the language of the PSI element.

Specified by:

getLanguage in interface PsiElement

Overrides:

getLanguage in class StubBasedPsiElementBase<T extends StubElement>

Returns:

the language instance.

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 ASTDelegatePsiElement

Returns:

the offset of the PSI element.

calcTreeElement

protected CompositeElement calcTreeElement()

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 ASTDelegatePsiElement

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 ASTDelegatePsiElement

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 ASTDelegatePsiElement

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

Overrides:

checkAdd in class ASTDelegatePsiElement

Parameters:

element - the child element to check the add possibility.

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 ASTDelegatePsiElement

Throws:

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

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

Overrides:

deleteChildRange in class ASTDelegatePsiElement

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

Overrides:

replace in class ASTDelegatePsiElement

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.

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

Overrides:

acceptChildren in class PsiElementBase

Parameters:

visitor - the visitor to pass the children to.

clone

protected java.lang.Object clone()

Overrides:

clone in class StubBasedPsiElementBase<T extends StubElement>

cloneImpl

protected StubBasedPsiElementBase cloneImpl(CompositeElement treeElementClone)

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

Overrides:

getChildren in class ASTDelegatePsiElement

Returns:

the array of child elements.