Интерфейс Tag

Все известные подинтерфейсы:: ParamTag, SeeTag, SerialFieldTag, ThrowsTag

@Deprecated(since="9",
            forRemoval=true)
public interface Tag

Устаревшее, подлежащее удалению: этот элемент API может быть удален в будущей версии.

Объявления в этом пакете устарели и заменены объявлениями в пакете jdk.javadoc.doclet. Дополнительную информацию можно найти в руководстве по миграции в документации этого пакета.

Представляет собой простой тег документации, например, @since, @author, @version. Принимая тег (например, "@since 1.2"), хранит имя тега (например, "@since") и текст тега (например, "1.2"). Теги со структурой или требующие специальной обработки обрабатываются подклассами, такими как ParamTag (для @param), SeeTag (для @see и ), и ThrowsTag (для @throws).

См. также:: SeeTag, ParamTag, ThrowsTag, SerialFieldTag, Doc.tags()

Методы

Модификатор и тип	Метод	Описание
`Tag[]`	`firstSentenceTags()`	Устаревшее, подлежащее удалению: этот элемент API может быть удален в будущей версии. Возвращает первое предложение комментария в виде массива тегов.
`Doc`	`holder()`	Устаревшее, подлежащее удалению: этот элемент API может быть удален в будущей версии. Возвращает содержащий `Doc` элемент тега Tag.
`Tag[]`	`inlineTags()`	Устаревшее, подлежащее удалению: этот элемент API может быть удален в будущей версии. Для комментария документации с вложенными `{@link}` тегами возвращает массив объектов `Tag`.
`String`	`kind()`	Устаревшее, подлежащее удалению: этот элемент API может быть удален в будущей версии. Возвращает тип этого тега.
`String`	`name()`	Устаревшее, подлежащее удалению: этот элемент API может быть удален в будущей версии. Возвращает имя этого тега.
`SourcePosition`	`position()`	Устаревшее, подлежащее удалению: этот элемент API может быть удален в будущей версии. Возвращает позицию источника этого тега.
`String`	`text()`	Устаревшее, подлежащее удалению: этот элемент API может быть удален в будущей версии. Возвращает текст этого тега, то есть часть, которая идет после имени тега.
`String`	`toString()`	Устаревшее, подлежащее удалению: этот элемент API может быть удален в будущей версии. Преобразует этот объект в строку.

Методы

name

String name()

Устаревшее, подлежащее удалению: этот элемент API может быть удален в будущей версии.

Возвращает имя этого тега. Имя — это строка, начинающаяся с "@" и используемая в комментарии к документации, например, @return. Для встраиваемых тегов, таких как {@link}, фигурные скобки не являются частью имени, поэтому в этом примере именем будет просто @link.

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

holder

Doc holder()

Устаревшее, подлежащее удалению: этот элемент API может быть удален в будущей версии.

Возвращает содержащий Doc элемент тега Tag.

Возвращает:: содержащий Doc элемент тега Tag

kind

String kind()

Устаревшее, подлежащее удалению: этот элемент API может быть удален в будущей версии.

Возвращает тип этого тега. Для большинства тегов kind() == name(); следующая таблица перечисляет случаи, когда существует более одного тега данного типа:

`name()`	`kind()`
`@exception`	`@throws`
`@link`	`@see`
`@linkplain`	`@see`
`@see`	`@see`
`@serial`	`@serial`
`@serialData`	`@serial`
`@throws`	`@throws`

Возвращает:: тип этого тега.

text

String text()

Устаревшее, подлежащее удалению: этот элемент API может быть удален в будущей версии.

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

Возвращает:: текст этого тега

toString

String toString()

Устаревшее, подлежащее удалению: этот элемент API может быть удален в будущей версии.

Преобразует этот объект в строку.

Переопределяет:: toString в классе Object
Возвращает:: строковое представление объекта.

inlineTags

Tag[] inlineTags()

Устаревшее, подлежащее удалению: этот элемент API может быть удален в будущей версии.

Для комментария документации с вложенными {@link} тегами возвращает массив объектов Tag. Весь комментарий к документации разбивается на строки, разделенные {@link} тегами, где каждый последующий элемент массива представляет собой либо строку, либо {@link} тег в порядке от начала до конца. Каждая строка представлена объектом Tag с именем «Текст», где text() возвращает строку. Каждый {@link} тег представлен SeeTag с именем «@link» и типом «@see». Например, применительно к следующему тегу комментария:

This is a {@link Doc commentlabel} example.

возвращает массив объектов Tag:

tags[0] — Tag с именем «Текст» и текстом «Это пример »
tags[1] — SeeTag с именем «@link», ссылающийся на класс Doc и меткой «commentlabel»
tags[2] — Tag с именем «Текст» и текстом « пример.»

Возвращает:: массив Tag[] тегов
См. также:: ParamTag, ThrowsTag

firstSentenceTags

Tag[] firstSentenceTags()

Устаревшее, подлежащее удалению: этот элемент API может быть удален в будущей версии.

Возвращает первое предложение комментария в виде массива тегов. Включает встраиваемые теги (т. е. теги {@link reference}), но не блочные теги. Каждая часть обычного текста представлена как Tag типа «Текст». Встраиваемые теги представлены как SeeTag типа «@link». Если язык — английский, первое предложение определяется правилами, описанными в спецификации языка Java (первая версия): «Это предложение заканчивается первой точкой, за которой следуют пробел, табуляция или разделитель строки, или первым тегом, а также строка будет завершена тегами HTML, завершающими абзац и раздел: <p> </p> <h1> <h2> <h3> <h4> <h5> <h6> <hr> <pre> или </pre>». Если язык не английский, окончание предложения будет определяться BreakIterator.getSentenceInstance(Locale).

Возвращает:: массив объектов Tag, представляющих первое предложение комментария

position

SourcePosition position()

Устаревшее, подлежащее удалению: этот элемент API может быть удален в будущей версии.

Возвращает позицию источника этого тега.

Возвращает:: позицию источника этого тега.