OpenJDK 27 · com.sun.tools.javac.api.JavacTrees · APIdia, the JavaDoc alternative

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.
public static interface	JavacTrees.DocCommentTreeTransformer An interface for transforming a `DocCommentTree`.
private static class	JavacTrees.DocFileObject
public static class	JavacTrees.IdentityTransformer A class that provides the identity transform on instances of `DocCommentTree`.

Modifier and Type	Field and Description
private final Attr	attr
private BreakIterator	breakIterator
private final Check	chk
private JavacTrees.DocCommentTreeTransformer	docCommentTreeTransformer
private final DocTreeMaker	docTreeMaker
private final JavacElements	elements
private final Enter	enter
private final Map<Type, Type>	extraType2OriginalMap
private final JavaFileManager	fileManager
private final JavacTaskImpl	javacTaskImpl
private final Log	log
private final MemberEnter	memberEnter
private final Modules	modules
private final Names	names
private final ParserFactory	parserFactory
private final Resolve	resolve
private final Symtab	syms
private final TreeMaker	treeMaker
private final Types	types

Access	Constructor and Description
protected	JavacTrees(Context context)

Method Summary

Modifier and Type	Method and Description
pack-priv static JavaFileObject	asDocFileObject(FileObject fo)
private Env<AttrContext>	attribExprToTree(JCTree.JCExpression expr, Env<AttrContext> env, JCTree tree, Map<JCTree.JCClassDecl, JCTree.JCClassDecl> copiedClasses)
private Env<AttrContext>	attribStatToTree(JCTree stat, Env<AttrContext> env, JCTree tree, Map<JCTree.JCClassDecl, JCTree.JCClassDecl> copiedClasses)
private Symbol	attributeDocReference(TreePath path, DCTree.DCReference ref)
private Symbol	attributeParamIdentifier(TreePath path, DCTree.DCParam paramTag)
protected JavacTrees.Copier	createCopier(TreeMaker maker)
pack-priv Symbol.MethodSymbol	findConstructor(Symbol.ClassSymbol tsym, List<Type> paramTypes, boolean strict)
private Symbol.VarSymbol	findField(Symbol.ClassSymbol tsym, Name fieldName, boolean explicitType)
private Symbol.MethodSymbol	findMethod(Symbol.ClassSymbol tsym, Name methodName, List<Type> paramTypes, boolean strict, boolean explicitType)
private void	fixLocalClassNames(Map<JCTree.JCClassDecl, JCTree.JCClassDecl> copiedClasses, Env<AttrContext> lastEnv)
private Env<AttrContext>	getAttrContext(TreePath path)
public BreakIterator	getBreakIterator() Implements abstract com.sun.source.util.DocTrees.getBreakIterator. Returns the break iterator used to compute the first sentence of documentation comments.
public String	getCharacters(EntityTree tree) Implements abstract com.sun.source.util.DocTrees.getCharacters. Returns a string containing the characters for the entity in a given entity tree, or `null` if the tree does not represent a valid series of characters.
public String	getDocComment(TreePath path) Implements abstract com.sun.source.util.Trees.getDocComment. Returns the doc comment, if any, for the `Tree` node identified by a given `TreePath`.
public Elements.DocCommentKind	getDocCommentKind(TreePath path) Implements abstract com.sun.source.util.DocTrees.getDocCommentKind. Returns the style of the documentation comment associated with a tree node.
public DocCommentTree	getDocCommentTree(TreePath path) Implements abstract com.sun.source.util.DocTrees.getDocCommentTree. Returns the doc comment tree, if any, for the Tree node identified by a given TreePath.
public DocCommentTree	getDocCommentTree(Element e) Implements abstract com.sun.source.util.DocTrees.getDocCommentTree. Returns the doc comment tree of the given element.
public DocCommentTree	getDocCommentTree(Element e, String relativeFileName) Implements abstract com.sun.source.util.DocTrees.getDocCommentTree. Returns the doc comment tree of the given file, which must be of one of the supported file types, and whose path is specified relative to the given element.
public DocCommentTree	getDocCommentTree(FileObject fileObject) Implements abstract com.sun.source.util.DocTrees.getDocCommentTree. Returns the doc comment tree of the given file, which must be of one of the supported file types.
public DocCommentTree	Returns: the doc comment tree for a given comment getDocCommentTree(DiagnosticSource the source containing the comment, used when displaying any diagnostics diagSource, Tokens.Comment the comment c) Returns the doc comment tree for a given comment.
public JavacTrees.DocCommentTreeTransformer	getDocCommentTreeTransformer()
public DocTreeMaker	getDocTreeFactory() Implements abstract com.sun.source.util.DocTrees.getDocTreeFactory. Returns a utility object for creating `DocTree` objects.
public DocTreePath	getDocTreePath(FileObject fileObject, PackageElement packageElement) Implements abstract com.sun.source.util.DocTrees.getDocTreePath. Returns a doc tree path containing the doc comment tree of the given file, which must be of one of the supported file types.
public Symbol	getElement(TreePath path) Implements abstract com.sun.source.util.Trees.getElement. Returns the `Element` for the `Tree` node identified by a given `TreePath`.
public Element	getElement(DocTreePath path) Implements abstract com.sun.source.util.DocTrees.getElement. Returns the language model element referred to by the leaf node of the given `DocTreePath`, or `null` if the leaf node of `path` does not refer to an element.
public List<DocTree>	getFirstSentence(List<? extends DocTree> list) Implements abstract com.sun.source.util.DocTrees.getFirstSentence. Returns the list of `DocTree` representing the first sentence of a comment.
public TypeMirror	getLub(CatchTree tree) Implements abstract com.sun.source.util.Trees.getLub. Returns the lub of an exception parameter declared in a catch clause.
public TypeMirror	Returns: TypeMirror corresponding to the original type, replaced by the ErrorType. noType (type.tag == NONE) is returned if there is no original type. getOriginalType(ErrorType The errorType for which we want to get the original type. errorType) Implements abstract com.sun.source.util.Trees.getOriginalType. Returns the original type from the ErrorType object.
public ParserFactory	Returns: the ParserFactory parser factory getParserFactory() Returns the ParserFactory parser factory.
public TreePath	getPath(CompilationUnitTree unit, Tree node) Implements abstract com.sun.source.util.Trees.getPath. Returns the path to tree node within the specified compilation unit.
public TreePath	getPath(Element e) Implements abstract com.sun.source.util.Trees.getPath. Returns the `TreePath` node for a given `Element`.
public TreePath	getPath(Element e, AnnotationMirror a) Implements abstract com.sun.source.util.Trees.getPath. Returns the `TreePath` node for an `AnnotationMirror` on a given `Element`.
public TreePath	getPath(Element e, AnnotationMirror a, AnnotationValue v) Implements abstract com.sun.source.util.Trees.getPath. Returns the `TreePath` node for an `AnnotationValue` for an `AnnotationMirror` on a given `Element`.
public JavacScope	getScope(TreePath path) Implements abstract com.sun.source.util.Trees.getScope. Returns the `Scope` for the `Tree` node identified by a given `TreePath`.
public DocSourcePositions	getSourcePositions() Implements abstract com.sun.source.util.DocTrees.getSourcePositions. Returns a utility object for accessing the source positions of documentation tree nodes.
public JCTree.JCClassDecl	getTree(TypeElement element) Implements abstract com.sun.source.util.Trees.getTree. Returns the `ClassTree` node for a given `TypeElement`.
public JCTree.JCMethodDecl	getTree(ExecutableElement method) Implements abstract com.sun.source.util.Trees.getTree. Returns the `MethodTree` node for a given `ExecutableElement`.
public JCTree	getTree(Element element) Implements abstract com.sun.source.util.Trees.getTree. Returns the `Tree` node for a given `Element`.
public JCTree	getTree(Element e, AnnotationMirror a) Implements abstract com.sun.source.util.Trees.getTree. Returns the `Tree` node for an `AnnotationMirror` on a given `Element`.
public JCTree	getTree(Element e, AnnotationMirror a, AnnotationValue v) Implements abstract com.sun.source.util.Trees.getTree. Returns the `Tree` node for an `AnnotationValue` for an `AnnotationMirror` on a given `Element`.
public TypeMirror	getType(DocTreePath path) Implements abstract com.sun.source.util.DocTrees.getType. Returns the language model type referred to by the leaf node of the given `DocTreePath`, or `null` if the leaf node of `path` does not refer to a type.
public TypeMirror	getTypeMirror(TreePath path) Implements abstract com.sun.source.util.Trees.getTypeMirror. Returns the `TypeMirror` for the `Tree` node identified by a given `TreePath`.
private boolean	hasParameterTypes(Symbol.MethodSymbol method, List<Type> paramTypes, boolean strict)
public void	initDocCommentTreeTransformer() Initialize `docCommentTreeTransformer` if it is `null`, using a service provider to look up an implementation with the name "standard".
public static JavacTrees	instance(JavaCompiler.CompilationTask task) Hides com.sun.source.util.DocTrees.instance. Returns a DocTrees object for a given CompilationTask.
public static JavacTrees	instance(ProcessingEnvironment env) Hides com.sun.source.util.DocTrees.instance. Returns a DocTrees object for a given ProcessingEnvironment.
public static JavacTrees	instance(Context context)
public boolean	isAccessible(Scope scope, TypeElement type) Implements abstract com.sun.source.util.Trees.isAccessible. Checks whether a given type is accessible in a given scope.
public boolean	isAccessible(Scope scope, Element member, DeclaredType type) Implements abstract com.sun.source.util.Trees.isAccessible. Checks whether the given element is accessible as a member of the given type in a given scope.
private static boolean	isHtmlFile(FileObject fo)
private static boolean	isMarkdownFile(FileObject fo)
private TreePath	makeTreePath(final Symbol.PackageSymbol psym, final JavaFileObject jfo, DocCommentTree dcTree)
private Map<JCTree.JCClassDecl, Name>	prepareFlatnameForClass(Env<AttrContext> env)
public void	printMessage(Diagnostic.Kind the kind of message kind, CharSequence the message, or an empty string if none msg, Tree the tree to use as a position hint t, CompilationUnitTree the compilation unit that contains tree root) Implements abstract com.sun.source.util.Trees.printMessage. Prints a message of the specified kind at the location of the tree within the provided compilation unit
public void	printMessage(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root) Implements abstract com.sun.source.util.DocTrees.printMessage. Prints a message of the specified kind at the location of the tree within the provided compilation unit.
public void	printMessage(Diagnostic.Kind kind, CharSequence msg)
private void	printMessage(Diagnostic.Kind kind, CharSequence msg, JCDiagnostic.DiagnosticPosition pos, CompilationUnitTree root)
private Symbol	resolveMember(Type type, Name memberName, DCTree.DCReference ref, Env<AttrContext> env)
private Symbol.VarSymbol	searchField(Symbol.ClassSymbol tsym, Name fieldName, boolean explicitType, Set<Symbol.ClassSymbol> searched)
private Symbol.MethodSymbol	searchMethod(Symbol.ClassSymbol tsym, Name methodName, List<Type> paramTypes, boolean strict, boolean explicitType, Set<Symbol.ClassSymbol> searched)
public void	setBreakIterator(BreakIterator breakiterator) Implements abstract com.sun.source.util.DocTrees.setBreakIterator. Sets the break iterator to compute the first sentence of documentation comments.
public void	setDocCommentTreeTransformer(JavacTrees.DocCommentTreeTransformer transformer)
private DocCommentTree	Returns: the transformed tree transform(DocCommentTree the tree tree) Transforms the given tree using the current transformer, after ensuring it has been initialized.

public Class JavacTrees

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary