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

Все известные реализующие классы:: StandardDoclet

public interface Doclet

Должен быть реализован пользовательский doclet, как описано в описании пакета. Каждая реализация Doclet должна предоставлять публичный конструктор без аргументов для использования инструментами для создания экземпляра doclet. Инфраструктура инструмента будет взаимодействовать с классами, реализующими этот интерфейс следующим образом:

Инструмент создаст экземпляр doclet, используя конструктор без аргументов класса doclet.
Затем инструмент вызовет метод init с соответствующим языковым локали и отчётчиком.
После этого инструмент вызовет getSupportedOptions и getSupportedSourceVersion. Эти методы вызываются только один раз.
По мере необходимости инструмент вызовет метод run в объекте doclet, передавая ему объект DocletEnvironment, с помощью которого doclet может определить элементы, которые необходимо включить в документацию.

Если объект doclet создан и используется без соблюдения вышеуказанного протокола, поведение doclet не определено этим интерфейсом.

Для запуска doclet передайте -doclet за которым следует полное квалифицированное имя класса точки входа (т.е. реализации этого интерфейса) в командной строке инструмента javadoc.

С:: 9

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

Модификатор и тип	Интерфейс	Описание
`static interface`	`Doclet.Option`	Инкапсуляция имени опции, псевдонимов, параметров и описаний, используемых Doclet.

Методы

Модификатор и тип	Метод	Описание
`String`	`getName()`	Возвращает имя, идентифицирующее doclet.
`Set<? extends Doclet.Option>`	`getSupportedOptions()`	Возвращает все поддерживаемые опции.
`SourceVersion`	`getSupportedSourceVersion()`	Возвращает версию языка программирования Java, поддерживаемую этим doclet.
`void`	`init(Locale locale, Reporter reporter)`	Инициализирует этот doclet с заданным языковым локали и отчётчиком об ошибках.
`boolean`	`run(DocletEnvironment environment)`	Точка входа в doclet.

Методы

init

void init(Locale locale,
          Reporter reporter)

Инициализирует этот doclet с заданным языковым локали и отчётчиком об ошибках. Этот локали будет использоваться отчётчиком и компонентами doclet.

Параметры:: locale - используемый локали; reporter - используемый отчётчик

getName

String getName()

Возвращает имя, идентифицирующее doclet. Имя представляет собой простой идентификатор без пробелов, как определено в Спецификации языка Java™, раздел 6.2 "Имена и идентификаторы".

Возвращает:: имя Doclet

getSupportedOptions

Set<? extends Doclet.Option> getSupportedOptions()

Возвращает все поддерживаемые опции.

Возвращает:: множество, содержащее все поддерживаемые опции, пустое множество, если их нет

getSupportedSourceVersion

SourceVersion getSupportedSourceVersion()

Возвращает версию языка программирования Java, поддерживаемую этим doclet.

Возвращает:: версия языка, поддерживаемая этим doclet, обычно последняя версия

run

boolean run(DocletEnvironment environment)

Точка входа в doclet. Дальнейшая обработка будет начата в соответствии с инструкциями этого метода.

Параметры:: environment - из которого можно извлечь важную информацию
Возвращает:: true при успехе