compact3

javax.tools

Interface DocumentationTool.DocumentationTask

All Superinterfaces:

Callable < Boolean >

Enclosing interface:

DocumentationTool

public static interface DocumentationTool.DocumentationTask
extends Callable<Boolean>

表示文档任务的未来的接口。 任务尚未开始。 要启动任务，请调用call方法。

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

方法摘要

Modifier and Type	Method and Description
Boolean	call() 执行此文档任务。
void	setLocale(Locale locale) 设置格式化诊断和其他本地化数据时应用的区域设置。

方法详细信息

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