com.sun.tools.doclets

Интерфейс Taglet

public interface Taglet

Интерфейс для пользовательского тега используется Doclets. Пользовательский тег должен реализовать этот интерфейс. Чтобы быть загруженным и использоваться doclets во времени выполнения, taglet нужно было вызвать статический метод register это принимает a Map как параметр со следующей подписью:

   public void register(Map map)
 

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

Рекомендуется, чтобы taglet выдали исключение, когда это не в состоянии зарегистрировать себя. Исключение, которое это выдает, до пользователя.

Вот две выборки taglets:

• ToDoTaglet.java - Автономный taglet
• UnderlineTaglet.java - Встраивают taglet

Для получения дополнительной информации по тому, как создать Ваш собственный Taglets, пожалуйста, см. Краткий обзор Taglet.

С тех пор:

1.4

Сводка метода

Модификатор и Тип	Метод и Описание
Строка	getName() Возвратите имя этого пользовательского тега.
boolean	inConstructor() Возвратите true если это Taglet используется в документации конструктора.
boolean	inField() Возвратите true если это Taglet используется в полевой документации.
boolean	inMethod() Возвратите true если это Taglet используется в документации метода.
boolean	inOverview() Возвратите true если это Taglet используется в документации краткого обзора.
boolean	inPackage() Возвратите true если это Taglet используется в документации пакета.
boolean	inType() Возвратите true если это Taglet используется в документации типа (классы или интерфейсы).
boolean	isInlineTag() Возвратите true если это Taglet встроенный тег.
Строка	toString(com.sun.javadoc.Tag tag) Данный Tag представление этого пользовательского тега, возвратите его строковое представление, которое выводится к сгенерированной странице.
Строка	toString(com.sun.javadoc.Tag[] tags) Учитывая массив Tags представляющий этот пользовательский тег, возвратите его строковое представление, которое выводится к сгенерированной странице.

Деталь метода

приусадебный участок

boolean inField()

Возвратите true если это Taglet используется в полевой документации. Набор ко лжи для встроенных тегов.

Возвраты:

истина, если это Taglet используется в полевой документации и лжи иначе.

inConstructor

boolean inConstructor()

Возвратите true если это Taglet используется в документации конструктора. Набор ко лжи для встроенных тегов.

Возвраты:

истина, если это Taglet используется в документации конструктора и лжи иначе.

inMethod

boolean inMethod()

Возвратите true если это Taglet используется в документации метода. Набор ко лжи для встроенных тегов.

Возвраты:

истина, если это Taglet используется в документации метода и лжи иначе.

inOverview

boolean inOverview()

Возвратите true если это Taglet используется в документации краткого обзора. Набор ко лжи для встроенных тегов.

Возвраты:

истина, если это Taglet используется в документации метода и лжи иначе.

inPackage

boolean inPackage()

Возвратите true если это Taglet используется в документации пакета. Набор ко лжи для встроенных тегов.

Возвраты:

истина, если это Taglet используется в документации пакета и лжи иначе.

inType

boolean inType()

Возвратите true если это Taglet используется в документации типа (классы или интерфейсы). Набор ко лжи для встроенных тегов.

Возвраты:

истина, если это Taglet используется в документации типа и лжи иначе.

isInlineTag

boolean isInlineTag()

Возвратите true если это Taglet встроенный тег. Возвратите false иначе.

Возвраты:

истина, если это Taglet встроенный тег и ложь иначе.

getName

String getName()

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

Возвраты:

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

toString

String toString(com.sun.javadoc.Tag tag)

Данный Tag представление этого пользовательского тега, возвратите его строковое представление, которое выводится к сгенерированной странице.

Параметры:

tag - Tag представление этого пользовательского тега.

Возвраты:

строковое представление этого Tag.

toString

String toString(com.sun.javadoc.Tag[] tags)

Учитывая массив Tags представляющий этот пользовательский тег, возвратите его строковое представление, которое выводится к сгенерированной странице. Этот метод должен возвратить нуль, если этот taglet представляет встроенный тег.

Параметры:

tags - массив Tags представление этого пользовательского тега.

Возвраты:

строковое представление этого Tag.