- java.lang.Object
-
- com.sun.source.util.Trees
-
- com.sun.source.util.DocTrees
-
public abstract class DocTrees extends Trees
Provides access to syntax trees for doc comments.- Since:
- 1.8
-
-
Constructor Summary
Constructors Constructor Description DocTrees()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract BreakIteratorgetBreakIterator()Returns the break iterator used to compute the first sentence of documentation comments.abstract DocCommentTreegetDocCommentTree(TreePath path)Returns the doc comment tree, if any, for the Tree node identified by a given TreePath.abstract DocCommentTreegetDocCommentTree(Element e)Returns the doc comment tree of the given element.abstract DocCommentTreegetDocCommentTree(Element e, String relativePath)Returns the doc comment tree of the given file whose path is specified relative to the given element.abstract DocCommentTreegetDocCommentTree(FileObject fileObject)Returns the doc comment tree of the given file.abstract DocTreeFactorygetDocTreeFactory()Returns a utility object for creatingDocTreeobjects.abstract DocTreePathgetDocTreePath(FileObject fileObject, PackageElement packageElement)Returns a doc tree path containing the doc comment tree of the given file.abstract ElementgetElement(DocTreePath path)Returns the language model element referred to by the leaf node of the givenDocTreePath, ornullif unknown.abstract List<DocTree>getFirstSentence(List<? extends DocTree> list)Returns the list ofDocTreerepresenting the first sentence of a comment.abstract DocSourcePositionsgetSourcePositions()Returns a utility object for accessing the source positions of documentation tree nodes.static DocTreesinstance(ProcessingEnvironment env)Returns a DocTrees object for a given ProcessingEnvironment.static DocTreesinstance(JavaCompiler.CompilationTask task)Returns a DocTrees object for a given CompilationTask.abstract voidprintMessage(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 unitabstract voidsetBreakIterator(BreakIterator breakiterator)Sets the break iterator to compute the first sentence of documentation comments.-
Methods declared in class com.sun.source.util.Trees
getDocComment, getElement, getLub, getOriginalType, getPath, getPath, getPath, getPath, getScope, getTree, getTree, getTree, getTree, getTree, getTypeMirror, isAccessible, isAccessible, printMessage
-
-
-
-
Method Detail
-
instance
public static DocTrees instance(JavaCompiler.CompilationTask task)
Returns a DocTrees object for a given CompilationTask.- Parameters:
task- the compilation task for which to get the Trees object- Returns:
- the DocTrees object
- Throws:
IllegalArgumentException- if the task does not support the Trees API.
-
instance
public static DocTrees instance(ProcessingEnvironment env)
Returns a DocTrees object for a given ProcessingEnvironment.- Parameters:
env- the processing environment for which to get the Trees object- Returns:
- the DocTrees object
- Throws:
IllegalArgumentException- if the env does not support the Trees API.
-
getBreakIterator
public abstract BreakIterator getBreakIterator()
Returns the break iterator used to compute the first sentence of documentation comments. Returnsnullif none has been specified.- Returns:
- the break iterator
- Since:
- 9
-
getDocCommentTree
public abstract DocCommentTree getDocCommentTree(TreePath path)
Returns the doc comment tree, if any, for the Tree node identified by a given TreePath. Returnsnullif no doc comment was found.- Parameters:
path- the path for the tree node- Returns:
- the doc comment tree
-
getDocCommentTree
public abstract DocCommentTree getDocCommentTree(Element e)
Returns the doc comment tree of the given element. Returnsnullif no doc comment was found.- Parameters:
e- an element whose documentation is required- Returns:
- the doc comment tree
- Since:
- 9
-
getDocCommentTree
public abstract DocCommentTree getDocCommentTree(FileObject fileObject)
Returns the doc comment tree of the given file. The file must be an HTML file, in which case the doc comment tree represents the entire contents of the file. Returnsnullif no doc comment was found. Future releases may support additional file types.- Parameters:
fileObject- the content container- Returns:
- the doc comment tree
- Since:
- 9
-
getDocCommentTree
public abstract DocCommentTree getDocCommentTree(Element e, String relativePath) throws IOException
Returns the doc comment tree of the given file whose path is specified relative to the given element. The file must be an HTML file, in which case the doc comment tree represents the contents of the <body> tag, and any enclosing tags are ignored. Returnsnullif no doc comment was found. Future releases may support additional file types.- Parameters:
e- an element whose path is used as a referencerelativePath- the relative path from the Element- Returns:
- the doc comment tree
- Throws:
IOException- if an exception occurs- Since:
- 9
-
getDocTreePath
public abstract DocTreePath getDocTreePath(FileObject fileObject, PackageElement packageElement)
Returns a doc tree path containing the doc comment tree of the given file. The file must be an HTML file, in which case the doc comment tree represents the contents of the<body>tag, and any enclosing tags are ignored. Any references to source code elements contained in@seeand{@link}tags in the doc comment tree will be evaluated in the context of the given package element. Returnsnullif no doc comment was found.- Parameters:
fileObject- a file object encapsulating the HTML contentpackageElement- a package element to associate with the given file object representing a legacy package.html, null otherwise- Returns:
- a doc tree path containing the doc comment parsed from the given file
- Throws:
IllegalArgumentException- if the fileObject is not an HTML file- Since:
- 9
-
getElement
public abstract Element getElement(DocTreePath path)
Returns the language model element referred to by the leaf node of the givenDocTreePath, ornullif unknown.- Parameters:
path- the path for the tree node- Returns:
- the element
-
getFirstSentence
public abstract List<DocTree> getFirstSentence(List<? extends DocTree> list)
Returns the list ofDocTreerepresenting the first sentence of a comment.- Parameters:
list- the DocTree list to interrogate- Returns:
- the first sentence
- Since:
- 9
-
getSourcePositions
public abstract DocSourcePositions getSourcePositions()
Returns a utility object for accessing the source positions of documentation tree nodes.- Specified by:
getSourcePositionsin classTrees- Returns:
- the utility object
-
printMessage
public abstract 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- Parameters:
kind- the kind of messagemsg- the message, or an empty string if nonet- the tree to use as a position hintc- the doc comment tree to use as a position hintroot- the compilation unit that contains tree
-
setBreakIterator
public abstract void setBreakIterator(BreakIterator breakiterator)
Sets the break iterator to compute the first sentence of documentation comments.- Parameters:
breakiterator- a break iterator ornullto specify the default sentence breaker- Since:
- 9
-
getDocTreeFactory
public abstract DocTreeFactory getDocTreeFactory()
Returns a utility object for creatingDocTreeobjects.- Returns:
- a utility object for creating
DocTreeobjects - Since:
- 9
-
-