Package com.sun.tools.javac.api

Class JavacTrees

java.lang.Object

com.sun.source.util.Trees

com.sun.source.util.DocTrees

com.sun.tools.javac.api.JavacTrees

public class JavacTrees
extends DocTrees

Provides an implementation of Trees.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Author:

Peter von der Ahé

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	JavacTrees.Copier Makes a copy of a tree, noting the value resulting from copying a particular leaf.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JavacTrees(Context context)

Method Summary

Modifier and Type	Method and Description
protected JavacTrees.Copier	createCopier(TreeMaker maker)
String	getDocComment(TreePath path) Gets the doc comment, if any, for the Tree node identified by a given TreePath.
DocCommentTree	getDocCommentTree(TreePath path) Gets the doc comment tree, if any, for the Tree node identified by a given TreePath.
Element	getElement(DocTreePath path) Gets the language model element referred to by the leaf node of the given DocTreePath, or null if unknown.
Symbol	getElement(TreePath path) Gets the Element for the Tree node identified by a given TreePath.
TypeMirror	getLub(CatchTree tree) Gets the lub of an exception parameter declared in a catch clause.
TypeMirror	getOriginalType(ErrorType errorType) Gets the original type from the ErrorType object.
TreePath	getPath(CompilationUnitTree unit, Tree node) Gets the path to tree node within the specified compilation unit.
TreePath	getPath(Element e) Gets the TreePath node for a given Element.
TreePath	getPath(Element e, AnnotationMirror a) Gets the TreePath node for an AnnotationMirror on a given Element.
TreePath	getPath(Element e, AnnotationMirror a, AnnotationValue v) Gets the TreePath node for an AnnotationValue for an AnnotationMirror on a given Element.
JavacScope	getScope(TreePath path) Gets the Scope for the Tree node identified by a given TreePath.
DocSourcePositions	getSourcePositions() Gets a utility object for obtaining source positions.
JCTree	getTree(Element element) Gets the Tree node for a given Element.
JCTree	getTree(Element e, AnnotationMirror a) Gets the Tree node for an AnnotationMirror on a given Element.
JCTree	getTree(Element e, AnnotationMirror a, AnnotationValue v) Gets the Tree node for an AnnotationValue for an AnnotationMirror on a given Element.
JCTree.JCMethodDecl	getTree(ExecutableElement method) Gets the MethodTree node for a given ExecutableElement.
JCTree.JCClassDecl	getTree(TypeElement element) Gets the ClassTree node for a given TypeElement.
TypeMirror	getTypeMirror(TreePath path) Gets the TypeMirror for the Tree node identified by a given TreePath.
static JavacTrees	instance(Context context)
static JavacTrees	instance(JavaCompiler.CompilationTask task)
static JavacTrees	instance(ProcessingEnvironment env)
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.
boolean	isAccessible(Scope scope, TypeElement type) Checks whether a given type is accessible in a given scope.
void	printMessage(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root) Prints a message of the specified kind at the location of the tree within the provided compilation unit
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
void	updateContext(Context context)

Methods inherited from class java.lang.Object

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

Constructor Detail

JavacTrees

protected JavacTrees(Context context)

Method Detail

instance

public static JavacTrees instance(JavaCompiler.CompilationTask task)

instance

public static JavacTrees instance(ProcessingEnvironment env)

instance

public static JavacTrees instance(Context context)

updateContext

public void updateContext(Context context)

getSourcePositions

public DocSourcePositions getSourcePositions()

Description copied from class: Trees

Gets a utility object for obtaining source positions.

Specified by:

getSourcePositions in class DocTrees

getTree

public JCTree.JCClassDecl getTree(TypeElement element)

Description copied from class: Trees

Gets the ClassTree node for a given TypeElement. Returns null if the node can not be found.

Specified by:

getTree in class Trees

getTree

public JCTree.JCMethodDecl getTree(ExecutableElement method)

Description copied from class: Trees

Gets the MethodTree node for a given ExecutableElement. Returns null if the node can not be found.

Specified by:

getTree in class Trees

getTree

public JCTree getTree(Element element)

Description copied from class: Trees

Gets the Tree node for a given Element. Returns null if the node can not be found.

Specified by:

getTree in class Trees

getTree

public JCTree getTree(Element e,
                      AnnotationMirror a)

Description copied from class: Trees

Gets the Tree node for an AnnotationMirror on a given Element. Returns null if the node can not be found.

Specified by:

getTree in class Trees

getTree

public JCTree getTree(Element e,
                      AnnotationMirror a,
                      AnnotationValue v)

Description copied from class: Trees

Gets the Tree node for an AnnotationValue for an AnnotationMirror on a given Element. Returns null if the node can not be found.

Specified by:

getTree in class Trees

getPath

public TreePath getPath(CompilationUnitTree unit,
                        Tree node)

Description copied from class: Trees

Gets the path to tree node within the specified compilation unit.

Specified by:

getPath in class Trees

getPath

public TreePath getPath(Element e)

Description copied from class: Trees

Gets the TreePath node for a given Element. Returns null if the node can not be found.

Specified by:

getPath in class Trees

getPath

public TreePath getPath(Element e,
                        AnnotationMirror a)

Description copied from class: Trees

Gets the TreePath node for an AnnotationMirror on a given Element. Returns null if the node can not be found.

Specified by:

getPath in class Trees

getPath

public TreePath getPath(Element e,
                        AnnotationMirror a,
                        AnnotationValue v)

Description copied from class: Trees

Gets the TreePath node for an AnnotationValue for an AnnotationMirror on a given Element. Returns null if the node can not be found.

Specified by:

getPath in class Trees

getElement

public Symbol getElement(TreePath path)

Description copied from class: Trees

Gets the Element for the Tree node identified by a given TreePath. Returns null if the element is not available.

Specified by:

getElement in class Trees

getElement

public Element getElement(DocTreePath path)

Description copied from class: DocTrees

Gets the language model element referred to by the leaf node of the given DocTreePath, or null if unknown.

Specified by:

getElement in class DocTrees

getTypeMirror

public TypeMirror getTypeMirror(TreePath path)

Description copied from class: Trees

Gets the TypeMirror for the Tree node identified by a given TreePath. Returns null if the TypeMirror is not available.

Specified by:

getTypeMirror in class Trees

getScope

public JavacScope getScope(TreePath path)

Description copied from class: Trees

Gets the Scope for the Tree node identified by a given TreePath. Returns null if the Scope is not available.

Specified by:

getScope in class Trees

getDocComment

public String getDocComment(TreePath path)

Description copied from class: Trees

Gets the doc comment, if any, for the Tree node identified by a given TreePath. Returns null if no doc comment was found.

Specified by:

getDocComment in class Trees

See Also:

DocTrees.getDocCommentTree(TreePath)

getDocCommentTree

public DocCommentTree getDocCommentTree(TreePath path)

Description copied from class: DocTrees

Gets the doc comment tree, if any, for the Tree node identified by a given TreePath. Returns null if no doc comment was found.

Specified by:

getDocCommentTree in class DocTrees

isAccessible

public boolean isAccessible(Scope scope,
                            TypeElement type)

Description copied from class: Trees

Checks whether a given type is accessible in a given scope.

Specified by:

isAccessible in class Trees

Parameters:

scope - the scope to be checked

type - the type to be checked

Returns:

true if type is accessible

isAccessible

public boolean isAccessible(Scope scope,
                            Element member,
                            DeclaredType type)

Description copied from class: Trees

Checks whether the given element is accessible as a member of the given type in a given scope.

Specified by:

isAccessible in class Trees

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

createCopier

protected JavacTrees.Copier createCopier(TreeMaker maker)

getOriginalType

public TypeMirror getOriginalType(ErrorType errorType)

Gets the original type from the ErrorType object.

Specified by:

getOriginalType in class Trees

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.

printMessage

public 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

Specified by:

printMessage in class Trees

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

printMessage

public void printMessage(Diagnostic.Kind kind,
                         CharSequence msg,
                         DocTree t,
                         DocCommentTree c,
                         CompilationUnitTree root)

Description copied from class: DocTrees

Prints a message of the specified kind at the location of the tree within the provided compilation unit

Specified by:

printMessage in class DocTrees

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

getLub

public TypeMirror getLub(CatchTree tree)

Description copied from class: Trees

Gets the lub of an exception parameter declared in a catch clause.

Specified by:

getLub in class Trees

Parameters:

tree - the tree for the catch clause

Returns:

The lub of the exception parameter