Интерфейс DocumentationTool

Все суперинтерфейсы:: OptionChecker, Tool

public interface DocumentationTool extends Tool, OptionChecker

Интерфейс для вызова из программ средств документирования языка программирования Java.

Начиная с:: 1.8

Краткое описание вложенных классов

Модификатор и тип	Интерфейс	Описание
`static interface`	`DocumentationTool.DocumentationTask`	Интерфейс, представляющий ожидаемый результат задачи документирования.
`static enum`	`DocumentationTool.Location`	Местоположения, специфичные для `DocumentationTool`.

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

Модификатор и тип	Метод	Описание
`StandardJavaFileManager`	`getStandardFileManager(DiagnosticListener<? super JavaFileObject> diagnosticListener, Locale locale, Charset charset)`	Возвращает новый экземпляр стандартной реализации файлового менеджера для этого инструмента.
`DocumentationTool.DocumentationTask`	`getTask(Writer out, JavaFileManager fileManager, DiagnosticListener<? super JavaFileObject> diagnosticListener, Class<?> docletClass, Iterable<String> options, Iterable<? extends JavaFileObject> compilationUnits)`	Создает ожидаемый результат задачи документирования с заданными компонентами и аргументами.

Методы, объявленные в интерфейсе OptionChecker

isSupportedOption

Методы, объявленные в интерфейсе Tool

getSourceVersions, name, run

Подробное описание методов

getTask

DocumentationTool.DocumentationTask getTask(Writer out, JavaFileManager fileManager, DiagnosticListener<? super JavaFileObject> diagnosticListener, Class<?> docletClass, Iterable<String> options, Iterable<? extends JavaFileObject> compilationUnits)

Создает ожидаемый результат задачи документирования с заданными компонентами и аргументами. Выполнение задачи может быть не завершено, как описано в интерфейсе DocumentationTask.

Если файловый менеджер предоставлен, он должен поддерживать все местоположения, определенные в DocumentationTool.Location, а также StandardLocation.SOURCE_PATH, StandardLocation.CLASS_PATH и StandardLocation.PLATFORM_CLASS_PATH.

Параметры:: out — Writer для дополнительного вывода инструмента; используйте System.err, если null; fileManager — файловый менеджер; если null, используйте стандартный файловый менеджер инструмента; diagnosticListener — слушатель диагностических сообщений; если null, используйте метод инструмента по умолчанию для вывода диагностических сообщений; docletClass — класс, предоставляющий необходимые методы, требуемые от doclet; значение null означает, что следует использовать стандартный doclet.; options — параметры инструмента документирования и параметры doclet; null означает отсутствие параметров; compilationUnits — единицы компиляции для компиляции; null означает отсутствие единиц компиляции
Возвращает:: объект, представляющий компиляцию
Вызывает исключение:: RuntimeException — если в компоненте, предоставленном пользователем, произошла неустранимая ошибка. Причиной будет ошибка в пользовательском коде.; IllegalArgumentException — если какие-либо из заданных единиц компиляции имеют вид, отличный от исходного кода

getStandardFileManager

StandardJavaFileManager getStandardFileManager(DiagnosticListener<? super JavaFileObject> diagnosticListener, Locale locale, Charset charset)

Возвращает новый экземпляр стандартной реализации файлового менеджера для этого инструмента. Файловый менеджер будет использовать заданный слушатель диагностических сообщений для формирования всех нефатальных диагностических сообщений. О фатальных ошибках будут сообщать соответствующие исключения.

Стандартный файловый менеджер будет автоматически открыт повторно при обращении к нему после вызовов flush или close. Стандартный файловый менеджер должен быть пригоден для использования с другими инструментами.

Параметры:: diagnosticListener — слушатель диагностических сообщений для нефатальных диагностических сообщений; если null, используйте метод компилятора по умолчанию для вывода диагностических сообщений; locale — локаль, используемая при форматировании диагностических сообщений; null означает локаль по умолчанию.; charset — набор символов, используемый для декодирования байтов; если null, используйте системный набор символов по умолчанию
Возвращает:: стандартный файловый менеджер

© 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.html