Документация интерфейса DocumentationTool.DocumentationTask

public static interface DocumentationTool.DocumentationTask
extends Callable<Boolean>

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

Перед вызовом метода call можно настроить дополнительные аспекты задачи, например, вызвав метод setLocale.

Методы

setLocale

void setLocale(Locale locale)

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

Параметры:

locale - устанавливаемая локаль; null означает применение никакой локали

Исключения:

IllegalStateException - если задача уже начата

call

Boolean call()

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

Определено в:

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

Возвращает:

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

Исключения:

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

IllegalStateException - если метод вызван более одного раза