-
public interface DocletEnvironment
表示doclet的单个调用的操作环境。 此对象可用于在命令行上访问程序结构,各种实用程序和用户指定的元素。- 从以下版本开始:
- 9
-
-
嵌套类汇总
嵌套类 变量和类型 接口 描述 static class
DocletEnvironment.ModuleMode
-
方法摘要
所有方法 实例方法 抽象方法 变量和类型 方法 描述 DocTrees
getDocTrees()
返回DocTrees
实用程序类的实例。Elements
getElementUtils()
返回Elements
实用程序类的实例。JavaFileObject.Kind
getFileKind(TypeElement type)
返回类型元素的文件类型。Set<? extends Element>
getIncludedElements()
返回文档中应为 included的模块,包和类型元素。JavaFileManager
getJavaFileManager()
返回用于读取和写入文件的文件管理器。DocletEnvironment.ModuleMode
getModuleMode()
返回所需的模块文档级别。SourceVersion
getSourceVersion()
返回已读取的源文件的源版本。Set<? extends Element>
getSpecifiedElements()
调用工具时返回元素 specified 。Types
getTypeUtils()
返回Types
实用程序类的实例。boolean
isIncluded(Element e)
如果文档中的元素应为 included ,则返回true。boolean
isSelected(Element e)
如果元素是 selected,则返回true。
-
-
-
方法详细信息
-
getIncludedElements
Set<? extends Element> getIncludedElements()
返回文档中应为 included的模块,包和类型元素。- 结果
- 包含元素的集合
-
getDocTrees
DocTrees getDocTrees()
返回DocTrees
实用程序类的实例。 该类提供了访问TreePath
s,DocCommentTree
等的方法。- 结果
- 在doc树上运行的实用程序类
-
getElementUtils
Elements getElementUtils()
返回Elements
实用程序类的实例。 此类提供了在elements
上操作的方法。- 结果
- 用于操作元素的实用程序类
-
getTypeUtils
Types getTypeUtils()
返回Types
实用程序类的实例。 此类提供了在type mirrors
上运行的方法。- 结果
- 用于操作类型镜像的实用程序类
-
isIncluded
boolean isIncluded(Element e)
如果文档中的元素应为 included ,则返回true。- 参数
-
e
- 元素 - 结果
- 如果包含则为true,否则为false
-
getJavaFileManager
JavaFileManager getJavaFileManager()
返回用于读取和写入文件的文件管理器。- 结果
- 用于读写文件的文件管理器
-
getSourceVersion
SourceVersion getSourceVersion()
返回已读取的源文件的源版本。- 结果
- 源版本
-
getModuleMode
DocletEnvironment.ModuleMode getModuleMode()
返回所需的模块文档级别。- 结果
- 所需的模块文档级别
-
getFileKind
JavaFileObject.Kind getFileKind(TypeElement type)
返回类型元素的文件类型。- 参数
-
type
- 类型元素 - 结果
- 文件种类
-
-