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

Class CompositeElement

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

All Implemented Interfaces:

ASTNode, Iconable, UserDataHolder, UserDataHolderEx, java.lang.Cloneable

Direct Known Subclasses:

AnnotationElement, AnnotationParamListElement, ClassElement, ClassInitializerElement, CompositePsiElement, EnumConstantElement, FieldElement, ImportListElement, ImportStatementBaseElement, LazyParseableElement, MethodElement, ModifierListElement, NameValuePairElement, PackageAccessibilityStatementElement, ParameterElement, ParameterListElement, RecordHeaderElement, ReferenceListElement, TypeParameterElement, TypeParameterListElement

public class CompositeElement
extends TreeElement

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
static CompositeElement[]	EMPTY_ARRAY

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

FLAGS_LOCKED, ICON_PLACEHOLDER

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

ICON_FLAG_IGNORE_MASK, ICON_FLAG_OPEN, ICON_FLAG_READ_STATUS, ICON_FLAG_VISIBILITY

Constructor Summary

Constructors

Constructor and Description
CompositeElement(IElementType type)

Method Summary

Modifier and Type	Method and Description
void	acceptTree(TreeElementVisitor visitor)
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 lastChild, 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.
TreeElement	addInternal(TreeElement first, ASTNode last, ASTNode anchor, java.lang.Boolean before)
void	addLeaf(IElementType leafType, java.lang.CharSequence leafText, ASTNode anchorBefore) Add leaf element with specified type and text in the child list.
void	clearCaches()
CompositeElement	clone() Creates and returns a deep copy of the AST tree part starting at this node.
int	countChildren(TokenSet filter)
protected PsiElement	createPsiNoLock()
void	deleteChildInternal(ASTNode child)
ASTNode	findChildByRole(int role)
PsiElement	findChildByRoleAsPsiElement(int role)
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 types) 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.
LeafElement	findLeafElementAt(int offset) Finds a leaf child node at the specified offset from the start of the text range of this node.
PsiElement	findPsiChildByType(IElementType type)
PsiElement	findPsiChildByType(TokenSet types)
int	getCachedLength()
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 extends PsiElement> T []	getChildrenAsPsiElements(IElementType type, ArrayFactory<? extends T> constructor)
<T extends PsiElement> T []	getChildrenAsPsiElements(TokenSet filter, ArrayFactory<? extends T> constructor)
int	getChildRole(ASTNode child)
protected int	getChildRole(ASTNode child, int roleCandidate)
TreeElement	getFirstChildNode() Returns the first child of this node in the tree.
TreeElement	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.
java.lang.String	getText() Returns the text of this node.
int	getTextLength() Returns the length of the node text.
int	hc()
void	rawAddChildren(TreeElement first)
void	rawAddChildrenWithoutNotifications(TreeElement first)
TreeElement	rawFirstChild()
TreeElement	rawLastChild()
void	rawRemoveAllChildren()
void	removeAllChildren()
void	removeChild(ASTNode child) Removes the specified node from the list of children of this node.
void	removeRange(ASTNode first, ASTNode firstWhichStayInTree) 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.
void	replaceChildInternal(ASTNode child, TreeElement newElement)
void	setPsi(PsiElement psi)
void	subtreeChanged()
boolean	textContains(char c) Checks if the specified character is present in the text of this node.
protected int	textMatches(java.lang.CharSequence buffer, int start)
char []	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, toString

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.lang.ASTNode

getCopyableUserData, putCopyableUserData

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

getUserData, putUserData

Field Detail

EMPTY_ARRAY

public static final CompositeElement[] EMPTY_ARRAY

Constructor Detail

CompositeElement

public CompositeElement(IElementType type)

Method Detail

clone

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

Returns:

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

subtreeChanged

public void subtreeChanged()

clearCaches

public void clearCaches()

Overrides:

clearCaches in class TreeElement

acceptTree

public void acceptTree(TreeElementVisitor visitor)

Specified by:

acceptTree in class TreeElement

findLeafElementAt

public LeafElement findLeafElementAt(int offset)

Description copied from interface: ASTNode

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

Specified by:

findLeafElementAt in interface ASTNode

Specified by:

findLeafElementAt in class TreeElement

Parameters:

offset - the relative offset for which the child node is requested.

Returns:

the child node, or null if none is found.

findPsiChildByType

public PsiElement findPsiChildByType(IElementType type)

findPsiChildByType

public PsiElement findPsiChildByType(TokenSet types)

findChildByType

public ASTNode findChildByType(IElementType type)

Description copied from interface: ASTNode

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

public ASTNode findChildByType(IElementType type,
                               ASTNode anchor)

Description copied from interface: ASTNode

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

public ASTNode findChildByType(TokenSet types)

Description copied from interface: ASTNode

Returns the first child of the specified node which has type from specified set.

Parameters:

types - the token set used to filter the returned children.

Returns:

the found node, or null if none was found.

findChildByType

public ASTNode findChildByType(TokenSet typesSet,
                               ASTNode anchor)

Description copied from interface: ASTNode

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.

getText

public java.lang.String getText()

Description copied from interface: ASTNode

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

public java.lang.CharSequence getChars()

Description copied from interface: ASTNode

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), ASTNode.textContains(char)

textToCharArray

public char [] textToCharArray()

Specified by:

textToCharArray in class TreeElement

textContains

public boolean textContains(char c)

Description copied from interface: ASTNode

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.

textMatches

protected int textMatches(java.lang.CharSequence buffer,
                          int start)

Specified by:

textMatches in class TreeElement

findChildByRoleAsPsiElement

public final PsiElement findChildByRoleAsPsiElement(int role)

findChildByRole

public ASTNode findChildByRole(int role)

getChildRole

public int getChildRole(ASTNode child)

getChildRole

protected final int getChildRole(ASTNode child,
                                 int roleCandidate)

getChildren

public ASTNode [] getChildren(TokenSet filter)

Description copied from interface: ASTNode

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.

getChildrenAsPsiElements

public <T extends PsiElement> T [] getChildrenAsPsiElements(TokenSet filter,
                                                            ArrayFactory<? extends T> constructor)

getChildrenAsPsiElements

public <T extends PsiElement> T [] getChildrenAsPsiElements(IElementType type,
                                                            ArrayFactory<? extends T> constructor)

countChildren

public int countChildren(TokenSet filter)

addInternal

public TreeElement addInternal(TreeElement first,
                               ASTNode last,
                               ASTNode anchor,
                               java.lang.Boolean before)

Returns:

First element that was appended (for example whitespaces could be skipped)

deleteChildInternal

public void deleteChildInternal(ASTNode child)

replaceChildInternal

public void replaceChildInternal(ASTNode child,
                                 TreeElement newElement)

getTextLength

public int getTextLength()

Description copied from interface: ASTNode

Returns the length of the node text.

Returns:

the text length.

hc

public int hc()

Specified by:

hc in class TreeElement

getCachedLength

public int getCachedLength()

Specified by:

getCachedLength in class TreeElement

getFirstChildNode

public TreeElement getFirstChildNode()

Description copied from interface: ASTNode

Returns the first child of this node in the tree.

Specified by:

getFirstChildNode in interface ASTNode

Specified by:

getFirstChildNode in class TreeElement

Returns:

the first child node.

getLastChildNode

public TreeElement getLastChildNode()

Description copied from interface: ASTNode

Returns the last child of this node in the tree.

Specified by:

getLastChildNode in interface ASTNode

Specified by:

getLastChildNode in class TreeElement

Returns:

the last child node.

addChild

public void addChild(ASTNode child,
                     ASTNode anchorBefore)

Description copied from interface: ASTNode

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

public void addLeaf(IElementType leafType,
                    java.lang.CharSequence leafText,
                    ASTNode anchorBefore)

Description copied from interface: ASTNode

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.

addChild

public void addChild(ASTNode child)

Description copied from interface: ASTNode

Adds the specified child node as the last child of this node.

Parameters:

child - the child node to add.

removeChild

public void removeChild(ASTNode child)

Description copied from interface: ASTNode

Removes the specified node from the list of children of this node.

Parameters:

child - the child node to remove.

removeRange

public void removeRange(ASTNode first,
                        ASTNode firstWhichStayInTree)

Description copied from interface: ASTNode

Removes a range of nodes from the list of children, starting with firstNodeToRemove, up to and not including firstNodeToKeep.

Parameters:

first - the first child node to remove from the tree.

firstWhichStayInTree - the first child node to keep in the tree.

replaceChild

public void replaceChild(ASTNode oldChild,
                         ASTNode newChild)

Description copied from interface: ASTNode

Replaces the specified child node with another node.

Parameters:

oldChild - the child node to replace.

newChild - the node to replace with.

replaceAllChildrenToChildrenOf

public void replaceAllChildrenToChildrenOf(ASTNode anotherParent)

Description copied from interface: ASTNode

Replaces all child nodes with the children of the specified node.

Parameters:

anotherParent - the parent node whose children are used for replacement.

removeAllChildren

public void removeAllChildren()

addChildren

public void addChildren(ASTNode firstChild,
                        ASTNode lastChild,
                        ASTNode anchorBefore)

Description copied from interface: ASTNode

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.

lastChild - the first child node following firstChild which will not be added to the tree.

anchorBefore - the node before which the child nodes are inserted.

getPsi

public final PsiElement getPsi()

Description copied from interface: ASTNode

Returns the PSI element for this node.

Returns:

the PSI element.

getPsi

public <T extends PsiElement> T getPsi(java.lang.Class<T> clazz)

Description copied from interface: ASTNode

Checks and returns the PSI element for this node.

Parameters:

clazz - expected psi class

Returns:

the PSI element.

createPsiNoLock

protected PsiElement createPsiNoLock()

setPsi

public void setPsi(PsiElement psi)

rawAddChildren

public final void rawAddChildren(TreeElement first)

rawAddChildrenWithoutNotifications

public void rawAddChildrenWithoutNotifications(TreeElement first)

rawRemoveAllChildren

public void rawRemoveAllChildren()

rawFirstChild

public TreeElement rawFirstChild()

rawLastChild

public TreeElement rawLastChild()