Интерфейс 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

Модификатор и тип	Метод	Описание
`int`	`isSupportedOption(String option)`	Определяет, поддерживается ли указанный параметр, и если да, то сколько аргументов он принимает.

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

getSourceVersions, name, run

Модификатор и тип	Метод	Описание
`Set<SourceVersion>`	`getSourceVersions()`	Возвращает версии исходного кода языка программирования Java, поддерживаемые этим инструментом.
`default String`	`name()`	Возвращает имя этого инструмента или пустую строку, если имя не задано.
`int`	`run(InputStream in, OutputStream out, OutputStream err, String... arguments)`	Запускает инструмент с указанными каналами ввода-вывода и аргументами.

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

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 — класс, предоставляющий необходимые методы доклета; значение null означает, что следует использовать стандартный доклет.; options — параметры инструмента документирования и параметры доклета; 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.