compact3

javax.tools

Интерфейс DocumentationTool. DocumentationTask

Все Суперинтерфейсы:

Вызываемый <Булев>

Включение интерфейса:

DocumentationTool

public static interface DocumentationTool.DocumentationTask
extends Callable<Boolean>

Интерфейс, представляющий будущее для задачи документации. Задача еще не запустилась. Чтобы запустить задачу, вызовите метод вызова.

Прежде, чем вызвать метод вызова, дополнительные аспекты задачи могут быть сконфигурированы, например, вызывая setLocale метод.

Сводка метода

Модификатор и Тип	Метод и Описание
Булев	call() Выполняет эту задачу документации.
void	setLocale(Locale locale) Установите локаль, которая будет применена, форматируя диагностику и другие локализованные данные.

Деталь метода

setLocale

void setLocale(Locale locale)

Установите локаль, которая будет применена, форматируя диагностику и другие локализованные данные.

Параметры:

locale - локаль, чтобы применяться; null средства не применяют локали

Броски:

IllegalStateException - если задача запустилась

вызвать

Boolean call()

Выполняет эту задачу документации. Однажды может только быть выполнена задача. Последующие звонки в этот метод бросают IllegalStateException.

Определенный:

call в интерфейсе Callable<Boolean>

Возвраты:

истина, если и только все файлы были обработаны без ошибок; ложь иначе

Броски:

RuntimeException - если неисправимая ошибка произошла в предоставленном пользователем компоненте. Причиной будет ошибка в пользовательском коде.

IllegalStateException - если вызвано не раз