Module java.compiler
Package javax.tools

Interface DocumentationTool.DocumentationTask

所有超级接口:
Callable<Boolean>
封闭接口:
DocumentationTool
public static interface DocumentationTool.DocumentationTask extends Callable<Boolean>
表示文档任务的未来的接口。 任务尚未启动。 要启动任务，请调用call方法。

在调用call方法之前，可以通过调用setLocale方法配置任务的其他方面。

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addModules(Iterable<String> moduleNames)
    添加要在模块解析期间考虑的根模块。
    Boolean
    call()
    执行此文档任务。
    void
    setLocale(Locale locale)
    设置在格式化诊断和其他本地化数据时应用的区域设置。

  • Method Details

    • addModules

      void addModules(Iterable<String> moduleNames)
      添加要在模块解析期间考虑的根模块。 无效的模块名称可能导致抛出IllegalArgumentException，或在启动任务时报告诊断信息。
      参数:
      moduleNames - 根模块的名称
      抛出:
      IllegalArgumentException - 对于一些无效的模块名称可能会抛出
      IllegalStateException - 如果任务已经启动
      自版本:
      9

    • setLocale

      void setLocale(Locale locale)
      设置在格式化诊断和其他本地化数据时应用的区域设置。
      参数:
      locale - 要应用的区域设置；null表示不应用区域设置
      抛出:
      IllegalStateException - 如果任务已经启动

    • call

      Boolean call()
      执行此文档任务。 任务只能执行一次。 对此方法的后续调用将抛出IllegalStateException。
      指定者:
      call 在接口 Callable<Boolean>
      返回:
      如果所有文件都在没有错误的情况下处理，则为true；否则为false
      抛出:
      RuntimeException - 如果用户提供的组件中发生不可恢复的错误。 cause将是用户代码中的错误。
      IllegalStateException - 如果调用超过一次