TreeUtilities (Java Source Base)

java.lang.Object
- org.netbeans.api.java.source.TreeUtilities

public final class TreeUtilities
extends Object

Field Summary

Fields
Modifier and Type Field and Description

static Set<Tree.Kind> CLASS_TREE_KINDS
Tree.Kinds that are represented by ClassTree.

Fields
Modifier and Type	Field and Description
`static Set<Tree.Kind>`	`CLASS_TREE_KINDS` `Tree.Kind`s that are represented by `ClassTree`.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`TypeMirror`	`attributeTree(Tree tree, Scope scope)` Attribute the given tree in the given context.
`Scope`	`attributeTreeTo(Tree tree, Scope scope, Tree to)` Attribute the given tree until the given `to` tree is reached.
`CharSequence`	`decodeIdentifier(CharSequence text)` Decode escapes defined in: https://openjdk.org/projects/coin, 3.1-3.9.
`CharSequence`	`encodeIdentifier(CharSequence ident)` Encode identifier using escapes defined in: https://openjdk.org/projects/coin, 3.1-3.9.
`int[]`	`findBodySpan(ClassTree clazz)` Find span of the `ClassTree`'s body in the source.
`int[]`	`findMethodParameterSpan(MethodTree method)` Find span of the `MethodTree.getParameters()` parameter list in the source.
`int[]`	`findNameSpan(BreakTree brk)` Find span of the `LabeledStatementTree.getLabel()` identifier in the source.
`int[]`	`findNameSpan(ClassTree clazz)` Find span of the `ClassTree.getSimpleName()` identifier in the source.
`int[]`	`findNameSpan(ContinueTree cont)` Find span of the `LabeledStatementTree.getLabel()` identifier in the source.
`int[]`	`findNameSpan(com.sun.source.doctree.DocCommentTree docTree, com.sun.source.doctree.ReferenceTree ref)` Find span of the name in the DocTree's reference tree (see `TreeUtilities.getReferenceName(com.sun.source.util.DocTreePath)` identifier in the source.
`int[]`	`findNameSpan(LabeledStatementTree lst)` Find span of the `LabeledStatementTree.getLabel()` identifier in the source.
`int[]`	`findNameSpan(MemberReferenceTree mst)` Find span of the `MemberReferenceTree.getName()` identifier in the source.
`int[]`	`findNameSpan(MemberSelectTree mst)` Find span of the `MemberSelectTree.getIdentifier()` identifier in the source.
`int[]`	`findNameSpan(MethodTree method)` Find span of the `MethodTree.getName()` identifier in the source.
`int[]`	`findNameSpan(TypeParameterTree tpt)` Find span of the `TypeParameterTree.getName()` identifier in the source.
`int[]`	`findNameSpan(VariableTree var)` Find span of the `VariableTree.getName()` identifier in the source.
`StatementTree`	`getBreakContinueTarget(TreePath breakOrContinue)` Find the target of `break` or `continue`.
`Tree`	`getBreakContinueTargetTree(TreePath breakOrContinue)` Find the target of `break` or `continue`.
`List<Comment>`	`getComments(Tree tree, boolean preceding)` Returns list of comments attached to a given tree.
`TreePath`	`getPathElementOfKind(Set<Tree.Kind> kinds, TreePath path)` Returns path to the deepest tree of one of the given kinds containing the given starting tree.
`TreePath`	`getPathElementOfKind(Tree.Kind kind, TreePath path)` Returns path to the deepest tree of the given kind containing the given starting tree.
`ExpressionTree`	`getReferenceClass(DocTreePath path)` Find the type (the part before `#`) that is being referenced by the given `ReferenceTree`.
`Name`	`getReferenceName(DocTreePath path)` Find the name (the name after `#`) that is being referenced by the given `ReferenceTree`.
`List<? extends Tree>`	`getReferenceParameters(DocTreePath path)` Find the parameters that are specified in the given `ReferenceTree`.
`Set<TypeMirror>`	`getUncaughtExceptions(TreePath path)` Returns uncaught exceptions inside the given tree path.
`Set<? extends VariableElement>`	`getUninitializedFields(TreePath path)` Returns all uninitialized fields of the given class.
`boolean`	`hasError(Tree tree, String... errors)` Check the tree has compile error in given errors.
`boolean`	`isAccessible(Scope scope, Element member, TypeMirror type)` Deprecated. since 0.111, `Trees.isAccessible(Scope, Element, DeclaredType)` should be used instead.
`boolean`	`isAnnotation(ClassTree tree)` Deprecated. since 0.67, `Tree.getKind() == Kind.ANNOTATION_TYPE` should be used instead.
`boolean`	`isClass(ClassTree tree)` Deprecated. since 0.67, `Tree.getKind() == Kind.CLASS` should be used instead.
`boolean`	`isCompileTimeConstantExpression(TreePath expression)` Checks whether the given expression is a compile-time constant, as per JLS 15.28.
`boolean`	`isEndOfCompoundVariableDeclaration(Tree tree)` Check the tree is the end of compound declaration.
`boolean`	`isEnum(ClassTree tree)` Deprecated. since 0.67, `Tree.getKind() == Kind.ENUM` should be used instead.
`boolean`	`isEnumConstant(VariableTree tree)` Checks whether given variable tree represents an enum constant.
`boolean`	`isExpressionStatement(ExpressionTree tree)` Checks whether given expression represents an expression statement.
`boolean`	`isInterface(ClassTree tree)` Deprecated. since 0.67, `Tree.getKind() == Kind.INTERFACE` should be used instead.
`boolean`	`isModuleInfo(CompilationUnitTree tree)` Checks whether given compilation unit represents a module-info.
`boolean`	`isPackageInfo(CompilationUnitTree tree)` Checks whether given compilation unit represents a package-info.
`boolean`	`isPartOfCompoundVariableDeclaration(Tree tree)` Checks whether tree is part of compound variable declaration.
`boolean`	`isStaticContext(Scope scope)` Checks whether the given scope is in "static" context.
`boolean`	`isSynthetic(TreePath path)` Returns whether or not the given tree is synthetic - generated by the parser.
`boolean`	`isVarType(TreePath path)` Check the var type variable in given tree path `TreePath`.
`ExpressionTree`	`parseExpression(String expr, SourcePositions[] sourcePositions)` Parses given expression.
`StatementTree`	`parseStatement(String stmt, SourcePositions[] sourcePositions)` Parses given statement.
`BlockTree`	`parseStaticBlock(String block, SourcePositions[] sourcePositions)` Parses given static block.
`TypeMirror`	`parseType(String expr, TypeElement scope)` Parses given type in given context.
`ExpressionTree`	`parseVariableInitializer(String init, SourcePositions[] sourcePositions)` Parses given variable initializer.
`DocTreePath`	`pathFor(DocTreePath path, int pos)` Return the deepest DocTreePath at the given position.
`DocTreePath`	`pathFor(DocTreePath path, int pos, DocSourcePositions sourcePositions)` Return the deepest DocTreePath at the given position.
`TreePath`	`pathFor(int pos)`
`DocTreePath`	`pathFor(TreePath treepath, com.sun.source.doctree.DocCommentTree doc, int pos)` Return the deepest DocTreePath at the given position.
`TreePath`	`pathFor(TreePath path, int pos)`
`TreePath`	`pathFor(TreePath path, int pos, SourcePositions sourcePositions)`
`TypeMirror`	`reattributeTree(Tree tree, Scope scope)`
`Scope`	`reattributeTreeTo(Tree tree, Scope scope, Tree to)`
`Scope`	`scopeFor(int pos)` Computes `Scope` for the given position.
`TokenSequence<org.netbeans.api.java.lexer.JavaTokenId>`	`tokensFor(Tree tree)` Returns tokens for a given tree.
`TokenSequence<org.netbeans.api.java.lexer.JavaTokenId>`	`tokensFor(Tree tree, SourcePositions sourcePositions)` Returns tokens for a given tree.
`Scope`	`toScopeWithDisabledAccessibilityChecks(Scope scope)` Creates `Scope` capable to access all private methods and fields when parsing and evaluating expressions.
`com.sun.source.doctree.DocTree`	`translate(com.sun.source.doctree.DocTree original, Map<? extends com.sun.source.doctree.DocTree,? extends com.sun.source.doctree.DocTree> original2Translated)` Returns new tree based on `original`, such that each visited subtree that occurs as a key in `original2Translated` is replaced by the corresponding value from `original2Translated`.
`Tree`	`translate(Tree original, Map<? extends Tree,? extends Tree> original2Translated)` Returns new tree based on `original`, such that each visited subtree that occurs as a key in `original2Translated` is replaced by the corresponding value from `original2Translated`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CLASS_TREE_KINDS
```
public static final Set<Tree.Kind> CLASS_TREE_KINDS
```
    Tree.Kinds that are represented by ClassTree.
    
    Since:
    
    0.67
- Method Detail
  - isClass
```
@Deprecated
public boolean isClass(ClassTree tree)
```
    Deprecated. since 0.67, Tree.getKind() == Kind.CLASS should be used instead.
    
    Checks whether the given tree represents a class.
  - isInterface
```
@Deprecated
public boolean isInterface(ClassTree tree)
```
    Deprecated. since 0.67, Tree.getKind() == Kind.INTERFACE should be used instead.
    
    Checks whether the given tree represents an interface.
  - isEnum
```
@Deprecated
public boolean isEnum(ClassTree tree)
```
    Deprecated. since 0.67, Tree.getKind() == Kind.ENUM should be used instead.
    
    Checks whether the given tree represents an enum.
  - isEnumConstant
```
public boolean isEnumConstant(VariableTree tree)
```
    Checks whether given variable tree represents an enum constant.
  - isAnnotation
```
@Deprecated
public boolean isAnnotation(ClassTree tree)
```
    Deprecated. since 0.67, Tree.getKind() == Kind.ANNOTATION_TYPE should be used instead.
    
    Checks whether the given tree represents an annotation.
  - isPackageInfo
```
public boolean isPackageInfo(CompilationUnitTree tree)
```
    Checks whether given compilation unit represents a package-info.
    
    Since:
    
    2.23
  - isModuleInfo
```
public boolean isModuleInfo(CompilationUnitTree tree)
```
    Checks whether given compilation unit represents a module-info.
    
    Since:
    
    2.23
  - isExpressionStatement
```
public boolean isExpressionStatement(ExpressionTree tree)
```
    Checks whether given expression represents an expression statement.
    
    Since:
    
    2.56
  - isSynthetic
```
public boolean isSynthetic(TreePath path)
                    throws NullPointerException
```
    Returns whether or not the given tree is synthetic - generated by the parser. Please note that this method does not check trees transitively - a child of a syntetic tree may be considered non-syntetic.
    
    Returns:
    
    true if the given tree is synthetic, false otherwise
    
    Throws:
    
    NullPointerException - if the given tree is null
  - getPathElementOfKind
```
public TreePath getPathElementOfKind(Tree.Kind kind,
                                     TreePath path)
```
    Returns path to the deepest tree of the given kind containing the given starting tree.
    
    Parameters:
    
    kind - requested tree kind
    
    path - path to the starting tree
    
    Returns:
    
    requested path or null if no tree of the given kind encloses the given starting tree
    
    Since:
    
    0.136
  - getPathElementOfKind
```
public TreePath getPathElementOfKind(Set<Tree.Kind> kinds,
                                     TreePath path)
```
    Returns path to the deepest tree of one of the given kinds containing the given starting tree.
    
    Parameters:
    
    kinds - requested tree kinds
    
    path - path to the starting tree
    
    Returns:
    
    requested path or null if no tree of the given kinds encloses the given starting tree
    
    Since:
    
    0.136
  - getComments
```
public List<Comment> getComments(Tree tree,
                                 boolean preceding)
```
    Returns list of comments attached to a given tree. Can return either preceding or trailing comments.
    
    Parameters:
    
    tree - for which comments should be returned
    
    preceding - true if preceding comments should be returned, false if trailing comments should be returned.
    
    Returns:
    
    list of preceding/trailing comments attached to the given tree
  - pathFor
```
public TreePath pathFor(int pos)
```
  - pathFor
```
public TreePath pathFor(TreePath path,
                        int pos)
```
  - pathFor
```
public TreePath pathFor(TreePath path,
                        int pos,
                        SourcePositions sourcePositions)
```
  - pathFor
```
public DocTreePath pathFor(TreePath treepath,
                           com.sun.source.doctree.DocCommentTree doc,
                           int pos)
```
    Return the deepest DocTreePath at the given position.
    
    Parameters:
    
    treepath - for which the doc comment was determined
    
    doc - the documentation comment inside which the search should be performed
    
    pos - the position to search for
    
    Returns:
    
    the deepest DocTreePath at the given position
    
    Since:
    
    0.124
  - pathFor
```
public DocTreePath pathFor(DocTreePath path,
                           int pos)
```
    Return the deepest DocTreePath at the given position.
    
    Parameters:
    
    path - where the search should start
    
    pos - the position to search for
    
    Returns:
    
    the deepest DocTreePath at the given position
    
    Since:
    
    0.124
  - pathFor
```
public DocTreePath pathFor(DocTreePath path,
                           int pos,
                           DocSourcePositions sourcePositions)
```
    Return the deepest DocTreePath at the given position.
    
    Parameters:
    
    path - where the search should start
    
    pos - the position to search for
    
    sourcePositions - to determine spans of DocTrees
    
    Returns:
    
    the deepest DocTreePath at the given position
    
    Since:
    
    0.124
  - parseType
```
public TypeMirror parseType(String expr,
                            TypeElement scope)
```
    Parses given type in given context.
    
    Parameters:
    
    expr - type specification
    
    scope - in which simple names should be resolved
    
    Returns:
    
    parsed TypeMirror or null if the given specification cannot be parsed
  - parseStatement
```
public StatementTree parseStatement(String stmt,
                                    SourcePositions[] sourcePositions)
```
    Parses given statement.
    
    Parameters:
    
    stmt - statement code
    
    sourcePositions - return value - new SourcePositions for the new tree
    
    Returns:
    
    parsed StatementTree or null?
  - parseExpression
```
public ExpressionTree parseExpression(String expr,
                                      SourcePositions[] sourcePositions)
```
    Parses given expression.
    
    Parameters:
    
    expr - expression code
    
    sourcePositions - return value - new SourcePositions for the new tree
    
    Returns:
    
    parsed ExpressionTree or null?
  - parseVariableInitializer
```
public ExpressionTree parseVariableInitializer(String init,
                                               SourcePositions[] sourcePositions)
```
    Parses given variable initializer.
    
    Parameters:
    
    init - initializer code
    
    sourcePositions - return value - new SourcePositions for the new tree
    
    Returns:
    
    parsed ExpressionTree or null?
  - parseStaticBlock
```
public BlockTree parseStaticBlock(String block,
                                  SourcePositions[] sourcePositions)
```
    Parses given static block.
    
    Parameters:
    
    block - block code
    
    sourcePositions - return value - new SourcePositions for the new tree
    
    Returns:
    
    parsed BlockTree or null?
  - scopeFor
```
public Scope scopeFor(int pos)
```
    Computes Scope for the given position.
  - toScopeWithDisabledAccessibilityChecks
```
public Scope toScopeWithDisabledAccessibilityChecks(Scope scope)
```
    Creates Scope capable to access all private methods and fields when parsing and evaluating expressions. When using this Scope, the accessibility checks would not be enforced during a tree attribution.
    
    Parameters:
    
    scope - an existing scope
    
    Returns:
    
    scope with disabled accessibility checks
    
    Since:
    
    0.129
  - attributeTree
```
public TypeMirror attributeTree(Tree tree,
                                Scope scope)
```
    Attribute the given tree in the given context.
  - attributeTreeTo
```
public Scope attributeTreeTo(Tree tree,
                             Scope scope,
                             Tree to)
```
    Attribute the given tree until the given to tree is reached. Returns scope valid at point when to is reached.
  - reattributeTree
```
public TypeMirror reattributeTree(Tree tree,
                                  Scope scope)
```
  - reattributeTreeTo
```
public Scope reattributeTreeTo(Tree tree,
                               Scope scope,
                               Tree to)
```
  - tokensFor
```
public TokenSequence<org.netbeans.api.java.lexer.JavaTokenId> tokensFor(Tree tree)
```
    Returns tokens for a given tree.
  - tokensFor
```
public TokenSequence<org.netbeans.api.java.lexer.JavaTokenId> tokensFor(Tree tree,
                                                                        SourcePositions sourcePositions)
```
    Returns tokens for a given tree. Uses specified SourcePositions.
  - isAccessible
```
@Deprecated
public boolean isAccessible(Scope scope,
                                        Element member,
                                        TypeMirror type)
```
    Deprecated. since 0.111, Trees.isAccessible(Scope, Element, DeclaredType) should be used instead.
    
    Checks whether the given element is accessible as a member of the given type in a given scope.
    
    Parameters:
    
    scope - the scope to be checked
    
    member - the member to be checked
    
    type - the type for which to check if the member is accessible
    
    Returns:
    
    true if member is accessible in type
  - isStaticContext
```
public boolean isStaticContext(Scope scope)
```
    Checks whether the given scope is in "static" context.
  - getUncaughtExceptions
```
public Set<TypeMirror> getUncaughtExceptions(TreePath path)
```
    Returns uncaught exceptions inside the given tree path.
  - getUninitializedFields
```
public Set<? extends VariableElement> getUninitializedFields(TreePath path)
```
    Returns all uninitialized fields of the given class.
    
    Parameters:
    
    path - to class to inspect
    
    Returns:
    
    set of all uninitialized fields
    
    Since:
    
    0.136
  - findBodySpan
```
public int[] findBodySpan(ClassTree clazz)
```
    Find span of the ClassTree's body in the source. Returns starting and ending offset of the body in the source code that was parsed (ie. CompilationInfo.getText(), which may differ from the positions in the source document if it has been already altered.
    
    Parameters:
    
    clazz - class which body should be searched for
    
    Returns:
    
    the span of the body, or null if cannot be found
    
    Since:
    
    0.127
  - findNameSpan
```
public int[] findNameSpan(ClassTree clazz)
```
    Find span of the ClassTree.getSimpleName() identifier in the source. Returns starting and ending offset of the name in the source code that was parsed (ie. CompilationInfo.getText(), which may differ from the positions in the source document if it has been already altered.
    
    Parameters:
    
    clazz - class which name should be searched for
    
    Returns:
    
    the span of the name, or null if cannot be found
    
    Since:
    
    0.25
  - findNameSpan
```
public int[] findNameSpan(MethodTree method)
```
    Find span of the MethodTree.getName() identifier in the source. Returns starting and ending offset of the name in the source code that was parsed (ie. CompilationInfo.getText(), which may differ from the positions in the source document if it has been already altered.
    
    Parameters:
    
    method - method which name should be searched for
    
    Returns:
    
    the span of the name, or null if cannot be found
    
    Since:
    
    0.25
  - findNameSpan
```
public int[] findNameSpan(VariableTree var)
```
    Find span of the VariableTree.getName() identifier in the source. Returns starting and ending offset of the name in the source code that was parsed (ie. CompilationInfo.getText(), which may differ from the positions in the source document if it has been already altered.
    
    Parameters:
    
    var - variable which name should be searched for
    
    Returns:
    
    the span of the name, or null if cannot be found
    
    Since:
    
    0.25
  - findNameSpan
```
public int[] findNameSpan(LabeledStatementTree lst)
```
    Find span of the LabeledStatementTree.getLabel() identifier in the source. Returns starting and ending offset of the name in the source code that was parsed (ie. CompilationInfo.getText(), which may differ from the positions in the source document if it has been already altered.
    
    Parameters:
    
    lst - labeled statement which name should be searched for
    
    Returns:
    
    the span of the name, or null if cannot be found
    
    Since:
    
    0.131
  - findNameSpan
```
public int[] findNameSpan(TypeParameterTree tpt)
```
    Find span of the TypeParameterTree.getName() identifier in the source. Returns starting and ending offset of the name in the source code that was parsed (ie. CompilationInfo.getText(), which may differ from the positions in the source document if it has been already altered.
    
    Parameters:
    
    tpt - type parameter which name should be searched for
    
    Returns:
    
    the span of the name, or null if cannot be found
    
    Since:
    
    0.131
  - findNameSpan
```
public int[] findNameSpan(BreakTree brk)
```
    Find span of the LabeledStatementTree.getLabel() identifier in the source. Returns starting and ending offset of the name in the source code that was parsed (ie. CompilationInfo.getText(), which may differ from the positions in the source document if it has been already altered.
    
    Parameters:
    
    brk - labeled statement which name should be searched for
    
    Returns:
    
    the span of the name, or null if cannot be found
    
    Since:
    
    0.131
  - findNameSpan
```
public int[] findNameSpan(ContinueTree cont)
```
    Find span of the LabeledStatementTree.getLabel() identifier in the source. Returns starting and ending offset of the name in the source code that was parsed (ie. CompilationInfo.getText(), which may differ from the positions in the source document if it has been already altered.
    
    Parameters:
    
    cont - labeled statement which name should be searched for
    
    Returns:
    
    the span of the name, or null if cannot be found
    
    Since:
    
    0.131
  - findMethodParameterSpan
```
@CheckForNull
public int[] findMethodParameterSpan(@NonNull
                                                   MethodTree method)
```
    Find span of the MethodTree.getParameters() parameter list in the source. Returns the position of the opening and closing parentheses of the parameter list in the source code that was parsed (ie. CompilationInfo.getText(), which may differ from the positions in the source document if it has been already altered.
    
    Parameters:
    
    method - method which parameter list should be searched for
    
    Returns:
    
    the span of the parameter list, or null if cannot be found
    
    Since:
    
    0.81
  - findNameSpan
```
public int[] findNameSpan(MemberSelectTree mst)
```
    Find span of the MemberSelectTree.getIdentifier() identifier in the source. Returns starting and ending offset of the name in the source code that was parsed (ie. CompilationInfo.getText(), which may differ from the positions in the source document if it has been already altered.
    
    Parameters:
    
    mst - member select which identifier should be searched for
    
    Returns:
    
    the span of the name, or null if cannot be found
    
    Since:
    
    0.25
  - findNameSpan
```
public int[] findNameSpan(MemberReferenceTree mst)
```
    Find span of the MemberReferenceTree.getName() identifier in the source. Returns starting and ending offset of the name in the source code that was parsed (ie. CompilationInfo.getText(), which may differ from the positions in the source document if it has been already altered.
    
    Parameters:
    
    mst - member reference for which the identifier should be searched for
    
    Returns:
    
    the span of the name, or null if cannot be found
    
    Since:
    
    0.124
  - findNameSpan
```
public int[] findNameSpan(com.sun.source.doctree.DocCommentTree docTree,
                          com.sun.source.doctree.ReferenceTree ref)
```
    Find span of the name in the DocTree's reference tree (see TreeUtilities.getReferenceName(com.sun.source.util.DocTreePath) identifier in the source. Returns starting and ending offset of the name in the source code that was parsed (ie. CompilationInfo.getText(), which may differ from the positions in the source document if it has been already altered.
    
    Parameters:
    
    ref - reference for which the identifier should be found
    
    Returns:
    
    the span of the name, or null if cannot be found
    
    Since:
    
    0.124
  - getBreakContinueTargetTree
```
public Tree getBreakContinueTargetTree(TreePath breakOrContinue)
                                throws IllegalArgumentException
```
    Find the target of break or continue. The given CompilationInfo has to be at least in the JavaSource.Phase.RESOLVED phase.
    
    Parameters:
    
    breakOrContinue - TreePath to the tree that should be inspected. The breakOrContinue.getLeaf().getKind() has to be one of Tree.Kind.BREAK, Tree.Kind.CONTINUE, or Tree.Kind.YIELD, or an IllegalArgumentException is thrown
    
    Returns:
    
    the tree that is the "target" for the given break or continue statement, or null if there is none. Tree can be of type StatementTree or ExpressionTree
    
    Throws:
    
    IllegalArgumentException - if the given tree is not a break or continue tree or if the given CompilationInfo is not in the JavaSource.Phase.RESOLVED phase.
    
    Since:
    
    2.40
  - getBreakContinueTarget
```
public StatementTree getBreakContinueTarget(TreePath breakOrContinue)
                                     throws IllegalArgumentException
```
    Find the target of break or continue. The given CompilationInfo has to be at least in the JavaSource.Phase.RESOLVED phase.
    
    Parameters:
    
    breakOrContinue - TreePath to the tree that should be inspected. The breakOrContinue.getLeaf().getKind() has to be either Tree.Kind.BREAK or Tree.Kind.CONTINUE, or an IllegalArgumentException is thrown
    
    Returns:
    
    the tree that is the "target" for the given break or continue statement, or null if there is none.
    
    Throws:
    
    IllegalArgumentException - if the given tree is not a break or continue tree or if the given CompilationInfo is not in the JavaSource.Phase.RESOLVED phase.
    
    Since:
    
    0.16
  - decodeIdentifier
```
@NonNull
public CharSequence decodeIdentifier(@NonNull
                                              CharSequence text)
```
    Decode escapes defined in: https://openjdk.org/projects/coin, 3.1-3.9. Must be a full token text, including possible #".
    
    Parameters:
    
    text - to decode
    
    Returns:
    
    decoded escapes from the identifier
    
    Since:
    
    0.56
    
    See Also:
    
    ProjectCoinProposal
  - encodeIdentifier
```
@NonNull
public CharSequence encodeIdentifier(@NonNull
                                              CharSequence ident)
```
    Encode identifier using escapes defined in: https://openjdk.org/projects/coin, 3.1-3.9.
    
    Parameters:
    
    ident - to encode
    
    Returns:
    
    encoded identifier, including #" if necessary
    
    Since:
    
    0.56
    
    See Also:
    
    ProjectCoinProposal
  - translate
```
@NonNull
public Tree translate(@NonNull
                               Tree original,
                               @NonNull
                               Map<? extends Tree,? extends Tree> original2Translated)
```
    Returns new tree based on original, such that each visited subtree that occurs as a key in original2Translated is replaced by the corresponding value from original2Translated. The value is then translated using the same algorithm. Each key from original2Translated is used at most once. Unless the provided original tree is a key in original2Translated, the resulting tree has the same type as original. Principally, the method inner workings are:
```
 translate(original, original2Translated) {
      if (original2Translated.containsKey(original))
          return translate(original2Translated.remove(original));
      newTree = copyOf(original);
      for (Tree child : allChildrenOf(original)) {
          newTree.replace(child, translate(child, original2Translated));
      }
      return newTree;
 }
 
```
    Parameters:
    
    original - the tree that should be translated
    
    original2Translated - map containing trees that should be translated
    
    Returns:
    
    translated tree.
    
    Since:
    
    0.64
  - translate
```
@NonNull
public com.sun.source.doctree.DocTree translate(@NonNull
                                                         com.sun.source.doctree.DocTree original,
                                                         @NonNull
                                                         Map<? extends com.sun.source.doctree.DocTree,? extends com.sun.source.doctree.DocTree> original2Translated)
```
    Returns new tree based on original, such that each visited subtree that occurs as a key in original2Translated is replaced by the corresponding value from original2Translated. The value is then translated using the same algorithm. Each key from original2Translated is used at most once. Unless the provided original tree is a key in original2Translated, the resulting tree has the same type as original. Principally, the method inner workings are:
```
 translate(original, original2Translated) {
      if (original2Translated.containsKey(original))
          return translate(original2Translated.remove(original));
      newTree = copyOf(original);
      for (Tree child : allChildrenOf(original)) {
          newTree.replace(child, translate(child, original2Translated));
      }
      return newTree;
 }
 
```
    Parameters:
    
    original - the tree that should be translated
    
    original2Translated - map containing trees that should be translated
    
    Returns:
    
    translated tree.
    
    Since:
    
    0.124
  - isCompileTimeConstantExpression
```
public boolean isCompileTimeConstantExpression(TreePath expression)
```
    Checks whether the given expression is a compile-time constant, as per JLS 15.28.
    
    Parameters:
    
    expression - the expression to check
    
    Returns:
    
    true if and only if the given expression represents a compile-time constant value
    
    Since:
    
    0.91
  - getReferenceClass
```
@CheckForNull
public ExpressionTree getReferenceClass(@NonNull
                                                      DocTreePath path)
```
    Find the type (the part before #) that is being referenced by the given ReferenceTree.
    
    Parameters:
    
    path - the leaf must be ReferenceTree
    
    Returns:
    
    the referred type, or null if none.
    
    Since:
    
    0.124
  - getReferenceName
```
@CheckForNull
public Name getReferenceName(@NonNull
                                           DocTreePath path)
```
    Find the name (the name after #) that is being referenced by the given ReferenceTree.
    
    Parameters:
    
    path - the leaf must be ReferenceTree
    
    Returns:
    
    the referred member name, or null if none.
    
    Since:
    
    0.124
  - getReferenceParameters
```
@CheckForNull
public List<? extends Tree> getReferenceParameters(@NonNull
                                                                 DocTreePath path)
```
    Find the parameters that are specified in the given ReferenceTree.
    
    Parameters:
    
    path - the leaf must be ReferenceTree
    
    Returns:
    
    the parameters for the referred method, or null if none.
    
    Since:
    
    0.124
  - isVarType
```
public boolean isVarType(@NonNull
                         TreePath path)
```
    Check the var type variable in given tree path TreePath.
    
    Parameters:
    
    path - the path of tree TreePath
    
    Returns:
    
    the true if tree contains var keyword else return false
    
    Since:
    
    2.31.0
  - isEndOfCompoundVariableDeclaration
```
public boolean isEndOfCompoundVariableDeclaration(@NonNull
                                                  Tree tree)
```
    Check the tree is the end of compound declaration. Tree.
    
    Parameters:
    
    tree - the tree Tree
    
    Returns:
    
    the true if tree is end of compound declaration else return false
    
    Since:
    
    2.33.0
  - isPartOfCompoundVariableDeclaration
```
public boolean isPartOfCompoundVariableDeclaration(@NonNull
                                                   Tree tree)
```
    Checks whether tree is part of compound variable declaration.
    
    Parameters:
    
    tree - tree to examine.
    
    Returns:
    
    true if tree is part of compound var declaration.
    
    Since:
    
    2.34.0
  - hasError
```
public boolean hasError(@NonNull
                        Tree tree,
                        String... errors)
```
    Check the tree has compile error in given errors.
    
    Parameters:
    
    tree - compilation tree
    
    errors - Array of error code
    
    Returns:
    
    true if tree has compile error present in list of errors.
    
    Since:
    
    2.37

Class TreeUtilities

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_TREE_KINDS

Method Detail

isClass

isInterface

isEnum

isEnumConstant

isAnnotation

isPackageInfo

isModuleInfo

isExpressionStatement

isSynthetic

getPathElementOfKind

getPathElementOfKind

getComments

pathFor

pathFor

pathFor

pathFor

pathFor

pathFor

parseType

parseStatement

parseExpression

parseVariableInitializer

parseStaticBlock

scopeFor

toScopeWithDisabledAccessibilityChecks

attributeTree

attributeTreeTo

reattributeTree

reattributeTreeTo

tokensFor

tokensFor

isAccessible

isStaticContext

getUncaughtExceptions

getUninitializedFields

findBodySpan

findNameSpan

findNameSpan

findNameSpan

findNameSpan

findNameSpan

findNameSpan

findNameSpan

findMethodParameterSpan

findNameSpan

findNameSpan

findNameSpan

getBreakContinueTargetTree

getBreakContinueTarget

decodeIdentifier

encodeIdentifier

translate

translate

isCompileTimeConstantExpression

getReferenceClass

getReferenceName

getReferenceParameters

isVarType

isEndOfCompoundVariableDeclaration

isPartOfCompoundVariableDeclaration

hasError