Интерфейс теглета

public interface Taglet

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

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

Документатор создаст экземпляр теглета, используя конструктор без аргументов класса теглета.
Далее, документатор вызовет метод init с соответствующей средой и документатором.
После этого, документатор вызовет getName, getAllowedLocations и isInlineTag, чтобы определить характеристики тегов, поддерживаемых теглетом.
По мере необходимости, документатор вызовет метод toString объекта теглета, передав ему список тегов и элемент, к которому относятся теги в комментарии к документации элемента, чтобы теглет мог определить строку, которая должна быть включена в документацию. Документатор обычно задаёт требования к содержимому возвращаемой строки.

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

Примечание API:

Обычно теглет проектируется для работы совместно со специфическим документатором.

С:

См. также:

Пользовательские теглеты для стандартного документатора

Краткое описание вложенных классов

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

Краткое описание методов

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

Подробное описание методов

getAllowedLocations

Set<Taglet.Location> getAllowedLocations()

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

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

isInlineTag

boolean isInlineTag()

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

Возвращает:: true, если этот теглет поддерживает встроенные теги

isBlockTag

default boolean isBlockTag()

Указывает, поддерживает ли этот теглет блочные теги.

Требования к реализации:: Эта реализация возвращает обратный результат к isInlineTag.
Возвращает:: true, если этот теглет поддерживает блочные теги

getName

String getName()

Возвращает имя тега, поддерживаемого этим теглетом.

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

init

default void init(DocletEnvironment env, Doclet doclet)

Инициализирует этот теглет с заданной средой документатора и документатором.

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

toString

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

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

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

Параметры:

tags - список экземпляров этого тега

element - элемент, к которому относится окружающий комментарий

Возвращает:

строковое представление тегов, которые должны быть включены в сгенерированный вывод

См. также:

Пользовательские теглеты для стандартного документатора

© 1993, 2021, 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.
https://docs.oracle.com/en/java/javase/17/docs/api/jdk.javadoc/jdk/javadoc/doclet/Taglet.html