Module jdk.javadoc
Package jdk.javadoc.doclet

Interface DocletEnvironment

public interface DocletEnvironment
表示文档生成器单次调用的操作环境。此对象可用于访问程序结构、各种实用工具和命令行上指定的元素。
自 JDK 版本:
9

  • Method Details

    • getSpecifiedElements

      Set<? extends Element> getSpecifiedElements()
      返回工具调用时指定的元素。
      返回:
      指定的元素集合

    • getIncludedElements

      Set<? extends Element> getIncludedElements()
      返回应该在文档中包含的模块、包和类型元素。
      返回:
      包含的元素集合

    • getDocTrees

      DocTrees getDocTrees()
      返回 DocTrees 实用工具类的实例。该类提供了访问 TreePath、DocCommentTree 等的方法。
      返回:
      用于操作文档树的实用工具类

    • getElementUtils

      Elements getElementUtils()
      返回 Elements 实用工具类的实例。该类提供了操作 元素 的方法。
      返回:
      用于操作元素的实用工具类

    • getTypeUtils

      Types getTypeUtils()
      返回 Types 实用工具类的实例。该类提供了操作 类型镜像 的方法。
      返回:
      用于操作类型镜像的实用工具类

    • isIncluded

      boolean isIncluded(Element e)
      如果元素应包含在文档中，则返回 true。
      参数:
      e - 元素
      返回:
      如果包含则为 true，否则为 false

    • isSelected

      boolean isSelected(Element e)
      如果元素已选择，则返回 true。
      参数:
      e - 元素
      返回:
      如果已选择则为 true，否则为 false

    • getJavaFileManager

      JavaFileManager getJavaFileManager()
      返回用于读取和写入文件的文件管理器。
      返回:
      用于读取和写入文件的文件管理器

    • getSourceVersion

      SourceVersion getSourceVersion()
      返回已读取源文件的源版本。
      返回:
      源版本

    • getModuleMode

      DocletEnvironment.ModuleMode getModuleMode()
      返回所需的模块文档级别。
      返回:
      所需的模块文档级别

    • getFileKind

      JavaFileObject.Kind getFileKind(TypeElement type)
      返回类型元素的文件类型。
      参数:
      type - 类型元素
      返回:
      文件类型