Class Trees
java.lang.Object
com.sun.source.util.Trees
- Direct Known Subclasses:
- DocTrees
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionabstract StringgetDocComment(TreePath path) Returns the doc comment, if any, for theTreenode identified by a givenTreePath.abstract ElementgetElement(TreePath path) Returns theElementfor theTreenode identified by a givenTreePath.abstract TypeMirrorReturns the lub of an exception parameter declared in a catch clause.abstract TypeMirrorgetOriginalType(ErrorType errorType) Returns the original type from theErrorTypeobject.abstract TreePathgetPath(CompilationUnitTree unit, Tree node) Returns the path to tree node within the specified compilation unit.abstract TreePathReturns theTreePathnode for a givenElement.abstract TreePathgetPath(Element e, AnnotationMirror a) Returns theTreePathnode for anAnnotationMirroron a givenElement.abstract TreePathgetPath(Element e, AnnotationMirror a, AnnotationValue v) Returns theTreePathnode for anAnnotationValuefor anAnnotationMirroron a givenElement.abstract ScopeReturns theScopefor theTreenode identified by a givenTreePath.abstract SourcePositionsReturns a utility object for obtaining source positions.abstract TreeReturns theTreenode for a givenElement.abstract TreegetTree(Element e, AnnotationMirror a) Returns theTreenode for anAnnotationMirroron a givenElement.abstract TreegetTree(Element e, AnnotationMirror a, AnnotationValue v) Returns theTreenode for anAnnotationValuefor anAnnotationMirroron a givenElement.abstract MethodTreegetTree(ExecutableElement method) Returns theMethodTreenode for a givenExecutableElement.abstract ClassTreegetTree(TypeElement element) Returns theClassTreenode for a givenTypeElement.abstract TypeMirrorgetTypeMirror(TreePath path) Returns theTypeMirrorfor theTreenode identified by a givenTreePath.static TreesReturns aTreesobject for a givenProcessingEnvironment.static TreesReturns aTreesobject for a givenCompilationTask.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
- 
Constructor Details- 
Treespublic Trees()Constructor for subclasses to call.
 
- 
- 
Method Details- 
instanceReturns aTreesobject for a givenCompilationTask.- Parameters:
- task- the compilation task for which to get the- Treesobject
- Returns:
- the Treesobject
- Throws:
- IllegalArgumentException- if the task does not support the Tree API.
 
- 
instanceReturns aTreesobject for a givenProcessingEnvironment.- Parameters:
- env- the processing environment for which to get the- Treesobject
- Returns:
- the Treesobject
- Throws:
- IllegalArgumentException- if the env does not support the Tree API.
 
- 
getSourcePositionsReturns a utility object for obtaining source positions.- Returns:
- the utility object for obtaining source positions
 
- 
getTree
- 
getTreeReturns theClassTreenode for a givenTypeElement. Returnsnullif the node can not be found.- Parameters:
- element- the element
- Returns:
- the class tree node
 
- 
getTreeReturns theMethodTreenode for a givenExecutableElement. Returnsnullif the node can not be found.- Parameters:
- method- the executable element
- Returns:
- the method tree node
 
- 
getTreeReturns theTreenode for anAnnotationMirroron a givenElement. Returnsnullif the node can not be found.- Parameters:
- e- the element
- a- the annotation mirror
- Returns:
- the tree node
 
- 
getTreeReturns theTreenode for anAnnotationValuefor anAnnotationMirroron a givenElement. Returnsnullif the node can not be found.- Parameters:
- e- the element
- a- the annotation mirror
- v- the annotation value
- Returns:
- the tree node
 
- 
getPathReturns the path to tree node within the specified compilation unit.- Parameters:
- unit- the compilation unit
- node- the tree node
- Returns:
- the tree path
 
- 
getPath
- 
getPathReturns theTreePathnode for anAnnotationMirroron a givenElement. Returnsnullif the node can not be found.- Parameters:
- e- the element
- a- the annotation mirror
- Returns:
- the tree path
 
- 
getPathReturns theTreePathnode for anAnnotationValuefor anAnnotationMirroron a givenElement. Returnsnullif the node can not be found.- Parameters:
- e- the element
- a- the annotation mirror
- v- the annotation value
- Returns:
- the tree path
 
- 
getElementReturns theElementfor theTreenode identified by a givenTreePath. Returnsnullif the element is not available.- Parameters:
- path- the tree path
- Returns:
- the element
- Throws:
- IllegalArgumentException- is the- TreePathdoes not identify a- Treenode that might have an associated- Element.
 
- 
getTypeMirrorReturns theTypeMirrorfor theTreenode identified by a givenTreePath. Returnsnullif theTypeMirroris not available.- Parameters:
- path- the tree path
- Returns:
- the type mirror
- Throws:
- IllegalArgumentException- is the- TreePathdoes not identify a- Treenode that might have an associated- TypeMirror.
 
- 
getScope
- 
getDocComment
- 
isAccessibleChecks 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
 
- 
isAccessibleChecks 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
 
- 
getOriginalTypeReturns the original type from theErrorTypeobject.- Parameters:
- errorType- the errorType for which we want to get the original type
- Returns:
- the type mirror 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
 
- 
getLubReturns 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
 
 
-