compact3

javax.tools

Интерфейс DocumentationTool

Все Суперинтерфейсы:

OptionChecker, Инструмент

public interface DocumentationTool
extends Tool, OptionChecker

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

Вложенная Сводка Класса

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

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

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 используйте стандарт инструмента filemanager

diagnosticListener - диагностический слушатель; если null используйте метод значения по умолчанию инструмента для того, чтобы сообщить о диагностике

docletClass - class, обеспечивающий необходимые методы, требуется doclet

options - опции инструмента документации и doclet опции, null средства никакие опции

compilationUnits - единицы компиляции, чтобы скомпилировать, null средства никакие единицы компиляции

Возвраты:

объект, представляющий компиляцию

Броски:

RuntimeException - если неисправимая ошибка произошла в пользователе предоставленный компонент. Причиной будет ошибка в пользовательском коде.

IllegalArgumentException - если какая-либо из данных единиц компиляции является другим видом чем источник

getStandardFileManager

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

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

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

Параметры:

diagnosticListener - диагностический слушатель для нефатальной диагностики; если null используйте метод значения по умолчанию компилятора для того, чтобы сообщить о диагностике

locale - локаль, чтобы применяться, форматируя диагностику; null означает локаль значения по умолчанию.

charset - набор символов используется для того, чтобы декодировать байты; если null используйте значение по умолчанию платформы

Возвраты:

стандартный файловый менеджер