ASTNode (Unofficial IntelliJ Community Edition API docs)

All Superinterfaces:

UserDataHolder

All Known Subinterfaces:

FileASTNode

All Known Implementing Classes:

AnnotationElement, AnnotationMethodElement, AnnotationParamListElement, AnonymousClassElement, AnonymousClassElementBase, ClassElement, ClassInitializerElement, CodeFragmentElement, CompositeElement, CompositePsiElement, DummyHolderElement, EnumConstantElement, EnumConstantInitializerElement, ExpressionPsiElement, FieldElement, FileElement, ForeignLeafPsiElement, GeneratedParserUtilBase.DummyBlock, GrBlockImpl, GrClosableBlockImpl, GrDocCommentImpl, GrOpenBlockImpl, HtmlDocumentImpl, HtmlFileElement, HtmlTagImpl, ImportListElement, ImportStatementBaseElement, ImportStatementElement, ImportStaticStatementElement, JavaDummyElement, JavaFileElement, LazyParseableElement, LazyParseablePsiElement, LeafElement, LeafPsiElement, ManifestTokenImpl, MarkdownCodeFenceContentImpl, MarkdownCodeFenceImpl, MethodElement, ModifierListElement, NameValuePairElement, OuterLanguageElementImpl, OwnBufferLeafPsiElement, PackageAccessibilityStatementElement, ParameterElement, ParameterListElement, PropertyKeyImpl, PropertyValueImpl, PsiArrayAccessExpressionImpl, PsiArrayInitializerExpressionImpl, PsiArrayInitializerMemberValueImpl, PsiAssertStatementImpl, PsiAssignmentExpressionImpl, PsiBinaryExpressionImpl, PsiBlockStatementImpl, PsiBreakStatementImpl, PsiCatchSectionImpl, PsiClassObjectAccessExpressionImpl, PsiCodeBlockImpl, PsiCommentImpl, PsiConditionalExpressionImpl, PsiContinueStatementImpl, PsiCoreCommentImpl, PsiDeclarationStatementImpl, PsiDiamondTypeElementImpl, PsiDocCommentImpl, PsiDocMethodOrFieldRef, PsiDocParamRef, PsiDocTagImpl, PsiDocTagValueImpl, PsiDocTokenImpl, PsiDoWhileStatementImpl, PsiEmptyExpressionImpl, PsiEmptyStatementImpl, PsiErrorElementImpl, PsiExpressionListImpl, PsiExpressionListStatementImpl, PsiExpressionStatementImpl, PsiForeachStatementImpl, PsiForStatementImpl, PsiIdentifierImpl, PsiIfStatementImpl, PsiImportStaticReferenceElementImpl, PsiInlineDocTagImpl, PsiInstanceOfExpressionImpl, PsiJavaCodeReferenceElementImpl, PsiJavaModuleReferenceElementImpl, PsiJavaTokenImpl, PsiKeywordImpl, PsiLabeledStatementImpl, PsiLocalVariableImpl, PsiMethodCallExpressionImpl, PsiNewExpressionImpl, PsiPackageStatementImpl, PsiParenthesizedExpressionImpl, PsiPatternVariableImpl, PsiPlainTextImpl, PsiPolyadicExpressionImpl, PsiPostfixExpressionImpl, PsiPrefixExpressionImpl, PsiReceiverParameterImpl, PsiReferenceExpressionImpl, PsiReferenceParameterListImpl, PsiResourceExpressionImpl, PsiResourceListImpl, PsiResourceVariableImpl, PsiReturnStatementImpl, PsiSuperExpressionImpl, PsiSwitchBlockImpl, PsiSwitchExpressionImpl, PsiSwitchLabeledRuleStatementImpl, PsiSwitchLabelStatementBaseImpl, PsiSwitchLabelStatementImpl, PsiSwitchStatementImpl, PsiSynchronizedStatementImpl, PsiThisExpressionImpl, PsiThrowStatementImpl, PsiTryStatementImpl, PsiTypeCastExpressionImpl, PsiTypeElementImpl, PsiTypeTestPatternImpl, PsiWhileStatementImpl, PsiWhiteSpaceImpl, PsiYieldStatementImpl, PyPlainStringElementImpl, RecordHeaderElement, ReferenceListElement, ShLazyBlockImpl, ShLazyDoBlockImpl, ShLazyParseablePsiElement, TreeElement, TypeParameterElement, TypeParameterExtendsBoundsListElement, TypeParameterListElement, XmlAttlistDeclImpl, XmlAttributeDeclImpl, XmlAttributeImpl, XmlAttributeValueImpl, XmlCommentImpl, XmlConditionalSectionImpl, XmlDeclImpl, XmlDoctypeImpl, XmlDocumentImpl, XmlElementContentGroupImpl, XmlElementContentSpecImpl, XmlElementDeclImpl, XmlElementImpl, XmlEntityDeclImpl, XmlEntityRefImpl, XmlEnumeratedTypeImpl, XmlFileElement, XmlMarkupDeclImpl, XmlNotationDeclImpl, XmlProcessingInstructionImpl, XmlPrologImpl, XmlTagImpl, XmlTextImpl, XmlTokenImpl
```
public interface ASTNode
extends UserDataHolder
```
A node in the AST tree. The AST is an intermediate parsing tree created by PsiBuilder, out of which a PSI tree is then created.

See Also:

PsiElement

Field Summary

Fields
Modifier and Type Field and Description

static ASTNode[] EMPTY_ARRAY

Fields
Modifier and Type	Field and Description
`static ASTNode[]`	`EMPTY_ARRAY`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addChild(ASTNode child)` Adds the specified child node as the last child of this node.
`void`	`addChild(ASTNode child, ASTNode anchorBefore)` Adds the specified child node at the specified position in the child list.
`void`	`addChildren(ASTNode firstChild, ASTNode firstChildToNotAdd, ASTNode anchorBefore)` Adds a range of nodes belonging to the same parent to the list of children of this node, starting with `firstChild`, up to and not including `firstChildToNotAdd`.
`void`	`addLeaf(IElementType leafType, java.lang.CharSequence leafText, ASTNode anchorBefore)` Add leaf element with specified type and text in the child list.
`java.lang.Object`	`clone()` Creates and returns a deep copy of the AST tree part starting at this node.
`ASTNode`	`copyElement()` Creates a copy of the entire AST tree containing this node and returns a counterpart of this node in the resulting tree.
`ASTNode`	`findChildByType(IElementType type)` Returns the first child of the specified node which has the specified type.
`ASTNode`	`findChildByType(IElementType type, ASTNode anchor)` Returns the first child after anchor of the specified node which has the specified type.
`ASTNode`	`findChildByType(TokenSet typesSet)` Returns the first child of the specified node which has type from specified set.
`ASTNode`	`findChildByType(TokenSet typesSet, ASTNode anchor)` Returns the first child after anchor of the specified node which has type from specified set.
`ASTNode`	`findLeafElementAt(int offset)` Finds a leaf child node at the specified offset from the start of the text range of this node.
`java.lang.CharSequence`	`getChars()` Returns same text getText() returns but might be more effective eliminating toString() transformation from internal CharSequence representation
`ASTNode []`	`getChildren(TokenSet filter)` Returns the list of children of the specified node, optionally filtered by the specified token type filter.
`<T> T`	`getCopyableUserData(Key<T> key)` Returns a copyable user data object attached to this node.
`IElementType`	`getElementType()` Returns the type of this node.
`ASTNode`	`getFirstChildNode()` Returns the first child of this node in the tree.
`ASTNode`	`getLastChildNode()` Returns the last child of this node in the tree.
`PsiElement`	`getPsi()` Returns the PSI element for this node.
`<T extends PsiElement> T`	`getPsi(java.lang.Class<T> clazz)` Checks and returns the PSI element for this node.
`int`	`getStartOffset()` Returns the starting offset of the node text in the document.
`default int`	`getStartOffsetInParent()` Returns the starting offset of the node text relative to `getTreeParent()`.
`java.lang.String`	`getText()` Returns the text of this node.
`int`	`getTextLength()` Returns the length of the node text.
`TextRange`	`getTextRange()` Returns the text range (a combination of starting offset in the document and length) for this node.
`ASTNode`	`getTreeNext()` Returns the next sibling of this node in the tree.
`ASTNode`	`getTreeParent()` Returns the parent of this node in the tree.
`ASTNode`	`getTreePrev()` Returns the previous sibling of this node in the tree.
`<T> void`	`putCopyableUserData(Key<T> key, T value)` Attaches a copyable user data object to this node.
`void`	`removeChild(ASTNode child)` Removes the specified node from the list of children of this node.
`void`	`removeRange(ASTNode firstNodeToRemove, ASTNode firstNodeToKeep)` Removes a range of nodes from the list of children, starting with `firstNodeToRemove`, up to and not including `firstNodeToKeep`.
`void`	`replaceAllChildrenToChildrenOf(ASTNode anotherParent)` Replaces all child nodes with the children of the specified node.
`void`	`replaceChild(ASTNode oldChild, ASTNode newChild)` Replaces the specified child node with another node.
`boolean`	`textContains(char c)` Checks if the specified character is present in the text of this node.

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

- Field Detail
  - EMPTY_ARRAY
```
static final ASTNode[] EMPTY_ARRAY
```
- Method Detail
  - getElementType
```
IElementType getElementType()
```
    Returns the type of this node.
    
    Returns:
    
    the element type.
  - getText
```
java.lang.String getText()
```
    Returns the text of this node.
    Note: This call requires traversing whole subtree, so it can be expensive for composite nodes, and should be avoided if possible.
    
    Returns:
    
    the node text.
  - getChars
```
java.lang.CharSequence getChars()
```
    Returns same text getText() returns but might be more effective eliminating toString() transformation from internal CharSequence representation
    Note: This call requires traversing whole subtree, so it can be expensive for composite nodes, and should be avoided if possible.
    
    Returns:
    
    the node text.
    
    See Also:
    
    PsiElement.textMatches(java.lang.CharSequence), textContains(char)
  - textContains
```
boolean textContains(char c)
```
    Checks if the specified character is present in the text of this node.
    
    Parameters:
    
    c - the character to search for.
    
    Returns:
    
    true if the character is found, false otherwise.
  - getStartOffset
```
int getStartOffset()
```
    Returns the starting offset of the node text in the document.
    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 start offset.
  - getStartOffsetInParent
```
default int getStartOffsetInParent()
```
    Returns the starting offset of the node text relative to getTreeParent().
    
    Returns:
    
    the start offset relative to node parent
  - getTextLength
```
int getTextLength()
```
    Returns the length of the node text.
    
    Returns:
    
    the text length.
  - getTextRange
```
TextRange getTextRange()
```
    Returns the text range (a combination of starting offset in the document and length) for this node.
    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.
  - getTreeParent
```
ASTNode getTreeParent()
```
    Returns the parent of this node in the tree.
    
    Returns:
    
    the parent node.
  - getFirstChildNode
```
ASTNode getFirstChildNode()
```
    Returns the first child of this node in the tree.
    
    Returns:
    
    the first child node.
  - getLastChildNode
```
ASTNode getLastChildNode()
```
    Returns the last child of this node in the tree.
    
    Returns:
    
    the last child node.
  - getTreeNext
```
ASTNode getTreeNext()
```
    Returns the next sibling of this node in the tree.
    
    Returns:
    
    the next sibling node.
  - getTreePrev
```
ASTNode getTreePrev()
```
    Returns the previous sibling of this node in the tree.
    
    Returns:
    
    the previous sibling node.
  - getChildren
```
ASTNode [] getChildren(TokenSet filter)
```
    Returns the list of children of the specified node, optionally filtered by the specified token type filter.
    
    Parameters:
    
    filter - the token set used to filter the returned children, or null if all children should be returned.
    
    Returns:
    
    the children array.
  - addChild
```
void addChild(ASTNode child)
```
    Adds the specified child node as the last child of this node.
    
    Parameters:
    
    child - the child node to add.
  - addChild
```
void addChild(ASTNode child,
              ASTNode anchorBefore)
```
    Adds the specified child node at the specified position in the child list.
    
    Parameters:
    
    child - the child node to add.
    
    anchorBefore - the node before which the child node is inserted (null to add a child as a last node).
  - addLeaf
```
void addLeaf(IElementType leafType,
             java.lang.CharSequence leafText,
             ASTNode anchorBefore)
```
    Add leaf element with specified type and text in the child list.
    
    Parameters:
    
    leafType - type of leaf element to add.
    
    leafText - text of added leaf.
    
    anchorBefore - the node before which the child node is inserted.
  - removeChild
```
void removeChild(ASTNode child)
```
    Removes the specified node from the list of children of this node.
    
    Parameters:
    
    child - the child node to remove.
  - removeRange
```
void removeRange(ASTNode firstNodeToRemove,
                 ASTNode firstNodeToKeep)
```
    Removes a range of nodes from the list of children, starting with firstNodeToRemove, up to and not including firstNodeToKeep.
    
    Parameters:
    
    firstNodeToRemove - the first child node to remove from the tree.
    
    firstNodeToKeep - the first child node to keep in the tree.
  - replaceChild
```
void replaceChild(ASTNode oldChild,
                  ASTNode newChild)
```
    Replaces the specified child node with another node.
    
    Parameters:
    
    oldChild - the child node to replace.
    
    newChild - the node to replace with.
  - replaceAllChildrenToChildrenOf
```
void replaceAllChildrenToChildrenOf(ASTNode anotherParent)
```
    Replaces all child nodes with the children of the specified node.
    
    Parameters:
    
    anotherParent - the parent node whose children are used for replacement.
  - addChildren
```
void addChildren(ASTNode firstChild,
                 ASTNode firstChildToNotAdd,
                 ASTNode anchorBefore)
```
    Adds a range of nodes belonging to the same parent to the list of children of this node, starting with firstChild, up to and not including firstChildToNotAdd.
    
    Parameters:
    
    firstChild - the first node to add.
    
    firstChildToNotAdd - the first child node following firstChild which will not be added to the tree.
    
    anchorBefore - the node before which the child nodes are inserted.
  - clone
```
java.lang.Object clone()
```
    Creates and returns a deep copy of the AST tree part starting at this node.
    
    Returns:
    
    the top node of the copied tree (as an ASTNode object)
  - copyElement
```
ASTNode copyElement()
```
    Creates a copy of the entire AST tree containing this node and returns a counterpart of this node in the resulting tree.
    
    Returns:
    
    the counterpart of this node in the copied tree.
  - findLeafElementAt
```
ASTNode findLeafElementAt(int offset)
```
    Finds a leaf child node at the specified offset from the start of the text range of this node.
    
    Parameters:
    
    offset - the relative offset for which the child node is requested.
    
    Returns:
    
    the child node, or null if none is found.
  - getCopyableUserData
```
<T> T getCopyableUserData(Key<T> key)
```
    Returns a copyable user data object attached to this node.
    
    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 node.
    
    See Also:
    
    putCopyableUserData(Key, Object)
  - putCopyableUserData
```
<T> void putCopyableUserData(Key<T> key,
                             T value)
```
    Attaches a copyable user data object to this node. Copyable user data objects are copied when the AST tree nodes are copied.
    
    Parameters:
    
    key - the key for accessing the user data object.
    
    value - the user data object to attach.
    
    See Also:
    
    getCopyableUserData(Key)
  - findChildByType
```
ASTNode findChildByType(IElementType type)
```
    Returns the first child of the specified node which has the specified type.
    
    Parameters:
    
    type - the type of the node to return.
    
    Returns:
    
    the found node, or null if none was found.
  - findChildByType
```
ASTNode findChildByType(IElementType type,
                        ASTNode anchor)
```
    Returns the first child after anchor of the specified node which has the specified type.
    
    Parameters:
    
    type - the type of the node to return.
    
    anchor - to start search from
    
    Returns:
    
    the found node, or null if none was found.
  - findChildByType
```
ASTNode findChildByType(TokenSet typesSet)
```
    Returns the first child of the specified node which has type from specified set.
    
    Parameters:
    
    typesSet - the token set used to filter the returned children.
    
    Returns:
    
    the found node, or null if none was found.
  - findChildByType
```
ASTNode findChildByType(TokenSet typesSet,
                        ASTNode anchor)
```
    Returns the first child after anchor of the specified node which has type from specified set.
    
    Parameters:
    
    typesSet - the token set used to filter the returned children.
    
    anchor - to start search from
    
    Returns:
    
    the found node, or null if none was found.
  - getPsi
```
PsiElement getPsi()
```
    Returns the PSI element for this node.
    
    Returns:
    
    the PSI element.
  - getPsi
```
<T extends PsiElement> T getPsi(java.lang.Class<T> clazz)
```
    Checks and returns the PSI element for this node.
    
    Parameters:
    
    clazz - expected psi class
    
    Returns:
    
    the PSI element.

Interface ASTNode

Field Summary

Method Summary

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

Field Detail

EMPTY_ARRAY

Method Detail

getElementType

getText

getChars

textContains

getStartOffset

getStartOffsetInParent

getTextLength

getTextRange

getTreeParent

getFirstChildNode

getLastChildNode

getTreeNext

getTreePrev

getChildren

addChild

addChild

addLeaf

removeChild

removeRange

replaceChild

replaceAllChildrenToChildrenOf

addChildren

clone

copyElement

findLeafElementAt

getCopyableUserData

putCopyableUserData

findChildByType

findChildByType

findChildByType

findChildByType

getPsi

getPsi