Интерфейс 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, 2021, 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/17/docs/api/java.compiler/javax/tools/DocumentationTool.DocumentationTask.html