Интерфейс 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)`	Устанавливает локаль, которая будет применена при форматировании диагностики и других локализованных данных.

Методы

addModules

void addModules(Iterable<String> moduleNames)

Добавляет корневые модули, которые будут учтены при разрешении модулей. Некорректные имена модулей могут привести к тому, что будет брошено исключение IllegalArgumentException, или к тому, что диагностика будет сообщена при запуске задачи.

Параметры:: moduleNames - имена корневых модулей
Исключения:: IllegalArgumentException - может быть брошено для некоторых некорректных имён модулей; IllegalStateException - если задача уже начата
С момента:: 9

setLocale

void setLocale(Locale locale)

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

Параметры:: locale - локаль для применения; null означает не применять локаль
Исключения:: IllegalStateException - если задача уже начата

call

Boolean call()

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

Задано в:: call в интерфейсе Callable<Boolean>
Возвращает:: true, если и только если все файлы были обработаны без ошибок; false в противном случае
Исключения:: RuntimeException - если произошла невосстановимая ошибка в пользовательском компоненте. Причина будет ошибкой в пользовательском коде.; IllegalStateException - если вызвано более одного раза