- java.lang.Object
- 
- com.sun.source.util.Trees
 
- 
- 
Constructor SummaryConstructors Constructor Description Trees()
 - 
Method SummaryAll Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract StringgetDocComment(TreePath path)Returns the doc comment, if any, for the Tree node identified by a given TreePath.abstract ElementgetElement(TreePath path)Returns the Element for the Tree node identified by a given TreePath.abstract TypeMirrorgetLub(CatchTree tree)Returns the lub of an exception parameter declared in a catch clause.abstract TypeMirrorgetOriginalType(ErrorType errorType)Returns the original type from the ErrorType object.abstract TreePathgetPath(CompilationUnitTree unit, Tree node)Returns the path to tree node within the specified compilation unit.abstract TreePathgetPath(Element e)Returns the TreePath node for a given Element.abstract TreePathgetPath(Element e, AnnotationMirror a)Returns the TreePath node for an AnnotationMirror on a given Element.abstract TreePathgetPath(Element e, AnnotationMirror a, AnnotationValue v)Returns the TreePath node for an AnnotationValue for an AnnotationMirror on a given Element.abstract ScopegetScope(TreePath path)Returns the Scope for the Tree node identified by a given TreePath.abstract SourcePositionsgetSourcePositions()Returns a utility object for obtaining source positions.abstract TreegetTree(Element element)Returns the Tree node for a given Element.abstract TreegetTree(Element e, AnnotationMirror a)Returns the Tree node for an AnnotationMirror on a given Element.abstract TreegetTree(Element e, AnnotationMirror a, AnnotationValue v)Returns the Tree node for an AnnotationValue for an AnnotationMirror on a given Element.abstract MethodTreegetTree(ExecutableElement method)Returns the MethodTree node for a given ExecutableElement.abstract ClassTreegetTree(TypeElement element)Returns the ClassTree node for a given TypeElement.abstract TypeMirrorgetTypeMirror(TreePath path)Returns the TypeMirror for the Tree node identified by a given TreePath.static Treesinstance(ProcessingEnvironment env)Returns a Trees object for a given ProcessingEnvironment.static Treesinstance(JavaCompiler.CompilationTask task)Returns a Trees object for a given CompilationTask.abstract booleanisAccessible(Scope scope, Element member, DeclaredType type)Checks whether the given element is accessible as a member of the given type in a given scope.abstract booleanisAccessible(Scope scope, TypeElement type)Checks whether a given type is accessible in a given scope.abstract voidprintMessage(Diagnostic.Kind kind, CharSequence msg, Tree t, CompilationUnitTree root)Prints a message of the specified kind at the location of the tree within the provided compilation unit
 
- 
- 
- 
Method Detail- 
instancepublic static Trees instance(JavaCompiler.CompilationTask task) Returns a Trees object for a given CompilationTask.- Parameters:
- task- the compilation task for which to get the Trees object
- Returns:
- the Trees object
- Throws:
- IllegalArgumentException- if the task does not support the Trees API.
 
 - 
instancepublic static Trees instance(ProcessingEnvironment env) Returns a Trees object for a given ProcessingEnvironment.- Parameters:
- env- the processing environment for which to get the Trees object
- Returns:
- the Trees object
- Throws:
- IllegalArgumentException- if the env does not support the Trees API.
 
 - 
getSourcePositionspublic abstract SourcePositions getSourcePositions() Returns a utility object for obtaining source positions.- Returns:
- the utility object for obtaining source positions
 
 - 
getTreepublic abstract Tree getTree(Element element) Returns the Tree node for a given Element. Returnsnullif the node can not be found.- Parameters:
- element- the element
- Returns:
- the tree node
 
 - 
getTreepublic abstract ClassTree getTree(TypeElement element) Returns the ClassTree node for a given TypeElement. Returnsnullif the node can not be found.- Parameters:
- element- the element
- Returns:
- the class tree node
 
 - 
getTreepublic abstract MethodTree getTree(ExecutableElement method) Returns the MethodTree node for a given ExecutableElement. Returnsnullif the node can not be found.- Parameters:
- method- the executable element
- Returns:
- the method tree node
 
 - 
getTreepublic abstract Tree getTree(Element e, AnnotationMirror a) Returns the Tree node for an AnnotationMirror on a given Element. Returnsnullif the node can not be found.- Parameters:
- e- the element
- a- the annotation mirror
- Returns:
- the tree node
 
 - 
getTreepublic abstract Tree getTree(Element e, AnnotationMirror a, AnnotationValue v) Returns the Tree node for an AnnotationValue for an AnnotationMirror on a given Element. Returnsnullif the node can not be found.- Parameters:
- e- the element
- a- the annotation mirror
- v- the annotation value
- Returns:
- the tree node
 
 - 
getPathpublic abstract TreePath getPath(CompilationUnitTree unit, Tree node) Returns the path to tree node within the specified compilation unit.- Parameters:
- unit- the compilation unit
- node- the tree node
- Returns:
- the tree path
 
 - 
getPathpublic abstract TreePath getPath(Element e) Returns the TreePath node for a given Element. Returnsnullif the node can not be found.- Parameters:
- e- the element
- Returns:
- the tree path
 
 - 
getPathpublic abstract TreePath getPath(Element e, AnnotationMirror a) Returns the TreePath node for an AnnotationMirror on a given Element. Returnsnullif the node can not be found.- Parameters:
- e- the element
- a- the annotation mirror
- Returns:
- the tree path
 
 - 
getPathpublic abstract TreePath getPath(Element e, AnnotationMirror a, AnnotationValue v) Returns the TreePath node for an AnnotationValue for an AnnotationMirror on a given Element. Returnsnullif the node can not be found.- Parameters:
- e- the element
- a- the annotation mirror
- v- the annotation value
- Returns:
- the tree path
 
 - 
getElementpublic abstract Element getElement(TreePath path) Returns the Element for the Tree node identified by a given TreePath. Returnsnullif the element is not available.- Parameters:
- path- the tree path
- Returns:
- the element
- Throws:
- IllegalArgumentException- is the TreePath does not identify a Tree node that might have an associated Element.
 
 - 
getTypeMirrorpublic abstract TypeMirror getTypeMirror(TreePath path) Returns the TypeMirror for the Tree node identified by a given TreePath. Returnsnullif the TypeMirror is not available.- Parameters:
- path- the tree path
- Returns:
- the type mirror
- Throws:
- IllegalArgumentException- is the TreePath does not identify a Tree node that might have an associated TypeMirror.
 
 - 
getScopepublic abstract Scope getScope(TreePath path) Returns the Scope for the Tree node identified by a given TreePath. Returnsnullif the Scope is not available.- Parameters:
- path- the tree path
- Returns:
- the scope
 
 - 
getDocCommentpublic abstract String getDocComment(TreePath path) Returns the doc comment, if any, for the Tree node identified by a given TreePath. Returnsnullif no doc comment was found.- Parameters:
- path- the tree path
- Returns:
- the doc comment
- See Also:
- DocTrees.getDocCommentTree(TreePath)
 
 - 
isAccessiblepublic abstract boolean isAccessible(Scope scope, TypeElement type) Checks whether a given type is accessible in a given scope.- Parameters:
- scope- the scope to be checked
- type- the type to be checked
- Returns:
- true if typeis accessible
 
 - 
isAccessiblepublic abstract boolean isAccessible(Scope scope, Element member, DeclaredType type) 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 memberis accessible intype
 
 - 
getOriginalTypepublic abstract TypeMirror getOriginalType(ErrorType errorType) Returns the original type from the ErrorType object.- Parameters:
- errorType- The errorType for which we want to get the original type.
- Returns:
- javax.lang.model.type.TypeMirror corresponding to the original type, replaced by the ErrorType.
 
 - 
printMessagepublic abstract void printMessage(Diagnostic.Kind kind, CharSequence msg, Tree t, CompilationUnitTree root) Prints a message of the specified kind at the location of the tree within the provided compilation unit- Parameters:
- kind- the kind of message
- msg- the message, or an empty string if none
- t- the tree to use as a position hint
- root- the compilation unit that contains tree
 
 - 
getLubpublic abstract TypeMirror getLub(CatchTree tree) Returns the lub of an exception parameter declared in a catch clause.- Parameters:
- tree- the tree for the catch clause
- Returns:
- The lub of the exception parameter
 
 
- 
 
-