模块 java.compiler
包 javax.tools

接口 DocumentationTool

所有父级接口：
OptionChecker , Tool
public interface DocumentationTool extends Tool , OptionChecker
从程序调用 Java 编程语言文档工具的接口。
自从：
1.8

  • 方法详情

    • getTask

      DocumentationTool.DocumentationTask  getTask(Writer  out, JavaFileManager  fileManager, DiagnosticListener <? super JavaFileObject > diagnosticListener, Class <?> docletClass, Iterable <String > options, Iterable <? extends JavaFileObject > compilationUnits)
      使用给定的组件和参数为文档任务创建未来。任务可能没有按照 DocumentationTask 接口中的描述完成。

      如果提供文件管理器，它必须能够处理 DocumentationTool.Location 以及 StandardLocation.SOURCE_PATH 、 StandardLocation.CLASS_PATH 和 StandardLocation.PLATFORM_CLASS_PATH 中定义的所有位置。

      参数：
      out - 用于工具额外输出的 Writer；如果 null 使用 System.err
      fileManager - 文件管理器；如果 null 使用该工具的标准文件管理器
      diagnosticListener - 诊断监听器；如果 null 使用该工具的默认方法来报告诊断
      docletClass - 提供 doclet 所需的必要方法的类； null 值表示使用标准 doclet。
      options - 文档工具选项和 doclet 选项，null 表示没有选项
      compilationUnits - 要编译的编译单元， null 表示没有编译单元
      返回：
      表示编译的对象
      抛出：
      RuntimeException - 如果在用户提供的组件中发生不可恢复的错误。 原因 将是用户代码中的错误。
      IllegalArgumentException - 如果任何给定的编译单元不是 source

    • getStandardFileManager

      StandardJavaFileManager  getStandardFileManager(DiagnosticListener <? super JavaFileObject > diagnosticListener, Locale  locale, Charset  charset)
      返回此工具的标准文件管理器实现的新实例。文件管理器将使用给定的诊断监听来生成任何非致命诊断。致命错误将以适当的异常发出信号。

      如果在调用 flush 或 close 后访问标准文件管理器，它将自动重新打开。标准文件管理器必须可与其他工具一起使用。

      参数：
      diagnosticListener - 用于非致命诊断的诊断监听器；如果 null 使用编译器的默认方法来报告诊断
      locale - 格式化诊断时要应用的locale； null 表示 默认locale 。
      charset - 用于解码字节的字符集；如果null使用平台默认值
      返回：
      标准文件管理器