Интерфейс Taglet

public interface Taglet

Интерфейс для пользовательского тега, поддерживаемого doclet, например, standard doclet. Пользовательские taglet используются для обработки пользовательских тегов в документационных комментариях.

Пользовательский taglet должен реализовать этот интерфейс и иметь публичный конструктор по умолчанию (публичный конструктор без параметров), с помощью которого doclet будет создавать и регистрировать пользовательский taglet.

Since:: 9

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

Модификатор и тип	Интерфейс	Описание
`static class`	`Taglet.Location`	Тип расположения, в котором может использоваться тег.

Методы

Модификатор и тип	Метод	Описание
`Set<Taglet.Location>`	`getAllowedLocations()`	Возвращает набор расположений, в которых может использоваться тег.
`String`	`getName()`	Возвращает имя тега.
`default void`	`init(DocletEnvironment env, Doclet doclet)`	Инициализирует этот taglet с заданной средой doclet и doclet.
`boolean`	`isInlineTag()`	Указывает, является ли этот taglet для тегов в строке или нет.
`String`	`toString(List<? extends DocTree> tags, Element element)`	Возвращает строковое представление последовательности экземпляров этого тега для включения в сгенерированный вывод.

Методы

getAllowedLocations

Set<Taglet.Location> getAllowedLocations()

Возвращает набор расположений, в которых может использоваться тег.

Возвращает:: набор расположений, в которых может использоваться тег

isInlineTag

boolean isInlineTag()

Указывает, является ли этот taglet для тегов в строке или нет.

Возвращает:: true, если этот taglet для тега в строке, и false в противном случае

getName

String getName()

Возвращает имя тега.

Возвращает:: имя этого пользовательского тега.

init

default void init(DocletEnvironment env,
                  Doclet doclet)

Инициализирует этот taglet с заданной средой doclet и doclet.

Примечание API:: Среда может использоваться для доступа к утилитам для elements и types, если это необходимо.
Требования к реализации:: Эта реализация ничего не делает.
Параметры:: env - среда, в которой работают doclet и taglet; doclet - doclet, который создал этот taglet

toString

String toString(List<? extends DocTree> tags,
                Element element)

Возвращает строковое представление последовательности экземпляров этого тега для включения в сгенерированный вывод. Если этот taglet для тега inline, он вызывается один раз на экземпляр тега, каждый раз со списком из одного элемента. В противном случае, если этот тег — тег блока, он вызывается один раз на комментарий, со списком всех экземпляров тега в комментарии.

Параметры:: tags - список экземпляров этого тега; element - элемент, к которому принадлежит содержащий комментарий
Возвращает:: строковое представление тегов для включения в сгенерированный вывод