Интерфейс Taglet

public interface Taglet

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

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

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

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