模块 java.compiler

包 javax.tools

接口 DocumentationTool.DocumentationTask

所有父级接口：

Callable<Boolean>

封闭接口：

DocumentationTool

public static interface DocumentationTool.DocumentationTask extends Callable <Boolean >
      

代表文档任务未来的接口。任务还没有开始。要启动任务，请调用 call 方法。

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

方法总结

修饰符和类型	方法	描述
void	addModules(Iterable<String> moduleNames)	添加在模块解析期间要考虑的根模块。
Boolean	call()	执行此文档任务。
void	setLocale(Locale locale)	设置在格式化诊断和其他本地化数据时要应用的locale。

方法详情

addModules

void addModules(Iterable <String > moduleNames)
            

添加在模块解析期间要考虑的根模块。无效的模块名称可能会导致抛出 IllegalArgumentException，或者在任务启动时报告诊断信息。

参数：

moduleNames - 根模块的名称

抛出：

IllegalArgumentException - 可能会因某些无效模块名称而抛出

IllegalStateException - 如果任务已经开始

自从：

9

setLocale

void setLocale(Locale  locale)
            

设置在格式化诊断和其他本地化数据时要应用的locale。

参数：

locale - 要应用的locale； null 表示不应用locale

抛出：

IllegalStateException - 如果任务已经开始

call

Boolean  call()
            

执行此文档任务。任务只能执行一次。对该方法的后续调用会抛出 IllegalStateException。

指定者：

call 在接口 Callable<Boolean> 中

返回：

当且仅当所有文件都处理无误时才为真；否则为假

抛出：

RuntimeException - 如果在用户提供的组件中发生不可恢复的错误。 原因 将是用户代码中的错误。

IllegalStateException - 如果多次调用