Интерфейс 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 - если вызвано более одного раза

© 1993, 2023, 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://docs.oracle.com/en/java/javase/21/docs/api/java.compiler/javax/tools/DocumentationTool.DocumentationTask.html