ASTDelegatePsiElement (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.openapi.util.UserDataHolderBase
- - com.intellij.psi.impl.ElementBase
  - - com.intellij.psi.impl.PsiElementBase
    - - com.intellij.extapi.psi.ASTDelegatePsiElement

All Implemented Interfaces:

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

Direct Known Subclasses:

ASTWrapperPsiElement, StubBasedPsiElementBase
```
public abstract class ASTDelegatePsiElement
extends PsiElementBase
```

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.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
Constructor and Description

ASTDelegatePsiElement()

Constructors
Constructor and Description
`ASTDelegatePsiElement()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`ASTNode`	`addInternal(ASTNode first, ASTNode last, ASTNode anchor, java.lang.Boolean before)`
`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.
`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.
`void`	`deleteChildInternal(ASTNode child)`
`void`	`deleteChildRange(PsiElement first, PsiElement last)` Deletes a range of children of this PSI element from the tree.
`protected PsiElement`	`findChildByFilter(TokenSet tokenSet)`
`protected <T extends PsiElement> T`	`findChildByType(IElementType type)`
`protected <T extends PsiElement> T`	`findChildByType(TokenSet type)`
`protected <T extends PsiElement> java.util.List<T>`	`findChildrenByType(IElementType elementType)`
`protected <T extends PsiElement> T []`	`findChildrenByType(IElementType elementType, java.lang.Class<T> arrayClass)`
`protected <T extends PsiElement> java.util.List<T>`	`findChildrenByType(TokenSet elementType)`
`protected <T extends PsiElement> T []`	`findChildrenByType(TokenSet elementType, java.lang.Class<T> arrayClass)`
`PsiElement`	`findElementAt(int offset)` Finds a leaf PSI element at the specified offset from the start of the text range of this node.
`protected <T extends PsiElement> T`	`findLastChildByType(IElementType type)`
`protected <T extends PsiElement> T`	`findNotNullChildByType(IElementType type)`
`protected <T extends PsiElement> T`	`findNotNullChildByType(TokenSet type)`
`PsiElement []`	`getChildren()` Returns the array of children for the PSI element.
`PsiFile`	`getContainingFile()` Returns the file containing the PSI element.
`<T> T`	`getCopyableUserData(Key<T> key)` Returns a copyable user data object attached to this element.
`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.
`PsiManagerEx`	`getManager()` Returns the PSI manager for the project to which the PSI element belongs.
`PsiElement`	`getNextSibling()` Returns the next sibling of the PSI element.
`abstract ASTNode`	`getNode()` Returns the AST node corresponding to the 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.
`<T> void`	`putCopyableUserData(Key<T> key, T value)` Attaches a copyable user data object to this element.
`PsiElement`	`replace(PsiElement newElement)` Replaces this PSI element (along with all its children) with another element (along with the children).
`void`	`replaceChildInternal(PsiElement child, TreeElement newElement)`
`void`	`subtreeChanged()`
`boolean`	`textContains(char c)` Checks if the text of this element contains the specified character.
`boolean`	`textMatches(java.lang.CharSequence text)` Checks if the text of this PSI element is equal to the specified character sequence.
`char []`	`textToCharArray()` Returns the text of the PSI element as a character array.

Methods inherited from class com.intellij.psi.impl.PsiElementBase
accept, acceptChildren, canNavigate, canNavigateToSource, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getContext, getName, getNavigationElement, getOriginalElement, getPresentation, getProject, getReference, getReferences, getResolveScope, getUseScope, isEquivalentTo, isPhysical, isValid, isWritable, 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, clone, 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.PsiElement
getOwnReferences, getParent, getTextRangeInParent, toString

Methods inherited from interface com.intellij.openapi.util.UserDataHolder
getUserData, putUserData

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

- Constructor Detail
  - ASTDelegatePsiElement
```
public ASTDelegatePsiElement()
```
- Method Detail
  - 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).
  - getManager
```
public PsiManagerEx 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.
  - 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.
  - getFirstChild
```
public PsiElement getFirstChild()
```
    Description copied from interface: PsiElement
    
    Returns the first child of the PSI element.
    
    Specified by:
    
    getFirstChild in interface PsiElement
    
    Overrides:
    
    getFirstChild in class PsiElementBase
    
    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
    
    Overrides:
    
    getLastChild in class PsiElementBase
    
    Returns:
    
    the last child, or null if the element has no children.
  - 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.
  - 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.
  - 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 int getTextLength()
```
    Description copied from interface: PsiElement
    
    Returns the length of text of the PSI element.
    
    Returns:
    
    the text length.
  - 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.
  - 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)
  - 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.
  - textContains
```
public boolean textContains(char c)
```
    Description copied from interface: PsiElement
    
    Checks if the text of this element contains the specified character.
    
    Specified by:
    
    textContains in interface PsiElement
    
    Overrides:
    
    textContains in class PsiElementBase
    
    Parameters:
    
    c - the character to search for.
    
    Returns:
    
    true if the character is found, false otherwise.
  - getCopyableUserData
```
public <T> T getCopyableUserData(Key<T> key)
```
    Description copied from interface: PsiElement
    
    Returns a copyable user data object attached to this element.
    
    Specified by:
    
    getCopyableUserData in interface PsiElement
    
    Overrides:
    
    getCopyableUserData in class UserDataHolderBase
    
    Parameters:
    
    key - the key for accessing the user data object.
    
    Returns:
    
    the user data object, or null if no such object is found in the current element.
    
    See Also:
    
    PsiElement.putCopyableUserData(Key, Object)
  - putCopyableUserData
```
public <T> void putCopyableUserData(Key<T> key,
                                    T value)
```
    Description copied from interface: PsiElement
    
    Attaches a copyable user data object to this element. Copyable user data objects are copied when the PSI elements are copied.
    
    Specified by:
    
    putCopyableUserData in interface PsiElement
    
    Overrides:
    
    putCopyableUserData in class UserDataHolderBase
    
    Parameters:
    
    key - the key for accessing the user data object.
    
    value - the user data object to attach.
    
    See Also:
    
    PsiElement.getCopyableUserData(Key)
  - getNode
```
public abstract ASTNode getNode()
```
    Description copied from interface: PsiElement
    
    Returns the AST node corresponding to the element.
    
    Returns:
    
    the AST node instance.
  - subtreeChanged
```
public void subtreeChanged()
```
  - getLanguage
```
public Language getLanguage()
```
    Description copied from interface: PsiElement
    
    Returns the language of the PSI element.
    
    Returns:
    
    the language instance.
  - findChildByType
```
protected <T extends PsiElement> T findChildByType(IElementType type)
```
  - findLastChildByType
```
protected <T extends PsiElement> T findLastChildByType(IElementType type)
```
  - findNotNullChildByType
```
protected <T extends PsiElement> T findNotNullChildByType(IElementType type)
```
  - findChildByType
```
protected <T extends PsiElement> T findChildByType(TokenSet type)
```
  - findNotNullChildByType
```
protected <T extends PsiElement> T findNotNullChildByType(TokenSet type)
```
  - findChildByFilter
```
protected PsiElement findChildByFilter(TokenSet tokenSet)
```
  - findChildrenByType
```
protected <T extends PsiElement> T [] findChildrenByType(IElementType elementType,
                                                         java.lang.Class<T> arrayClass)
```
  - findChildrenByType
```
protected <T extends PsiElement> java.util.List<T> findChildrenByType(TokenSet elementType)
```
  - findChildrenByType
```
protected <T extends PsiElement> java.util.List<T> findChildrenByType(IElementType elementType)
```
  - findChildrenByType
```
protected <T extends PsiElement> T [] findChildrenByType(TokenSet elementType,
                                                         java.lang.Class<T> arrayClass)
```
  - 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.
  - 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.
  - 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.
  - addInternal
```
public ASTNode addInternal(ASTNode first,
                           ASTNode last,
                           ASTNode anchor,
                           java.lang.Boolean before)
```
  - addRange
```
public 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
    
    Overrides:
    
    addRange in class PsiElementBase
    
    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 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
    
    Overrides:
    
    addRangeBefore in class PsiElementBase
    
    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 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
    
    Overrides:
    
    addRangeAfter in class PsiElementBase
    
    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
    
    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).
  - deleteChildInternal
```
public void deleteChildInternal(ASTNode child)
```
  - 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.
  - 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 PsiElementBase
    
    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 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.
  - replaceChildInternal
```
public void replaceChildInternal(PsiElement child,
                                 TreeElement newElement)
```
  - 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.

Class ASTDelegatePsiElement

Nested Class Summary

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

Field Summary

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

Fields inherited from interface com.intellij.psi.NavigatablePsiElement

Fields inherited from interface com.intellij.psi.PsiElement

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

Fields inherited from interface com.intellij.navigation.NavigationItem

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.intellij.psi.PsiElement

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

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

Constructor Detail

ASTDelegatePsiElement

Method Detail

getContainingFile

getManager

getChildren

getFirstChild

getLastChild

getNextSibling

getPrevSibling

getTextRange

getStartOffsetInParent

getTextLength

findElementAt

getTextOffset

getText

textToCharArray

textContains

getCopyableUserData

putCopyableUserData

getNode

subtreeChanged

getLanguage

findChildByType

findLastChildByType

findNotNullChildByType

findChildByType

findNotNullChildByType

findChildByFilter

findChildrenByType

findChildrenByType

findChildrenByType

findChildrenByType

copy

add

addBefore

addAfter

checkAdd

addInternal

addRange

addRangeBefore

addRangeAfter

delete

deleteChildInternal

checkDelete

deleteChildRange

replace

replaceChildInternal

textMatches