程序包 javax.tools

接口 DocumentationTool.DocumentationTask

所有超级接口:

Callable<Boolean>

封闭接口:

DocumentationTool

public static interface DocumentationTool.DocumentationTask
extends Callable<Boolean>

Interface representing a future for a documentation task. The task has not yet started. To start the task, call the call method.

Before calling the call method, additional aspects of the task can be configured, for example, by calling the setLocale method.

方法概要

限定符和类型	方法	说明
Boolean	call()	Performs this documentation task.
void	setLocale(Locale locale)	Set the locale to be applied when formatting diagnostics and other localized data.

方法详细资料

setLocale

void setLocale(Locale locale)

Set the locale to be applied when formatting diagnostics and other localized data.

参数:

locale - the locale to apply; null means apply no locale

抛出:

IllegalStateException - if the task has started

call

Boolean call()

Performs this documentation task. The task may only be performed once. Subsequent calls to this method throw IllegalStateException.

指定者:

call 在接口中 Callable<Boolean>

返回:

true if and only all the files were processed without errors; false otherwise

抛出:

RuntimeException - if an unrecoverable error occurred in a user-supplied component. The cause will be the error in user code.

IllegalStateException - if called more than once