Интерфейс 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)`	Создает будущее для задачи документации с заданными компонентами и аргументами.

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

isSupportedOption

Методы, объявленные в интерфейсе javax.tools.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 - Поток для дополнительного вывода от инструмента; используйте System.err, если null; fileManager - менеджер файлов; если null используйте стандартный менеджер файлов инструмента; diagnosticListener - слушатель диагностики; если null используйте стандартный метод инструмента для отчета о диагностике; docletClass - класс, предоставляющий необходимые методы, требуемые от doclet; значение null означает использование стандартного doclet.; options - параметры инструмента документации и параметры doclet, null означает отсутствие параметров; compilationUnits - единицы компиляции для компиляции, null означает отсутствие единиц компиляции
Возвращает:: объект, представляющий компиляцию
Исключения:: RuntimeException - если произошла невосстановимая ошибка в предоставленном пользователем компоненте. Причина (cause) будет ошибкой в коде пользователя.; 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://download.java.net/java/early_access/jdk24/docs/api/java.compiler/javax/tools/DocumentationTool.html