- java.lang.Object
-
- com.sun.source.util.Trees
-
- com.sun.source.util.DocTrees
-
public abstract class DocTrees extends Trees
提供对doc注释的语法树的访问。- 从以下版本开始:
- 1.8
-
-
构造方法摘要
构造方法 构造器 描述 DocTrees()
-
方法摘要
所有方法 静态方法 实例方法 抽象方法 具体的方法 变量和类型 方法 描述 abstract BreakIterator
getBreakIterator()
返回用于计算文档注释的第一句的break迭代器。abstract DocCommentTree
getDocCommentTree(TreePath path)
返回给定TreePath标识的Tree节点的doc注释树(如果有)。abstract DocCommentTree
getDocCommentTree(Element e)
返回给定元素的doc注释树。abstract DocCommentTree
getDocCommentTree(Element e, String relativePath)
返回给定文件的doc注释树,其路径是相对于给定元素指定的。abstract DocCommentTree
getDocCommentTree(FileObject fileObject)
返回给定文件的doc注释树。abstract DocTreeFactory
getDocTreeFactory()
返回用于创建DocTree
对象的实用程序对象。abstract DocTreePath
getDocTreePath(FileObject fileObject, PackageElement packageElement)
返回包含给定文件的doc注释树的文档树路径。abstract Element
getElement(DocTreePath path)
返回给定DocTreePath
的叶节点引用的语言模型元素,如果未知,则null
。abstract List<DocTree>
getFirstSentence(List<? extends DocTree> list)
返回表示注释第一句的DocTree
列表。abstract DocSourcePositions
getSourcePositions()
返回用于访问文档树节点的源位置的实用程序对象。static DocTrees
instance(ProcessingEnvironment env)
返回给定ProcessingEnvironment的DocTrees对象。static DocTrees
instance(JavaCompiler.CompilationTask task)
返回给定CompilationTask的DocTrees对象。abstract void
printMessage(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root)
在提供的编译单元中的树的位置打印指定种类的消息abstract void
setBreakIterator(BreakIterator breakiterator)
设置break迭代器以计算文档注释的第一句。-
声明方法的类 com.sun.source.util.Trees
getDocComment, getElement, getLub, getOriginalType, getPath, getPath, getPath, getPath, getScope, getTree, getTree, getTree, getTree, getTree, getTypeMirror, isAccessible, isAccessible, printMessage
-
-
-
-
方法详细信息
-
instance
public static DocTrees instance(JavaCompiler.CompilationTask task)
返回给定CompilationTask的DocTrees对象。- 参数
-
task
- 要获取Trees对象的编译任务 - 结果
- DocTrees对象
- 异常
-
IllegalArgumentException
- 如果任务不支持Trees API。
-
instance
public static DocTrees instance(ProcessingEnvironment env)
返回给定ProcessingEnvironment的DocTrees对象。- 参数
-
env
- 获取Trees对象的处理环境 - 结果
- DocTrees对象
- 异常
-
IllegalArgumentException
- 如果env不支持Trees API。
-
getBreakIterator
public abstract BreakIterator getBreakIterator()
返回用于计算文档注释的第一句的break迭代器。 如果未指定,则返回null
。- 结果
- 破解迭代器
- 从以下版本开始:
- 9
-
getDocCommentTree
public abstract DocCommentTree getDocCommentTree(TreePath path)
返回给定TreePath标识的Tree节点的doc注释树(如果有)。 如果未找到文档注释,则返回null
。- 参数
-
path
- 树节点的路径 - 结果
- 文档评论树
-
getDocCommentTree
public abstract DocCommentTree getDocCommentTree(Element e)
返回给定元素的doc注释树。 如果未找到文档注释,则返回null
。- 参数
-
e
- 需要其文档的元素 - 结果
- 文档评论树
- 从以下版本开始:
- 9
-
getDocCommentTree
public abstract DocCommentTree getDocCommentTree(FileObject fileObject)
返回给定文件的doc注释树。 该文件必须是HTML文件,在这种情况下,doc注释树表示文件的全部内容。 如果未找到文档注释,则返回null
。 未来版本可能支持其他文件类型。- 参数
-
fileObject
- 内容容器 - 结果
- 文档评论树
- 从以下版本开始:
- 9
-
getDocCommentTree
public abstract DocCommentTree getDocCommentTree(Element e, String relativePath) throws IOException
返回给定文件的doc注释树,其路径是相对于给定元素指定的。 该文件必须是HTML文件,在这种情况下,doc注释树表示<body>标记的内容,并且忽略任何封闭标记。 如果未找到文档注释,则返回null
。 未来版本可能支持其他文件类型。- 参数
-
e
- 其路径用作参考的元素 -
relativePath
- 元素的相对路径 - 结果
- 文档评论树
- 异常
-
IOException
- 如果发生异常 - 从以下版本开始:
- 9
-
getDocTreePath
public abstract DocTreePath getDocTreePath(FileObject fileObject, PackageElement packageElement)
返回包含给定文件的doc注释树的文档树路径。 该文件必须是HTML文件,在这种情况下,doc注释树表示<body>
标记的内容,并且忽略任何封闭标记。 将在给定包元素的上下文中评估对doc评论树中的@see
和{@link}
标记中包含的源代码元素的任何引用。 如果未找到文档注释,则返回null
。- 参数
-
fileObject
- 封装HTML内容的文件对象 -
packageElement
- 与表示旧版package.html的给定文件对象关联的包元素,否则为null - 结果
- 包含从给定文件解析的doc注释的文档树路径
- 异常
-
IllegalArgumentException
- 如果fileObject不是HTML文件 - 从以下版本开始:
- 9
-
getElement
public abstract Element getElement(DocTreePath path)
返回给定DocTreePath
的叶节点引用的语言模型元素,如果未知,则null
。- 参数
-
path
- 树节点的路径 - 结果
- 元素
-
getFirstSentence
public abstract List<DocTree> getFirstSentence(List<? extends DocTree> list)
返回表示注释的第一个句子的DocTree
的列表。- 参数
-
list
- 要查询的DocTree列表 - 结果
- 第一句话
- 从以下版本开始:
- 9
-
getSourcePositions
public abstract DocSourcePositions getSourcePositions()
返回用于访问文档树节点的源位置的实用程序对象。- Specified by:
-
getSourcePositions
类Trees
- 结果
- 实用程序对象
-
printMessage
public abstract void printMessage(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root)
在提供的编译单元中的树的位置打印指定种类的消息- 参数
-
kind
- 那种消息 -
msg
- 消息,如果没有,则为空字符串 -
t
- 用作位置提示的树 -
c
- 用作位置提示的doc注释树 -
root
- 包含树的编译单元
-
setBreakIterator
public abstract void setBreakIterator(BreakIterator breakiterator)
设置break迭代器以计算文档注释的第一句。- 参数
-
breakiterator
- 一个break iterator或null
来指定默认的句子断路器 - 从以下版本开始:
- 9
-
getDocTreeFactory
public abstract DocTreeFactory getDocTreeFactory()
返回用于创建DocTree
对象的实用程序对象。- 结果
-
用于创建
DocTree
对象的实用程序对象 - 从以下版本开始:
- 9
-
-