org.checkerframework.javacutil

Class TreeUtils

java.lang.Object

org.checkerframework.javacutil.TreeUtils

public final class TreeUtils
extends java.lang.Object

A utility class made for helping to analyze a given Tree.

Method Summary

Modifier and Type	Method and Description
static javax.lang.model.element.AnnotationMirror	annotationFromAnnotationTree(com.sun.source.tree.AnnotationTree tree)
static java.util.List<? extends javax.lang.model.element.AnnotationMirror>	annotationsFromArrayCreation(com.sun.source.tree.NewArrayTree node, int level)
static java.util.List<? extends javax.lang.model.element.AnnotationMirror>	annotationsFromTree(com.sun.source.tree.AnnotatedTypeTree node)
static java.util.List<? extends javax.lang.model.element.AnnotationMirror>	annotationsFromTree(com.sun.source.tree.TypeParameterTree node)
static java.util.List<javax.lang.model.element.AnnotationMirror>	annotationsFromTypeAnnotationTrees(java.util.List<? extends com.sun.source.tree.AnnotationTree> annos)
static boolean	canHaveTypeAnnotation(com.sun.source.tree.Tree tree)
static java.util.Set<com.sun.source.tree.Tree.Kind>	classTreeKinds()
static javax.lang.model.element.ExecutableElement	constructor(com.sun.source.tree.NewClassTree tree) Determines the symbol for a constructor given an invocation via new.
static boolean	containsThisConstructorInvocation(com.sun.source.tree.MethodTree node)
static javax.lang.model.element.TypeElement	elementFromDeclaration(com.sun.source.tree.ClassTree node) Gets the element for a class corresponding to a declaration.
static javax.lang.model.element.ExecutableElement	elementFromDeclaration(com.sun.source.tree.MethodTree node) Gets the element for a method corresponding to a declaration.
static javax.lang.model.element.VariableElement	elementFromDeclaration(com.sun.source.tree.VariableTree node) Gets the element for a variable corresponding to its declaration.
static @Nullable javax.lang.model.element.Element	elementFromTree(com.sun.source.tree.Tree tree) Gets the Element for the given Tree API node.
static javax.lang.model.element.Element	elementFromUse(com.sun.source.tree.ExpressionTree node) Gets the element for the declaration corresponding to this use of an element.
static javax.lang.model.element.ExecutableElement	elementFromUse(com.sun.source.tree.MethodInvocationTree node)
static javax.lang.model.element.ExecutableElement	elementFromUse(com.sun.source.tree.NewClassTree node) Specialization for return type.
static @Nullable com.sun.source.tree.ClassTree	enclosingClass(@Nullable com.sun.source.util.TreePath path) Gets the enclosing class of the tree node defined by the given TreePath.
static @Nullable com.sun.source.tree.MethodTree	enclosingMethod(@Nullable com.sun.source.util.TreePath path) Gets the enclosing method of the tree node defined by the given TreePath.
static @Nullable com.sun.source.tree.Tree	enclosingMethodOrLambda(@Nullable com.sun.source.util.TreePath path) Gets the enclosing method or lambda expression of the tree node defined by the given TreePath.
static Pair<com.sun.source.tree.Tree,com.sun.source.tree.Tree>	enclosingNonParen(com.sun.source.util.TreePath path) Gets the first enclosing tree in path, that is not a parenthesis.
static <T extends com.sun.source.tree.Tree> T	enclosingOfClass(com.sun.source.util.TreePath path, java.lang.Class<T> treeClass) Gets the first enclosing tree in path, of the specified class.
static com.sun.source.tree.Tree	enclosingOfKind(com.sun.source.util.TreePath path, java.util.Set<com.sun.source.tree.Tree.Kind> kinds) Gets the first enclosing tree in path, with any one of the specified kinds.
static com.sun.source.tree.Tree	enclosingOfKind(com.sun.source.util.TreePath path, com.sun.source.tree.Tree.Kind kind) Gets the first enclosing tree in path, of the specified kind.
static @Nullable com.sun.source.tree.BlockTree	enclosingTopLevelBlock(com.sun.source.util.TreePath path)
static com.sun.source.tree.VariableTree	enclosingVariable(com.sun.source.util.TreePath path) Gets the enclosing variable of a tree node defined by the given TreePath.
static com.sun.tools.javac.code.Symbol	findFunction(com.sun.source.tree.Tree tree, javax.annotation.processing.ProcessingEnvironment env) The type of the lambda or method reference tree is a functional interface type.
static com.sun.source.tree.Tree	firstStatement(com.sun.source.tree.Tree tree)
static com.sun.source.tree.Tree	getAssignmentContext(com.sun.source.util.TreePath treePath) Returns the tree with the assignment context for the treePath leaf node.
static javax.lang.model.element.VariableElement	getField(java.lang.String typeName, java.lang.String fieldName, javax.annotation.processing.ProcessingEnvironment env) Returns the VariableElement for a field declaration.
static java.lang.String	getFieldName(com.sun.source.tree.Tree tree) Compute the name of the field that the field access tree accesses.
static javax.lang.model.element.ExecutableElement	getMethod(java.lang.String typeName, java.lang.String methodName, int params, javax.annotation.processing.ProcessingEnvironment env) Returns the ExecutableElement for the method declaration of methodName, in class typeName, with params formal parameters.
static javax.lang.model.element.ExecutableElement	getMethod(java.lang.String typeName, java.lang.String methodName, javax.annotation.processing.ProcessingEnvironment env, java.lang.String... paramTypes) Returns the ExecutableElement for a method declaration of methodName, in class typeName, with formal parameters of the given types.
static java.lang.String	getMethodName(com.sun.source.tree.Tree tree) Compute the name of the method that the method access tree accesses.
static java.util.List<javax.lang.model.element.ExecutableElement>	getMethods(java.lang.String typeName, java.lang.String methodName, int params, javax.annotation.processing.ProcessingEnvironment env) Returns all ExecutableElements for method declarations of methodName, in class typeName, with params formal parameters.
static com.sun.source.tree.ExpressionTree	getReceiverTree(com.sun.source.tree.ExpressionTree expression) Returns the receiver tree of a field access or a method invocation.
static boolean	hasExplicitConstructor(com.sun.source.tree.ClassTree node) Determine whether the given class contains an explicit constructor.
static boolean	isAnonymousConstructor(com.sun.source.tree.MethodTree method) Determines whether or not the node referred to by the given TreePath is an anonymous constructor (the constructor for an anonymous class.
static boolean	isArrayLengthAccess(com.sun.source.tree.Tree tree) Returns whether or not tree is an access of array length.
static boolean	isClassLiteral(com.sun.source.tree.Tree tree) Determine whether tree is a class literal, such as.
static boolean	isClassTree(com.sun.source.tree.Tree tree) Is the given tree kind a class, i.e.
static boolean	isCompileTimeString(com.sun.source.tree.ExpressionTree node) Returns true if the node is a constant-time expression.
static boolean	isConstructor(com.sun.source.tree.MethodTree tree) Checks if the provided method is a constructor method or no.
static boolean	isDiamondTree(com.sun.source.tree.Tree tree) Returns true if the tree is of a diamond type.
static boolean	isEnumSuper(com.sun.source.tree.MethodInvocationTree node)
static boolean	isExplicitThisDereference(com.sun.source.tree.ExpressionTree tree) Determine whether the given expression is either "this" or an outer "C.this".
static boolean	isExpressionTree(com.sun.source.tree.Tree tree) Determine whether the given tree represents an ExpressionTree.
static boolean	isFieldAccess(com.sun.source.tree.Tree tree) Determine whether tree is a field access expressions, such as.
static boolean	isImplicitlyTypedLambda(com.sun.source.tree.Tree tree) Returns true if tree is an implicitly typed lambda.
static boolean	isLocalVariable(com.sun.source.tree.Tree tree)
static boolean	isMethodAccess(com.sun.source.tree.Tree tree) Determine whether tree refers to a method element, such as.
static boolean	isMethodInvocation(com.sun.source.tree.Tree tree, javax.lang.model.element.ExecutableElement method, javax.annotation.processing.ProcessingEnvironment env) Returns true if the given element is an invocation of the method, or of any method that overrides that one.
static boolean	isMethodInvocation(com.sun.source.tree.Tree methodTree, java.util.List<javax.lang.model.element.ExecutableElement> methods, javax.annotation.processing.ProcessingEnvironment processingEnv) Returns true if the argument is an invocation of one of the given methods, or of any method that overrides them.
static boolean	isSelfAccess(com.sun.source.tree.ExpressionTree tree) Returns true if the tree is a tree that 'looks like' either an access of a field or an invocation of a method that are owned by the same accessing instance.
static boolean	isSpecificFieldAccess(com.sun.source.tree.Tree tree, javax.lang.model.element.VariableElement var) Returns true if and only if the given tree represents a field access of the given VariableElement.
static boolean	isStringCompoundConcatenation(com.sun.source.tree.CompoundAssignmentTree tree) Returns true if the compound assignment tree is a string concatenation.
static boolean	isStringConcatenation(com.sun.source.tree.Tree tree) Returns true if the tree represents a String concatenation operation.
static boolean	isSuperConstructorCall(com.sun.source.tree.MethodInvocationTree tree) Checks if the method invocation is a call to super.
static boolean	isThisConstructorCall(com.sun.source.tree.MethodInvocationTree tree) Checks if the method invocation is a call to "this".
static boolean	isTreeInStaticScope(com.sun.source.util.TreePath path) Returns whether or not the leaf of the tree path is in a static scope.
static boolean	isTypeDeclaration(com.sun.source.tree.Tree node) Determine whether the given tree represents a declaration of a type (including type parameters).
static boolean	isTypeTree(com.sun.source.tree.Tree tree) Is the given tree a type instantiation?
static boolean	isUseOfElement(com.sun.source.tree.ExpressionTree node) Determine whether the given ExpressionTree has an underlying element.
static javax.lang.model.element.Name	methodName(com.sun.source.tree.MethodInvocationTree node)
static com.sun.source.util.TreePath	pathTillClass(com.sun.source.util.TreePath path) Gets path to the first enclosing class tree, where class is defined by the classTreeKinds method.
static com.sun.source.util.TreePath	pathTillOfKind(com.sun.source.util.TreePath path, java.util.Set<com.sun.source.tree.Tree.Kind> kinds) Gets path to the first enclosing tree with any one of the specified kinds.
static com.sun.source.util.TreePath	pathTillOfKind(com.sun.source.util.TreePath path, com.sun.source.tree.Tree.Kind kind) Gets path to the first enclosing tree of the specified kind.
static javax.lang.model.type.TypeMirror	typeOf(com.sun.source.tree.Tree tree)
static java.util.Set<com.sun.source.tree.Tree.Kind>	typeTreeKinds()
static com.sun.source.tree.ExpressionTree	withoutParens(com.sun.source.tree.ExpressionTree tree) If the given tree is a parenthesized tree, return the enclosed non-parenthesized tree.

Methods inherited from class java.lang.Object

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

Method Detail

isConstructor

public static boolean isConstructor(com.sun.source.tree.MethodTree tree)

Checks if the provided method is a constructor method or no.

Parameters:

tree - a tree defining the method

Returns:

true iff tree describes a constructor

isSuperConstructorCall

public static boolean isSuperConstructorCall(com.sun.source.tree.MethodInvocationTree tree)

Checks if the method invocation is a call to super.

Parameters:

tree - a tree defining a method invocation

Returns:

true iff tree describes a call to super

isThisConstructorCall

public static boolean isThisConstructorCall(com.sun.source.tree.MethodInvocationTree tree)

Checks if the method invocation is a call to "this".

Parameters:

tree - a tree defining a method invocation

Returns:

true iff tree describes a call to this

isSelfAccess

public static boolean isSelfAccess(com.sun.source.tree.ExpressionTree tree)

Returns true if the tree is a tree that 'looks like' either an access of a field or an invocation of a method that are owned by the same accessing instance.

It would only return true if the access tree is of the form:

   field
   this.field

   method()
   this.method()
 

It does not perform any semantical check to differentiate between fields and local variables; local methods or imported static methods.

Parameters:

tree - expression tree representing an access to object member

Returns:

true iff the member is a member of this instance

enclosingOfKind

public static com.sun.source.tree.Tree enclosingOfKind(com.sun.source.util.TreePath path,
                                                       com.sun.source.tree.Tree.Kind kind)

Gets the first enclosing tree in path, of the specified kind.

Parameters:

path - the path defining the tree node

kind - the kind of the desired tree

Returns:

the enclosing tree of the given type as given by the path

enclosingOfKind

public static com.sun.source.tree.Tree enclosingOfKind(com.sun.source.util.TreePath path,
                                                       java.util.Set<com.sun.source.tree.Tree.Kind> kinds)

Gets the first enclosing tree in path, with any one of the specified kinds.

Parameters:

path - the path defining the tree node

kinds - the set of kinds of the desired tree

Returns:

the enclosing tree of the given type as given by the path

pathTillClass

public static com.sun.source.util.TreePath pathTillClass(com.sun.source.util.TreePath path)

Gets path to the first enclosing class tree, where class is defined by the classTreeKinds method.

Parameters:

path - the path defining the tree node

Returns:

the path to the enclosing class tree

pathTillOfKind

public static com.sun.source.util.TreePath pathTillOfKind(com.sun.source.util.TreePath path,
                                                          com.sun.source.tree.Tree.Kind kind)

Gets path to the first enclosing tree of the specified kind.

Parameters:

path - the path defining the tree node

kind - the kind of the desired tree

Returns:

the path to the enclosing tree of the given type

pathTillOfKind

public static com.sun.source.util.TreePath pathTillOfKind(com.sun.source.util.TreePath path,
                                                          java.util.Set<com.sun.source.tree.Tree.Kind> kinds)

Gets path to the first enclosing tree with any one of the specified kinds.

Parameters:

path - the path defining the tree node

kinds - the set of kinds of the desired tree

Returns:

the path to the enclosing tree of the given type

enclosingOfClass

public static <T extends com.sun.source.tree.Tree> T enclosingOfClass(com.sun.source.util.TreePath path,
                                                                      java.lang.Class<T> treeClass)

Gets the first enclosing tree in path, of the specified class.

Parameters:

path - the path defining the tree node

treeClass - the class of the desired tree

Returns:

the enclosing tree of the given type as given by the path

enclosingClass

public static @Nullable com.sun.source.tree.ClassTree enclosingClass(@Nullable com.sun.source.util.TreePath path)

Gets the enclosing class of the tree node defined by the given TreePath. It returns a Tree, from which checkers.types.AnnotatedTypeMirror or Element can be obtained.

Parameters:

path - the path defining the tree node

Returns:

the enclosing class (or interface) as given by the path, or null if one does not exist

enclosingVariable

public static com.sun.source.tree.VariableTree enclosingVariable(com.sun.source.util.TreePath path)

Gets the enclosing variable of a tree node defined by the given TreePath.

Parameters:

path - the path defining the tree node

Returns:

the enclosing variable as given by the path, or null if one does not exist

enclosingMethod

public static @Nullable com.sun.source.tree.MethodTree enclosingMethod(@Nullable com.sun.source.util.TreePath path)

Gets the enclosing method of the tree node defined by the given TreePath. It returns a Tree, from which an checkers.types.AnnotatedTypeMirror or Element can be obtained.

Parameters:

path - the path defining the tree node

Returns:

the enclosing method as given by the path, or null if one does not exist

enclosingMethodOrLambda

public static @Nullable com.sun.source.tree.Tree enclosingMethodOrLambda(@Nullable com.sun.source.util.TreePath path)

Gets the enclosing method or lambda expression of the tree node defined by the given TreePath. It returns a Tree, from which an checkers.types.AnnotatedTypeMirror or Element can be obtained.

Parameters:

path - the path defining the tree node

Returns:

the enclosing method or lambda as given by the path, or null if one does not exist

enclosingTopLevelBlock

public static @Nullable com.sun.source.tree.BlockTree enclosingTopLevelBlock(com.sun.source.util.TreePath path)

withoutParens

public static com.sun.source.tree.ExpressionTree withoutParens(com.sun.source.tree.ExpressionTree tree)

If the given tree is a parenthesized tree, return the enclosed non-parenthesized tree. Otherwise, return the same tree.

Parameters:

tree - an expression tree

Returns:

the outermost non-parenthesized tree enclosed by the given tree

enclosingNonParen

public static Pair<com.sun.source.tree.Tree,com.sun.source.tree.Tree> enclosingNonParen(com.sun.source.util.TreePath path)

Gets the first enclosing tree in path, that is not a parenthesis.

Parameters:

path - the path defining the tree node

Returns:

a pair of a non-parenthesis tree that contains the argument, and its child that is the argument or is a parenthesized version of it

getAssignmentContext

public static com.sun.source.tree.Tree getAssignmentContext(com.sun.source.util.TreePath treePath)

Returns the tree with the assignment context for the treePath leaf node. (Does not handle pseudo-assignment of an argument to a parameter or a receiver expression to a receiver.)

The assignment context for the treePath is the leaf of its parent, if the parent is one of the following trees:

• AssignmentTree
• CompoundAssignmentTree
• MethodInvocationTree
• NewArrayTree
• NewClassTree
• ReturnTree
• VariableTree

If the parent is a ConditionalExpressionTree we need to distinguish two cases: If the leaf is either the then or else branch of the ConditionalExpressionTree, then recurse on the parent. If the leaf is the condition of the ConditionalExpressionTree, then return null to not consider this assignment context.

If the leaf is a ParenthesizedTree, then recurse on the parent.

Otherwise, null is returned.

Returns:

the assignment context as described

elementFromTree

public static @Nullable javax.lang.model.element.Element elementFromTree(com.sun.source.tree.Tree tree)

Gets the Element for the given Tree API node. For an object instantiation returns the value of the JCTree.JCNewClass.constructor field. Note that this result might differ from the result of constructor(NewClassTree).

Parameters:

tree - the Tree node to get the symbol for

Returns:

the Symbol for the given tree, or null if one could not be found

Throws:

java.lang.IllegalArgumentException - if tree is null or is not a valid javac-internal tree (JCTree)

elementFromDeclaration

public static final javax.lang.model.element.TypeElement elementFromDeclaration(com.sun.source.tree.ClassTree node)

Gets the element for a class corresponding to a declaration.

Returns:

the element for the given class

elementFromDeclaration

public static final javax.lang.model.element.ExecutableElement elementFromDeclaration(com.sun.source.tree.MethodTree node)

Gets the element for a method corresponding to a declaration.

Returns:

the element for the given method

elementFromDeclaration

public static final javax.lang.model.element.VariableElement elementFromDeclaration(com.sun.source.tree.VariableTree node)

Gets the element for a variable corresponding to its declaration.

Returns:

the element for the given variable

elementFromUse

public static final javax.lang.model.element.Element elementFromUse(com.sun.source.tree.ExpressionTree node)

Gets the element for the declaration corresponding to this use of an element. To get the element for a declaration, use elementFromDeclaration(ClassTree), elementFromDeclaration(MethodTree), or elementFromDeclaration(VariableTree) instead.

This method is just a wrapper around elementFromTree(Tree), but this class might be the first place someone looks for this functionality.

Parameters:

node - the tree corresponding to a use of an element

Returns:

the element for the corresponding declaration

elementFromUse

public static final javax.lang.model.element.ExecutableElement elementFromUse(com.sun.source.tree.MethodInvocationTree node)

elementFromUse

public static final javax.lang.model.element.ExecutableElement elementFromUse(com.sun.source.tree.NewClassTree node)

Specialization for return type. Might return null if element wasn't found.

See Also:

constructor(NewClassTree)

constructor

public static javax.lang.model.element.ExecutableElement constructor(com.sun.source.tree.NewClassTree tree)

Determines the symbol for a constructor given an invocation via new.

If the tree is a declaration of an anonymous class, then method returns constructor that gets invoked in the extended class, rather than the anonymous constructor implicitly added by the constructor (JLS 15.9.5.1)

Parameters:

tree - the constructor invocation

Returns:

the ExecutableElement corresponding to the constructor call in tree

See Also:

elementFromUse(NewClassTree)

isUseOfElement

public static final boolean isUseOfElement(com.sun.source.tree.ExpressionTree node)

Determine whether the given ExpressionTree has an underlying element.

Parameters:

node - the ExpressionTree to test

Returns:

whether the tree refers to an identifier, member select, or method invocation

methodName

public static final javax.lang.model.element.Name methodName(com.sun.source.tree.MethodInvocationTree node)

Returns:

the name of the invoked method

containsThisConstructorInvocation

public static final boolean containsThisConstructorInvocation(com.sun.source.tree.MethodTree node)

Returns:

true if the first statement in the body is a self constructor invocation within a constructor

firstStatement

public static final com.sun.source.tree.Tree firstStatement(com.sun.source.tree.Tree tree)

hasExplicitConstructor

public static boolean hasExplicitConstructor(com.sun.source.tree.ClassTree node)

Determine whether the given class contains an explicit constructor.

Parameters:

node - a class tree

Returns:

true, iff there is an explicit constructor

isDiamondTree

public static final boolean isDiamondTree(com.sun.source.tree.Tree tree)

Returns true if the tree is of a diamond type. In contrast to the implementation in TreeInfo, this version works on Trees.

See Also:

TreeInfo.isDiamond(JCTree)

isStringConcatenation

public static final boolean isStringConcatenation(com.sun.source.tree.Tree tree)

Returns true if the tree represents a String concatenation operation.

isStringCompoundConcatenation

public static final boolean isStringCompoundConcatenation(com.sun.source.tree.CompoundAssignmentTree tree)

Returns true if the compound assignment tree is a string concatenation.

isCompileTimeString

public static boolean isCompileTimeString(com.sun.source.tree.ExpressionTree node)

Returns true if the node is a constant-time expression.

A tree is a constant-time expression if it is:

1. a literal tree
2. a reference to a final variable initialized with a compile time constant
3. a String concatenation of two compile time constants

getReceiverTree

public static com.sun.source.tree.ExpressionTree getReceiverTree(com.sun.source.tree.ExpressionTree expression)

Returns the receiver tree of a field access or a method invocation.

classTreeKinds

public static java.util.Set<com.sun.source.tree.Tree.Kind> classTreeKinds()

isClassTree

public static boolean isClassTree(com.sun.source.tree.Tree tree)

Is the given tree kind a class, i.e. a class, enum, interface, or annotation type.

Parameters:

tree - the tree to test

Returns:

true, iff the given kind is a class kind

typeTreeKinds

public static java.util.Set<com.sun.source.tree.Tree.Kind> typeTreeKinds()

isTypeTree

public static boolean isTypeTree(com.sun.source.tree.Tree tree)

Is the given tree a type instantiation?

TODO: this is an under-approximation: e.g. an identifier could be either a type use or an expression. How can we distinguish.

Parameters:

tree - the tree to test

Returns:

true, iff the given tree is a type

isMethodInvocation

public static boolean isMethodInvocation(com.sun.source.tree.Tree tree,
                                         javax.lang.model.element.ExecutableElement method,
                                         javax.annotation.processing.ProcessingEnvironment env)

Returns true if the given element is an invocation of the method, or of any method that overrides that one.

isMethodInvocation

public static boolean isMethodInvocation(com.sun.source.tree.Tree methodTree,
                                         java.util.List<javax.lang.model.element.ExecutableElement> methods,
                                         javax.annotation.processing.ProcessingEnvironment processingEnv)

Returns true if the argument is an invocation of one of the given methods, or of any method that overrides them.

getMethod

public static javax.lang.model.element.ExecutableElement getMethod(java.lang.String typeName,
                                                                   java.lang.String methodName,
                                                                   int params,
                                                                   javax.annotation.processing.ProcessingEnvironment env)

Returns the ExecutableElement for the method declaration of methodName, in class typeName, with params formal parameters. Errs if there is not exactly one matching method. If more than one method takes the same number of formal parameters, then use getMethod(String, String, ProcessingEnvironment, String...).

getMethods

public static java.util.List<javax.lang.model.element.ExecutableElement> getMethods(java.lang.String typeName,
                                                                                    java.lang.String methodName,
                                                                                    int params,
                                                                                    javax.annotation.processing.ProcessingEnvironment env)

Returns all ExecutableElements for method declarations of methodName, in class typeName, with params formal parameters.

getMethod

public static javax.lang.model.element.ExecutableElement getMethod(java.lang.String typeName,
                                                                   java.lang.String methodName,
                                                                   javax.annotation.processing.ProcessingEnvironment env,
                                                                   java.lang.String... paramTypes)

Returns the ExecutableElement for a method declaration of methodName, in class typeName, with formal parameters of the given types. Errs if there is no matching method.

isExplicitThisDereference

public static final boolean isExplicitThisDereference(com.sun.source.tree.ExpressionTree tree)

Determine whether the given expression is either "this" or an outer "C.this".

TODO: Should this also handle "super"?

isClassLiteral

public static boolean isClassLiteral(com.sun.source.tree.Tree tree)

Determine whether tree is a class literal, such as.

   Object . class
 

Returns:

true iff if tree is a class literal

isFieldAccess

public static boolean isFieldAccess(com.sun.source.tree.Tree tree)

Determine whether tree is a field access expressions, such as.

   f
   obj . f
 

Returns:

true iff if tree is a field access expression (implicit or explicit)

getFieldName

public static java.lang.String getFieldName(com.sun.source.tree.Tree tree)

Compute the name of the field that the field access tree accesses. Requires tree to be a field access, as determined by isFieldAccess.

Returns:

the name of the field accessed by tree.

isMethodAccess

public static boolean isMethodAccess(com.sun.source.tree.Tree tree)

Determine whether tree refers to a method element, such as.

   m(...)
   obj . m(...)
 

Returns:

true iff if tree is a method access expression (implicit or explicit)

getMethodName

public static java.lang.String getMethodName(com.sun.source.tree.Tree tree)

Compute the name of the method that the method access tree accesses. Requires tree to be a method access, as determined by isMethodAccess.

Returns:

the name of the method accessed by tree.

canHaveTypeAnnotation

public static boolean canHaveTypeAnnotation(com.sun.source.tree.Tree tree)

Returns:

true if and only if tree can have a type annotation.

TODO: is this implementation precise enough? E.g. does a .class literal work correctly?

isSpecificFieldAccess

public static boolean isSpecificFieldAccess(com.sun.source.tree.Tree tree,
                                            javax.lang.model.element.VariableElement var)

Returns true if and only if the given tree represents a field access of the given VariableElement.

getField

public static javax.lang.model.element.VariableElement getField(java.lang.String typeName,
                                                                java.lang.String fieldName,
                                                                javax.annotation.processing.ProcessingEnvironment env)

Returns the VariableElement for a field declaration.

Parameters:

typeName - the class where the field is declared

fieldName - the name of the field

env - the processing environment

Returns:

the VariableElement for typeName.fieldName

isExpressionTree

public static boolean isExpressionTree(com.sun.source.tree.Tree tree)

Determine whether the given tree represents an ExpressionTree.

Parameters:

tree - the Tree to test

Returns:

whether the tree is an ExpressionTree

isEnumSuper

public static boolean isEnumSuper(com.sun.source.tree.MethodInvocationTree node)

Parameters:

node - the method invocation to check

Returns:

true if this is a super call to the Enum constructor

isTypeDeclaration

public static boolean isTypeDeclaration(com.sun.source.tree.Tree node)

Determine whether the given tree represents a declaration of a type (including type parameters).

Parameters:

node - the Tree to test

Returns:

true if the tree is a type declaration

isTreeInStaticScope

public static boolean isTreeInStaticScope(com.sun.source.util.TreePath path)

Returns whether or not the leaf of the tree path is in a static scope.

Parameters:

path - TreePath whose leaf may or may not be in static scope

Returns:

returns whether or not the leaf of the tree path is in a static scope

isArrayLengthAccess

public static boolean isArrayLengthAccess(com.sun.source.tree.Tree tree)

Returns whether or not tree is an access of array length.

Parameters:

tree - tree to check

Returns:

true if tree is an access of array length

isAnonymousConstructor

public static boolean isAnonymousConstructor(com.sun.source.tree.MethodTree method)

Determines whether or not the node referred to by the given TreePath is an anonymous constructor (the constructor for an anonymous class.

Parameters:

method - the TreePath for a node that may be an anonymous constructor

Returns:

true if the given path points to an anonymous constructor, false if it does not

annotationsFromTypeAnnotationTrees

public static final java.util.List<javax.lang.model.element.AnnotationMirror> annotationsFromTypeAnnotationTrees(java.util.List<? extends com.sun.source.tree.AnnotationTree> annos)

annotationFromAnnotationTree

public static javax.lang.model.element.AnnotationMirror annotationFromAnnotationTree(com.sun.source.tree.AnnotationTree tree)

annotationsFromTree

public static final java.util.List<? extends javax.lang.model.element.AnnotationMirror> annotationsFromTree(com.sun.source.tree.AnnotatedTypeTree node)

annotationsFromTree

public static final java.util.List<? extends javax.lang.model.element.AnnotationMirror> annotationsFromTree(com.sun.source.tree.TypeParameterTree node)

annotationsFromArrayCreation

public static final java.util.List<? extends javax.lang.model.element.AnnotationMirror> annotationsFromArrayCreation(com.sun.source.tree.NewArrayTree node,
                                                                                                                     int level)

isLocalVariable

public static boolean isLocalVariable(com.sun.source.tree.Tree tree)

Returns:

true if the tree is the declaration or use of a local variable

typeOf

public static javax.lang.model.type.TypeMirror typeOf(com.sun.source.tree.Tree tree)

Returns:

the type as a TypeMirror of tree

findFunction

public static com.sun.tools.javac.code.Symbol findFunction(com.sun.source.tree.Tree tree,
                                                           javax.annotation.processing.ProcessingEnvironment env)

The type of the lambda or method reference tree is a functional interface type. This method returns the single abstract method declared by that functional interface. (The type of this method is referred to as the function type.)

Parameters:

tree - lambda or member reference tree

env - ProcessingEnvironment

Returns:

the single abstract method declared by the type of the tree

isImplicitlyTypedLambda

public static boolean isImplicitlyTypedLambda(com.sun.source.tree.Tree tree)

Returns true if tree is an implicitly typed lambda.

A lambda expression whose formal type parameters have inferred types is an implicitly typed lambda. (See JLS 15.27.1)

Parameters:

tree - any kind of tree

Returns:

true iff tree is an implicitly typed lambda.