Package com.intellij.psi.util

Class PsiTreeUtil

java.lang.Object

com.intellij.psi.util.PsiTreeUtil

public class PsiTreeUtil
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PsiTreeUtil()

Method Summary

Modifier and Type	Method and Description
static <T extends PsiElement> java.util.Iterator<T>	childIterator(PsiElement element, java.lang.Class<T> aClass) Deprecated. use SyntaxTraverser.psiTraverser()
static PsiElement []	collectElements(PsiElement element, PsiElementFilter filter)
static <T extends PsiElement> java.util.Collection<T>	collectElementsOfType(PsiElement element, java.lang.Class<T>... classes)
static <T extends PsiElement> java.util.List<T>	collectParents(PsiElement element, java.lang.Class<? extends T> parent, boolean includeMyself, java.util.function.Predicate<? super PsiElement> stopCondition)
static int	countChildrenOfType(PsiElement element, java.lang.Class<? extends PsiElement> clazz)
static PsiElement []	filterAncestors(PsiElement [] elements)
static <T extends PsiElement> T	findChildOfAnyType(PsiElement element, boolean strict, java.lang.Class<? extends T>... classes) Recursive (depth first) search for first element of any of given classes.
static <T extends PsiElement> T	findChildOfAnyType(PsiElement element, java.lang.Class<? extends T>... classes) See findChildOfAnyType(PsiElement, boolean, Class[]).
static <T extends PsiElement> T	findChildOfType(PsiElement element, java.lang.Class<T> aClass) See findChildOfType(PsiElement, Class, boolean, Class).
static <T extends PsiElement> T	findChildOfType(PsiElement element, java.lang.Class<T> aClass, boolean strict) See findChildOfType(PsiElement, Class, boolean, Class).
static <T extends PsiElement> T	findChildOfType(PsiElement element, java.lang.Class<T> aClass, boolean strict, java.lang.Class<? extends PsiElement> stopAt) Recursive (depth first) search for first element of a given class.
static <T extends PsiElement> java.util.Collection<T>	findChildrenOfAnyType(PsiElement element, boolean strict, java.lang.Class<? extends T>... classes) Recursive (depth first) search for all elements of any of given classes.
static <T extends PsiElement> java.util.Collection<T>	findChildrenOfAnyType(PsiElement element, java.lang.Class<? extends T>... classes) See findChildrenOfAnyType(PsiElement, boolean, Class[]).
static <T extends PsiElement> java.util.Collection<T>	findChildrenOfType(PsiElement element, java.lang.Class<? extends T> aClass) See findChildrenOfAnyType(PsiElement, boolean, Class[]).
static PsiElement	findCommonContext(java.util.Collection<? extends PsiElement> elements)
static PsiElement	findCommonContext(PsiElement element1, PsiElement element2)
static PsiElement	findCommonParent(java.util.List<? extends PsiElement> elements)
static PsiElement	findCommonParent(PsiElement... elements)
static PsiElement	findCommonParent(PsiElement element1, PsiElement element2)
static <T extends PsiElement> T	findElementOfClassAtOffset(PsiFile file, int offset, java.lang.Class<T> clazz, boolean strictStart)
static <T extends PsiElement> T	findElementOfClassAtOffsetWithStopSet(PsiFile file, int offset, java.lang.Class<T> clazz, boolean strictStart, java.lang.Class<? extends PsiElement>... stopAt)
static <T extends PsiElement> T	findElementOfClassAtRange(PsiFile file, int startOffset, int endOffset, java.lang.Class<T> clazz)
static PsiElement	findFirstContext(PsiElement element, boolean strict, Condition<? super PsiElement> condition)
static PsiElement	findFirstParent(PsiElement element, boolean strict, Condition<? super PsiElement> condition)
static PsiElement	findFirstParent(PsiElement element, Condition<? super PsiElement> condition)
static PsiElement	findPrevParent(PsiElement ancestor, PsiElement descendant)
static PsiElement	findSiblingBackward(PsiElement element, IElementType elementType, boolean strict, Consumer<? super PsiElement> consumer)
static PsiElement	findSiblingBackward(PsiElement element, IElementType elementType, Consumer<? super PsiElement> consumer)
static PsiElement	findSiblingForward(PsiElement element, IElementType elementType, boolean strict, Consumer<? super PsiElement> consumer)
static PsiElement	findSiblingForward(PsiElement element, IElementType elementType, Consumer<? super PsiElement> consumer)
static PsiElement	firstChild(PsiElement element)
static <T extends PsiElement> T	getChildOfAnyType(PsiElement element, java.lang.Class<? extends T>... classes) Returns a direct child of the specified element having any of the specified classes.
static <T extends PsiElement> T	getChildOfType(PsiElement element, java.lang.Class<T> aClass) Non-recursive search for an element of type T amongst given element children.
static <T extends PsiElement> java.util.List<T>	getChildrenOfAnyType(PsiElement element, java.lang.Class<? extends T>... classes)
static <T extends PsiElement> T []	getChildrenOfType(PsiElement element, java.lang.Class<T> aClass)
static <T extends PsiElement> java.util.List<T>	getChildrenOfTypeAsList(PsiElement element, java.lang.Class<? extends T> aClass)
static <T extends PsiElement> T	getContextOfType(PsiElement element, boolean strict, java.lang.Class<? extends T>... classes)
static <T extends PsiElement> T	getContextOfType(PsiElement element, java.lang.Class<? extends T>... classes)
static <T extends PsiElement> T	getContextOfType(PsiElement element, java.lang.Class<? extends T> aClass, boolean strict)
static <T extends PsiElement> T	getContextOfType(PsiElement element, java.lang.Class<T> aClass, boolean strict, java.lang.Class<? extends PsiElement>... stopAt)
static PsiElement	getDeepestFirst(PsiElement elt)
static PsiElement	getDeepestLast(PsiElement elt)
static PsiElement	getDeepestVisibleFirst(PsiElement psiElement)
static PsiElement	getDeepestVisibleLast(PsiElement psiElement)
static int	getDepth(PsiElement element, PsiElement topLevel)
static java.util.List<PsiElement>	getElementsOfRange(PsiElement start, PsiElement end)
static java.util.List<PsiElement>	getInjectedElements(OuterLanguageElement outerLanguageElement)
static <T extends PsiElement> T	getNextSiblingOfType(PsiElement sibling, java.lang.Class<T> aClass)
static <T extends PsiElement> T	getNonStrictParentOfType(PsiElement element, java.lang.Class<? extends T>... classes)
static <T extends PsiElement> T	getParentOfType(PsiElement element, java.lang.Class<? extends T>... classes)
static <T extends PsiElement> T	getParentOfType(PsiElement element, java.lang.Class<T> aClass)
static <T extends PsiElement> T	getParentOfType(PsiElement element, java.lang.Class<T> aClass, boolean strict)
static <T extends PsiElement> T	getParentOfType(PsiElement element, java.lang.Class<T> aClass, boolean strict, java.lang.Class<? extends PsiElement>... stopAt)
static <T extends PsiElement> T	getParentOfType(PsiElement element, java.lang.Class<T> aClass, boolean strict, int minStartOffset)
static <T extends PsiElement> T	getPrevSiblingOfType(PsiElement sibling, java.lang.Class<T> aClass)
static <T extends PsiElement> T	getRequiredChildOfType(PsiElement element, java.lang.Class<T> aClass)
static <T extends PsiElement> T	getStubChildOfType(PsiElement element, java.lang.Class<T> aClass)
static <T extends PsiElement> java.util.List<T>	getStubChildrenOfTypeAsList(PsiElement element, java.lang.Class<? extends T> aClass)
static PsiElement	getStubOrPsiParent(PsiElement element)
static <E extends PsiElement> E	getStubOrPsiParentOfType(PsiElement element, java.lang.Class<E> parentClass)
static <T extends PsiElement> T	getTopmostParentOfType(PsiElement element, java.lang.Class<T> aClass)
static boolean	hasErrorElements(PsiElement element)
static boolean	instanceOf(java.lang.Object object, java.lang.Class<?>... classes)
static boolean	isAncestor(PsiElement ancestor, PsiElement element, boolean strict) Checks whether one element in the psi tree is under another.
static boolean	isContextAncestor(PsiElement ancestor, PsiElement element, boolean strict) Checks whether one element in the psi tree is under another in a PsiElement.getContext() hierarchy.
static PsiElement	lastChild(PsiElement element)
static void	mark(PsiElement element, java.lang.Object marker)
static PsiElement	nextLeaf(PsiElement current)
static PsiElement	nextLeaf(PsiElement element, boolean skipEmptyElements)
static PsiElement	nextVisibleLeaf(PsiElement element)
static PsiElement	prevLeaf(PsiElement current)
static PsiElement	prevLeaf(PsiElement element, boolean skipEmptyElements)
static PsiElement	prevVisibleLeaf(PsiElement element)
static boolean	processElements(PsiElementProcessor processor, PsiElement... elements)
static boolean	processElements(PsiElement element, PsiElementProcessor processor)
static PsiElement	releaseMark(PsiElement root, java.lang.Object marker)
static PsiElement	skipParentsOfType(PsiElement element, java.lang.Class<? extends PsiElement>... parentClasses)
static PsiElement	skipSiblingsBackward(PsiElement element, java.lang.Class<? extends PsiElement>... elementClasses)
static PsiElement	skipSiblingsForward(PsiElement element, java.lang.Class<? extends PsiElement>... elementClasses)
static PsiElement	skipWhitespacesAndCommentsBackward(PsiElement element)
static PsiElement	skipWhitespacesAndCommentsForward(PsiElement element)
static PsiElement	skipWhitespacesBackward(PsiElement element)
static PsiElement	skipWhitespacesForward(PsiElement element)
static boolean	treeWalkUp(PsiElement entrance, PsiElement maxScope, PairProcessor<? super PsiElement,? super PsiElement> eachScopeAndLastParent)
static boolean	treeWalkUp(PsiScopeProcessor processor, PsiElement entrance, PsiElement maxScope, ResolveState state)

Methods inherited from class java.lang.Object

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

Constructor Detail

PsiTreeUtil

public PsiTreeUtil()

Method Detail

isAncestor

public static boolean isAncestor(PsiElement ancestor,
                                 PsiElement element,
                                 boolean strict)

Checks whether one element in the psi tree is under another.

Parameters:

ancestor - parent candidate. false will be returned if ancestor is null.

element - child candidate

strict - whether return true if ancestor and parent are the same.

Returns:

true if element has ancestor as its parent somewhere in the hierarchy and false otherwise.

isContextAncestor

public static boolean isContextAncestor(PsiElement ancestor,
                                        PsiElement element,
                                        boolean strict)

Checks whether one element in the psi tree is under another in a PsiElement.getContext() hierarchy.

Parameters:

ancestor - parent candidate. false will be returned if ancestor is null.

element - child candidate

strict - whether return true if ancestor and parent are the same.

Returns:

true if element has ancestor as its parent somewhere in the hierarchy and false otherwise.

findCommonParent

public static PsiElement findCommonParent(java.util.List<? extends PsiElement> elements)

findCommonParent

public static PsiElement findCommonParent(PsiElement... elements)

findCommonParent

public static PsiElement findCommonParent(PsiElement element1,
                                          PsiElement element2)

getDepth

public static int getDepth(PsiElement element,
                           PsiElement topLevel)

findCommonContext

public static PsiElement findCommonContext(java.util.Collection<? extends PsiElement> elements)

findCommonContext

public static PsiElement findCommonContext(PsiElement element1,
                                           PsiElement element2)

findChildOfType

public static <T extends PsiElement> T findChildOfType(PsiElement element,
                                                       java.lang.Class<T> aClass)

See findChildOfType(PsiElement, Class, boolean, Class).

findChildOfType

public static <T extends PsiElement> T findChildOfType(PsiElement element,
                                                       java.lang.Class<T> aClass,
                                                       boolean strict)

See findChildOfType(PsiElement, Class, boolean, Class).

findChildOfType

public static <T extends PsiElement> T findChildOfType(PsiElement element,
                                                       java.lang.Class<T> aClass,
                                                       boolean strict,
                                                       java.lang.Class<? extends PsiElement> stopAt)

Recursive (depth first) search for first element of a given class.

Type Parameters:

T - type to cast found element to

Parameters:

element - a PSI element to start search from

strict - if false the element is also included in the search

aClass - element type to search for

stopAt - element type to abort the search at

Returns:

first found element, or null if nothing found

findChildOfAnyType

@SafeVarargs
public static <T extends PsiElement> T findChildOfAnyType(PsiElement element,
                                                          java.lang.Class<? extends T>... classes)

See findChildOfAnyType(PsiElement, boolean, Class[]).

findChildOfAnyType

@SafeVarargs
public static <T extends PsiElement> T findChildOfAnyType(PsiElement element,
                                                          boolean strict,
                                                          java.lang.Class<? extends T>... classes)

Recursive (depth first) search for first element of any of given classes.

Type Parameters:

T - type to cast found element to.

Parameters:

element - a PSI element to start search from.

strict - if false the element is also included in the search.

classes - element types to search for.

Returns:

first found element, or null if nothing found.

findChildrenOfType

public static <T extends PsiElement> java.util.Collection<T> findChildrenOfType(PsiElement element,
                                                                                java.lang.Class<? extends T> aClass)

See findChildrenOfAnyType(PsiElement, boolean, Class[]).

findChildrenOfAnyType

@SafeVarargs
public static <T extends PsiElement> java.util.Collection<T> findChildrenOfAnyType(PsiElement element,
                                                                                   java.lang.Class<? extends T>... classes)

See findChildrenOfAnyType(PsiElement, boolean, Class[]).

findChildrenOfAnyType

@SafeVarargs
public static <T extends PsiElement> java.util.Collection<T> findChildrenOfAnyType(PsiElement element,
                                                                                   boolean strict,
                                                                                   java.lang.Class<? extends T>... classes)

Recursive (depth first) search for all elements of any of given classes.

Type Parameters:

T - type to cast found elements to.

Parameters:

element - a PSI element to start search from.

strict - if false the element is also included in the search.

classes - element types to search for.

Returns:

Collection<T> of all found elements, or empty List<T> if nothing found.

getChildOfType

public static <T extends PsiElement> T getChildOfType(PsiElement element,
                                                      java.lang.Class<T> aClass)

Non-recursive search for an element of type T amongst given element children.

Type Parameters:

T - element type to search for.

Parameters:

element - a PSI element to start search from.

aClass - element type to search for.

Returns:

first found element, or null if nothing found.

findFirstParent

public static PsiElement findFirstParent(PsiElement element,
                                         Condition<? super PsiElement> condition)

findFirstParent

public static PsiElement findFirstParent(PsiElement element,
                                         boolean strict,
                                         Condition<? super PsiElement> condition)

findFirstContext

public static PsiElement findFirstContext(PsiElement element,
                                          boolean strict,
                                          Condition<? super PsiElement> condition)

getRequiredChildOfType

public static <T extends PsiElement> T getRequiredChildOfType(PsiElement element,
                                                              java.lang.Class<T> aClass)

countChildrenOfType

public static int countChildrenOfType(PsiElement element,
                                      java.lang.Class<? extends PsiElement> clazz)

getChildrenOfType

public static <T extends PsiElement> T [] getChildrenOfType(PsiElement element,
                                                            java.lang.Class<T> aClass)

getChildrenOfAnyType

@SafeVarargs
public static <T extends PsiElement> java.util.List<T> getChildrenOfAnyType(PsiElement element,
                                                                            java.lang.Class<? extends T>... classes)

getChildrenOfTypeAsList

public static <T extends PsiElement> java.util.List<T> getChildrenOfTypeAsList(PsiElement element,
                                                                               java.lang.Class<? extends T> aClass)

getElementsOfRange

public static java.util.List<PsiElement> getElementsOfRange(PsiElement start,
                                                            PsiElement end)

getStubChildOfType

public static <T extends PsiElement> T getStubChildOfType(PsiElement element,
                                                          java.lang.Class<T> aClass)

getStubChildrenOfTypeAsList

public static <T extends PsiElement> java.util.List<T> getStubChildrenOfTypeAsList(PsiElement element,
                                                                                   java.lang.Class<? extends T> aClass)

instanceOf

public static boolean instanceOf(java.lang.Object object,
                                 java.lang.Class<?>... classes)

getChildOfAnyType

@SafeVarargs
public static <T extends PsiElement> T getChildOfAnyType(PsiElement element,
                                                         java.lang.Class<? extends T>... classes)

Returns a direct child of the specified element having any of the specified classes.

Parameters:

element - the element to get the child for.

classes - the array of classes.

Returns:

the element, or null if none was found.

getNextSiblingOfType

public static <T extends PsiElement> T getNextSiblingOfType(PsiElement sibling,
                                                            java.lang.Class<T> aClass)

getPrevSiblingOfType

public static <T extends PsiElement> T getPrevSiblingOfType(PsiElement sibling,
                                                            java.lang.Class<T> aClass)

getTopmostParentOfType

public static <T extends PsiElement> T getTopmostParentOfType(PsiElement element,
                                                              java.lang.Class<T> aClass)

getParentOfType

public static <T extends PsiElement> T getParentOfType(PsiElement element,
                                                       java.lang.Class<T> aClass)

getStubOrPsiParent

public static PsiElement getStubOrPsiParent(PsiElement element)

getStubOrPsiParentOfType

public static <E extends PsiElement> E getStubOrPsiParentOfType(PsiElement element,
                                                                java.lang.Class<E> parentClass)

getContextOfType

@SafeVarargs
public static <T extends PsiElement> T getContextOfType(PsiElement element,
                                                        java.lang.Class<T> aClass,
                                                        boolean strict,
                                                        java.lang.Class<? extends PsiElement>... stopAt)

getContextOfType

public static <T extends PsiElement> T getContextOfType(PsiElement element,
                                                        java.lang.Class<? extends T> aClass,
                                                        boolean strict)

getContextOfType

@SafeVarargs
public static <T extends PsiElement> T getContextOfType(PsiElement element,
                                                        java.lang.Class<? extends T>... classes)

getContextOfType

@SafeVarargs
public static <T extends PsiElement> T getContextOfType(PsiElement element,
                                                        boolean strict,
                                                        java.lang.Class<? extends T>... classes)

getParentOfType

public static <T extends PsiElement> T getParentOfType(PsiElement element,
                                                       java.lang.Class<T> aClass,
                                                       boolean strict)

getParentOfType

public static <T extends PsiElement> T getParentOfType(PsiElement element,
                                                       java.lang.Class<T> aClass,
                                                       boolean strict,
                                                       int minStartOffset)

getParentOfType

@SafeVarargs
public static <T extends PsiElement> T getParentOfType(PsiElement element,
                                                       java.lang.Class<T> aClass,
                                                       boolean strict,
                                                       java.lang.Class<? extends PsiElement>... stopAt)

collectParents

public static <T extends PsiElement> java.util.List<T> collectParents(PsiElement element,
                                                                      java.lang.Class<? extends T> parent,
                                                                      boolean includeMyself,
                                                                      java.util.function.Predicate<? super PsiElement> stopCondition)

findSiblingForward

public static PsiElement findSiblingForward(PsiElement element,
                                            IElementType elementType,
                                            Consumer<? super PsiElement> consumer)

findSiblingForward

public static PsiElement findSiblingForward(PsiElement element,
                                            IElementType elementType,
                                            boolean strict,
                                            Consumer<? super PsiElement> consumer)

findSiblingBackward

public static PsiElement findSiblingBackward(PsiElement element,
                                             IElementType elementType,
                                             Consumer<? super PsiElement> consumer)

findSiblingBackward

public static PsiElement findSiblingBackward(PsiElement element,
                                             IElementType elementType,
                                             boolean strict,
                                             Consumer<? super PsiElement> consumer)

skipSiblingsForward

@SafeVarargs
public static PsiElement skipSiblingsForward(PsiElement element,
                                             java.lang.Class<? extends PsiElement>... elementClasses)

skipWhitespacesForward

public static PsiElement skipWhitespacesForward(PsiElement element)

skipWhitespacesAndCommentsForward

public static PsiElement skipWhitespacesAndCommentsForward(PsiElement element)

skipSiblingsBackward

@SafeVarargs
public static PsiElement skipSiblingsBackward(PsiElement element,
                                              java.lang.Class<? extends PsiElement>... elementClasses)

skipWhitespacesBackward

public static PsiElement skipWhitespacesBackward(PsiElement element)

skipWhitespacesAndCommentsBackward

public static PsiElement skipWhitespacesAndCommentsBackward(PsiElement element)

skipParentsOfType

@SafeVarargs
public static PsiElement skipParentsOfType(PsiElement element,
                                           java.lang.Class<? extends PsiElement>... parentClasses)

getParentOfType

@SafeVarargs
public static <T extends PsiElement> T getParentOfType(PsiElement element,
                                                       java.lang.Class<? extends T>... classes)

getNonStrictParentOfType

@SafeVarargs
public static <T extends PsiElement> T getNonStrictParentOfType(PsiElement element,
                                                                java.lang.Class<? extends T>... classes)

collectElements

public static PsiElement [] collectElements(PsiElement element,
                                            PsiElementFilter filter)

collectElementsOfType

@SafeVarargs
public static <T extends PsiElement> java.util.Collection<T> collectElementsOfType(PsiElement element,
                                                                                   java.lang.Class<T>... classes)

processElements

public static boolean processElements(PsiElement element,
                                      PsiElementProcessor processor)

processElements

public static boolean processElements(PsiElementProcessor processor,
                                      PsiElement... elements)

mark

public static void mark(PsiElement element,
                        java.lang.Object marker)

releaseMark

public static PsiElement releaseMark(PsiElement root,
                                     java.lang.Object marker)

findElementOfClassAtOffset

public static <T extends PsiElement> T findElementOfClassAtOffset(PsiFile file,
                                                                  int offset,
                                                                  java.lang.Class<T> clazz,
                                                                  boolean strictStart)

findElementOfClassAtOffsetWithStopSet

@SafeVarargs
public static <T extends PsiElement> T findElementOfClassAtOffsetWithStopSet(PsiFile file,
                                                                             int offset,
                                                                             java.lang.Class<T> clazz,
                                                                             boolean strictStart,
                                                                             java.lang.Class<? extends PsiElement>... stopAt)

findElementOfClassAtRange

public static <T extends PsiElement> T findElementOfClassAtRange(PsiFile file,
                                                                 int startOffset,
                                                                 int endOffset,
                                                                 java.lang.Class<T> clazz)

Returns:

maximal element of specified Class starting at startOffset exactly and ending not farther than endOffset

getDeepestFirst

public static PsiElement getDeepestFirst(PsiElement elt)

getDeepestLast

public static PsiElement getDeepestLast(PsiElement elt)

prevLeaf

public static PsiElement prevLeaf(PsiElement current)

nextLeaf

public static PsiElement nextLeaf(PsiElement current)

lastChild

public static PsiElement lastChild(PsiElement element)

firstChild

public static PsiElement firstChild(PsiElement element)

prevLeaf

public static PsiElement prevLeaf(PsiElement element,
                                  boolean skipEmptyElements)

prevVisibleLeaf

public static PsiElement prevVisibleLeaf(PsiElement element)

nextVisibleLeaf

public static PsiElement nextVisibleLeaf(PsiElement element)

nextLeaf

public static PsiElement nextLeaf(PsiElement element,
                                  boolean skipEmptyElements)

hasErrorElements

public static boolean hasErrorElements(PsiElement element)

filterAncestors

public static PsiElement [] filterAncestors(PsiElement [] elements)

treeWalkUp

public static boolean treeWalkUp(PsiScopeProcessor processor,
                                 PsiElement entrance,
                                 PsiElement maxScope,
                                 ResolveState state)

treeWalkUp

public static boolean treeWalkUp(PsiElement entrance,
                                 PsiElement maxScope,
                                 PairProcessor<? super PsiElement,? super PsiElement> eachScopeAndLastParent)

findPrevParent

public static PsiElement findPrevParent(PsiElement ancestor,
                                        PsiElement descendant)

getInjectedElements

public static java.util.List<PsiElement> getInjectedElements(OuterLanguageElement outerLanguageElement)

getDeepestVisibleFirst

public static PsiElement getDeepestVisibleFirst(PsiElement psiElement)

getDeepestVisibleLast

public static PsiElement getDeepestVisibleLast(PsiElement psiElement)

childIterator

@Deprecated
public static <T extends PsiElement> java.util.Iterator<T> childIterator(PsiElement element,
                                                                         java.lang.Class<T> aClass)

Deprecated. use SyntaxTraverser.psiTraverser()