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

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

public interface DocumentationTool
extends Tool, OptionChecker

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

С тех пор:: 1.8

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

Модификатор и тип	Интерфейс	Описание
`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.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 - объект Writer для дополнительного вывода от инструмента; используйте 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 используйте стандартную кодировку платформы
Возвращает:: стандартный менеджер файлов