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

Все суперинтерфейсы:: Callable<Boolean>

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

public static interface DocumentationTool.DocumentationTask extends Callable<Boolean>

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

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

С:: 1.8

Краткое описание методов

Модификатор и тип	Метод	Описание
`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 - если вызван более одного раза

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://download.java.net/java/early_access/jdk24/docs/api/java.compiler/javax/tools/DocumentationTool.DocumentationTask.html