Module java.compiler
Package javax.tools

Interface DocumentationTool

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

  • Method Details

    • 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 - 提供文档注释所需方法的类；null表示使用标准文档注释。
      options - 文档工具选项和文档注释选项，null表示没有选项
      compilationUnits - 要编译的编译单元，null表示没有编译单元
      返回:
      代表编译的对象
      抛出:
      RuntimeException - 如果用户提供的组件中发生不可恢复的错误。 原因将是用户代码中的错误。
      IllegalArgumentException - 如果给定的编译单元中有其他类型而不是源

    • getStandardFileManager

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

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

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