Module  java.compiler
软件包  javax.tools

Interface DocumentationTool.DocumentationTask

  • All Superinterfaces:
    Callable<Boolean>
    Enclosing interface:
    DocumentationTool 

    public static interface DocumentationTool.DocumentationTask
extends Callable<Boolean>
    表示文档任务的未来的接口。 任务尚未开始。 要启动任务，请调用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>
        结果
        如果且仅当所有文件被处理没有错误，则为真; 否则为假
        异常
        RuntimeException - 如果在用户提供的组件中发生不可恢复的错误。 cause将是用户代码中的错误。
        IllegalStateException - if called more than once