Интерфейс 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://docs.oracle.com/en/java/javase/25/docs/api/java.compiler/javax/tools/DocumentationTool.DocumentationTask.html