Интерфейс Taglet

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, если этот теглет поддерживает блочные теги
Появился в версии:: 15

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, 2025, 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/25/docs/api/jdk.javadoc/jdk/javadoc/doclet/Taglet.html