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

Class TreeElement

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.source.tree.TreeElement

All Implemented Interfaces:

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

Direct Known Subclasses:

CompositeElement, LeafElement

public abstract class TreeElement
extends ElementBase
implements ASTNode, java.lang.Cloneable

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 TreeElement[]	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
TreeElement(IElementType type)

Method Summary

Modifier and Type	Method and Description
abstract void	acceptTree(TreeElementVisitor visitor)
void	clearCaches()
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.
boolean	equals(java.lang.Object obj)
abstract LeafElement	findLeafElementAt(int offset) Finds a leaf child node at the specified offset from the start of the text range of this node.
abstract int	getCachedLength()
IElementType	getElementType() Returns the type of this node.
abstract TreeElement	getFirstChildNode() Returns the first child of this node in the tree.
abstract TreeElement	getLastChildNode() Returns the last child of this node in the tree.
PsiManagerEx	getManager()
int	getStartOffset() Returns the starting offset of the node text in the document.
int	getStartOffsetInParent() Returns the starting offset of the node text relative to ASTNode.getTreeParent().
int	getTextOffset()
TextRange	getTextRange() Returns the text range (a combination of starting offset in the document and length) for this node.
TreeElement	getTreeNext() Returns the next sibling of this node in the tree.
CompositeElement	getTreeParent() Returns the parent of this node in the tree.
TreeElement	getTreePrev() Returns the previous sibling of this node in the tree.
abstract int	hc()
protected void	invalidate()
protected void	onInvalidated()
void	rawInsertAfterMe(TreeElement firstNew)
void	rawInsertBeforeMe(TreeElement firstNew)
void	rawRemove()
void	rawRemoveUpTo(TreeElement end)
void	rawRemoveUpToLast()
void	rawReplaceWithList(TreeElement firstNew)
boolean	textMatches(java.lang.CharSequence seq)
protected abstract int	textMatches(java.lang.CharSequence buffer, int start)
boolean	textMatches(java.lang.CharSequence buffer, int startOffset, int endOffset)
boolean	textMatches(PsiElement element)
abstract char []	textToCharArray()
java.lang.String	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

addChild, addChild, addChildren, addLeaf, findChildByType, findChildByType, findChildByType, findChildByType, getChars, getChildren, getCopyableUserData, getPsi, getPsi, getText, getTextLength, putCopyableUserData, removeChild, removeRange, replaceAllChildrenToChildrenOf, replaceChild, textContains

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

getUserData, putUserData

Field Detail

EMPTY_ARRAY

public static final TreeElement[] EMPTY_ARRAY

Constructor Detail

TreeElement

public TreeElement(IElementType type)

Method Detail

clone

public java.lang.Object 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 UserDataHolderBase

Returns:

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

copyElement

public ASTNode copyElement()

Description copied from interface: ASTNode

Creates a copy of the entire AST tree containing this node and returns a counterpart of this node in the resulting tree.

Specified by:

copyElement in interface ASTNode

Returns:

the counterpart of this node in the copied tree.

getManager

public PsiManagerEx getManager()

findLeafElementAt

public abstract 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

Parameters:

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

Returns:

the child node, or null if none is found.

textToCharArray

public abstract char [] textToCharArray()

getFirstChildNode

public abstract TreeElement getFirstChildNode()

Description copied from interface: ASTNode

Returns the first child of this node in the tree.

Specified by:

getFirstChildNode in interface ASTNode

Returns:

the first child node.

getLastChildNode

public abstract TreeElement getLastChildNode()

Description copied from interface: ASTNode

Returns the last child of this node in the tree.

Specified by:

getLastChildNode in interface ASTNode

Returns:

the last child node.

getCachedLength

public abstract int getCachedLength()

getTextRange

public TextRange getTextRange()

Description copied from interface: ASTNode

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.

Specified by:

getTextRange in interface ASTNode

Returns:

the text range.

getStartOffset

public int getStartOffset()

Description copied from interface: ASTNode

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.

Specified by:

getStartOffset in interface ASTNode

Returns:

the start offset.

getStartOffsetInParent

public final int getStartOffsetInParent()

Description copied from interface: ASTNode

Returns the starting offset of the node text relative to ASTNode.getTreeParent().

Specified by:

getStartOffsetInParent in interface ASTNode

Returns:

the start offset relative to node parent

getTextOffset

public int getTextOffset()

textMatches

public boolean textMatches(java.lang.CharSequence buffer,
                           int startOffset,
                           int endOffset)

textMatches

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

textMatches

public boolean textMatches(java.lang.CharSequence seq)

textMatches

public boolean textMatches(PsiElement element)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTreeParent

public final CompositeElement getTreeParent()

Description copied from interface: ASTNode

Returns the parent of this node in the tree.

Specified by:

getTreeParent in interface ASTNode

Returns:

the parent node.

getTreePrev

public final TreeElement getTreePrev()

Description copied from interface: ASTNode

Returns the previous sibling of this node in the tree.

Specified by:

getTreePrev in interface ASTNode

Returns:

the previous sibling node.

getTreeNext

public final TreeElement getTreeNext()

Description copied from interface: ASTNode

Returns the next sibling of this node in the tree.

Specified by:

getTreeNext in interface ASTNode

Returns:

the next sibling node.

clearCaches

public void clearCaches()

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hc

public abstract int hc()

acceptTree

public abstract void acceptTree(TreeElementVisitor visitor)

onInvalidated

protected void onInvalidated()

rawInsertBeforeMe

public void rawInsertBeforeMe(TreeElement firstNew)

rawInsertAfterMe

public void rawInsertAfterMe(TreeElement firstNew)

rawRemove

public void rawRemove()

rawReplaceWithList

public void rawReplaceWithList(TreeElement firstNew)

invalidate

protected void invalidate()

rawRemoveUpToLast

public void rawRemoveUpToLast()

rawRemoveUpTo

public void rawRemoveUpTo(TreeElement end)

getElementType

public IElementType getElementType()

Description copied from interface: ASTNode

Returns the type of this node.

Specified by:

getElementType in interface ASTNode

Returns:

the element type.