java.lang.Object
com.sun.source.util.Trees
- Direct Known Subclasses:
DocTrees
Bridges JSR 199, JSR 269, and the Tree API.
-
Constructor Summary
Constructors -
Method Summary
Modifier 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
-
Trees
public Trees()Constructor for subclasses to call.
-
-
Method Details
-
instance
Returns aTreesobject for a givenCompilationTask.- Parameters:
task- the compilation task for which to get theTreesobject- Returns:
- the
Treesobject - Throws:
IllegalArgumentException- if the task does not support the Tree API.
-
instance
Returns aTreesobject for a givenProcessingEnvironment.- Parameters:
env- the processing environment for which to get theTreesobject- Returns:
- the
Treesobject - Throws:
IllegalArgumentException- if the env does not support the Tree API.
-
getSourcePositions
Returns a utility object for obtaining source positions.- Returns:
- the utility object for obtaining source positions
-
getTree
Returns theTreenode for a givenElement. Returnsnullif the node can not be found.- Parameters:
element- the element- Returns:
- the tree node
-
getTree
Returns theClassTreenode for a givenTypeElement. Returnsnullif the node can not be found.- Parameters:
element- the element- Returns:
- the class tree node
-
getTree
Returns theMethodTreenode for a givenExecutableElement. Returnsnullif the node can not be found.- Parameters:
method- the executable element- Returns:
- the method tree node
-
getTree
Returns theTreenode for anAnnotationMirroron a givenElement. Returnsnullif the node can not be found.- Parameters:
e- the elementa- the annotation mirror- Returns:
- the tree node
-
getTree
Returns theTreenode for anAnnotationValuefor anAnnotationMirroron a givenElement. Returnsnullif the node can not be found.- Parameters:
e- the elementa- the annotation mirrorv- the annotation value- Returns:
- the tree node
-
getPath
Returns the path to tree node within the specified compilation unit.- Parameters:
unit- the compilation unitnode- the tree node- Returns:
- the tree path
-
getPath
Returns theTreePathnode for a givenElement. Returnsnullif the node can not be found.- Parameters:
e- the element- Returns:
- the tree path
-
getPath
Returns theTreePathnode for anAnnotationMirroron a givenElement. Returnsnullif the node can not be found.- Parameters:
e- the elementa- the annotation mirror- Returns:
- the tree path
-
getPath
Returns theTreePathnode for anAnnotationValuefor anAnnotationMirroron a givenElement. Returnsnullif the node can not be found.- Parameters:
e- the elementa- the annotation mirrorv- the annotation value- Returns:
- the tree path
-
getElement
Returns theElementfor theTreenode identified by a givenTreePath. Returnsnullif the element is not available.- Parameters:
path- the tree path- Returns:
- the element
- Throws:
IllegalArgumentException- is theTreePathdoes not identify aTreenode that might have an associatedElement.
-
getTypeMirror
Returns theTypeMirrorfor theTreenode identified by a givenTreePath. Returnsnullif theTypeMirroris not available.- Parameters:
path- the tree path- Returns:
- the type mirror
- Throws:
IllegalArgumentException- is theTreePathdoes not identify aTreenode that might have an associatedTypeMirror.
-
getScope
Returns theScopefor theTreenode identified by a givenTreePath. Returnsnullif theScopeis not available.- Parameters:
path- the tree path- Returns:
- the scope
-
getDocComment
Returns the doc comment, if any, for theTreenode identified by a givenTreePath. Returnsnullif no doc comment was found.- Parameters:
path- the tree path- Returns:
- the doc comment
- See Also:
-
isAccessible
Checks whether a given type is accessible in a given scope.- Parameters:
scope- the scope to be checkedtype- the type to be checked- Returns:
- true if
typeis accessible
-
isAccessible
Checks whether the given element is accessible as a member of the given type in a given scope.- Parameters:
scope- the scope to be checkedmember- the member to be checkedtype- the type for which to check if the member is accessible- Returns:
- true if
memberis accessible intype
-
getOriginalType
Returns 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
-
printMessage
public 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 messagemsg- the message, or an empty string if nonet- the tree to use as a position hintroot- the compilation unit that contains tree
-
getLub
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
-