模块  java.compiler
软件包  javax.tools

Interface DocumentationTool.DocumentationTask

  • All Superinterfaces:
    Callable<Boolean>
    Enclosing interface:
    DocumentationTool 
    public static interface DocumentationTool.DocumentationTask
extends Callable<Boolean>
    代表文档任务未来的接口。 任务尚未开始。 要启动任务，请调用call方法。

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

    • 方法详细信息

      • addModules

        void addModules​(Iterable<String> moduleNames)
        添加在模块解析期间要考虑的根模块。 无效的模块名称可能导致抛出IllegalArgumentException ，或者在启动任务时报告诊断。
        参数
        moduleNames - 根模块的名称
        异常
        IllegalArgumentException - 可能会因某些无效的模块名称而被抛出
        IllegalStateException - 如果任务已开始
        从以下版本开始：
        9

      • setLocale

        void setLocale​(Locale locale)
        设置格式化诊断和其他本地化数据时要应用的区域设置。
        参数
        locale - 要应用的区域设置; null表示不应用任何语言环境
        异常
        IllegalStateException - 如果任务已开始

      • call

        Boolean call()
        执行此文档任务。 任务只能执行一次。 对此方法的后续调用将抛出IllegalStateException。
        Specified by:
        call接口 Callable<Boolean>
        结果
        如果且仅处理了所有文件且没有错误，则为true; 否则是假的
        异常
        RuntimeException - 如果用户提供的组件中发生了不可恢复的错误。 cause将是用户代码中的错误。
        IllegalStateException - if called more than once