Документация интерфейса DocumentationTool

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

public interface DocumentationTool
extends Tool, OptionChecker

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

Вложенные классы

Модификатор и тип	Интерфейс и описание
`static interface`	`DocumentationTool.DocumentationTask` Интерфейс, представляющий будущее для задачи документирования.
`static class`	`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.Tool

getSourceVersions, run

Методы, унаследованные от интерфейса javax.tools.OptionChecker

isSupportedOption

Методы

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; 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, 2020, 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.