Spec-Zone .ru
спецификации, руководства, описания, API
|
public interface Taglet
register
это принимает a Map
как параметр со следующей подписью: public void register(Map map)Этот метод должен добавить экземпляр пользовательского taglet к карте с именем taglet как ключ. Переопределяя taglet, чтобы избежать конфликта имен, переопределенный taglet должен быть удален из карты прежде, чем экземпляр нового taglet будет добавлен к карте.
Рекомендуется, чтобы taglet выдали исключение, когда это не в состоянии зарегистрировать себя. Исключение, которое это выдает, до пользователя.
Вот две выборки taglets:
Для получения дополнительной информации по тому, как создать Ваш собственный Taglets, пожалуйста, см. Краткий обзор Taglet.
Модификатор и Тип | Метод и Описание |
---|---|
Строка |
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)
Учитывая массив
Tag s представляющий этот пользовательский тег, возвратите его строковое представление, которое выводится к сгенерированной странице. |
boolean inField()
Taglet
используется в полевой документации. Набор ко лжи для встроенных тегов.Taglet
используется в полевой документации и лжи иначе.boolean inConstructor()
Taglet
используется в документации конструктора. Набор ко лжи для встроенных тегов.Taglet
используется в документации конструктора и лжи иначе.boolean inMethod()
Taglet
используется в документации метода. Набор ко лжи для встроенных тегов.Taglet
используется в документации метода и лжи иначе.boolean inOverview()
Taglet
используется в документации краткого обзора. Набор ко лжи для встроенных тегов.Taglet
используется в документации метода и лжи иначе.boolean inPackage()
Taglet
используется в документации пакета. Набор ко лжи для встроенных тегов.Taglet
используется в документации пакета и лжи иначе.boolean inType()
Taglet
используется в документации типа (классы или интерфейсы). Набор ко лжи для встроенных тегов.Taglet
используется в документации типа и лжи иначе.boolean isInlineTag()
Taglet
встроенный тег. Возвратите false иначе.Taglet
встроенный тег и ложь иначе.String getName()
String toString(com.sun.javadoc.Tag tag)
Tag
представление этого пользовательского тега, возвратите его строковое представление, которое выводится к сгенерированной странице.tag
- Tag
представление этого пользовательского тега.Tag
.String toString(com.sun.javadoc.Tag[] tags)
Tag
s представляющий этот пользовательский тег, возвратите его строковое представление, которое выводится к сгенерированной странице. Этот метод должен возвратить нуль, если этот taglet представляет встроенный тег.tags
- массив Tag
s представление этого пользовательского тега.Tag
.
Java является торговой маркой или зарегистрированной торговой маркой Oracle и/или его филиалов в US и других странах.
Авторское право © 1993, 2011, Oracle и/или его филиалы. 500 Oracle Parkway
Берега красного дерева, Калифорния 94065 США. Все права защищены.