Интерфейс 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 - если произошла невосстановимая ошибка в предоставленном пользователем компоненте. Причина будет ошибкой в коде пользователя.; IllegalArgumentException - если какие-либо из заданных единиц компиляции имеют другой тип, кроме source

getStandardFileManager

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

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

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

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

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