Интерфейс SeeTag

Все суперинтерфейсы:: Tag

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

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

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

Представляет пользовательское перекрестное обращение к связанной документации. Тег может ссылаться на пакет, класс или член, или содержать обычный текст. (Обычный текст может быть ссылкой на что-то не онлайн, например, на печатную книгу, или жёстко закодированной HTML-ссылкой.) Ссылка может быть встроена в комментарий, используя {@link}, или в виде отдельного блока комментариев, используя @see. Метод name() возвращает "@link" (без фигурных скобок) или "@see", в зависимости от тега. Метод kind() возвращает "@see" для обоих тегов.

Методы

Модификатор и тип	Метод	Описание
`String`	`label()`	Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Получить метку тега `@see`.
`ClassDoc`	`referencedClass()`	Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Получить документацию класса, на которую ссылается часть имени класса в @see.
`String`	`referencedClassName()`	Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Получить имя класса или интерфейса ссылки `@see`.
`MemberDoc`	`referencedMember()`	Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Получить документацию члена для поля, конструктора или метода, на которые ссылается `@see`.
`String`	`referencedMemberName()`	Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Получить подстроку поля, конструктора или метода ссылки `@see`.
`PackageDoc`	`referencedPackage()`	Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Получить документацию пакета, когда `@see` ссылается только на пакет.

Методы, объявленные в интерфейсе com.sun.javadoc.Tag

firstSentenceTags, holder, inlineTags, kind, name, position, text, toString

Методы

label

String label()

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

Получить метку тега @see. Возвращает null, если метка отсутствует. Например, для:

@see String#trim() the trim method

возвращает "the trim method".

Возвращает:: "the trim method".

referencedPackage

PackageDoc referencedPackage()

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

Получить документацию пакета, когда @see ссылается только на пакет. Возвращает null, если пакет не найден, или если @see ссылается на любой другой элемент (класс, интерфейс, поле, конструктор, метод) или неэлемент. Например, для:

@see java.lang

возвращает PackageDoc для java.lang.

Возвращает:: the PackageDoc для java.lang.

referencedClassName

String referencedClassName()

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

Получить имя класса или интерфейса ссылки @see. Имя является полным, если указанное в исходном теге @see имя было полным, или если класс или интерфейс может быть найден; в противном случае оно неполное. Если @see ссылается только на имя пакета, то возвращается имя пакета. Например, для:

@see String#valueOf(java.lang.Object)

возвращает "java.lang.String". Для "@see java.lang", возвращает "java.lang". Возвращает null, если @see ссылается на неэлемент, такой как @see <a href="java.sun.com">.

Возвращает:: null, если @see ссылается на неэлемент, такой как @see <a href="java.sun.com">.

referencedClass

ClassDoc referencedClass()

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

Получить документацию класса, на которую ссылается часть имени класса в @see. Возвращает null, если класс не найден. Например, для:

@see String#valueOf(java.lang.Object)

возвращает ClassDoc для java.lang.String.

Возвращает:: the ClassDoc для java.lang.String.

referencedMemberName

String referencedMemberName()

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

Получить подстроку поля, конструктора или метода ссылки @see. Возвращает null, если ссылка на любой другой элемент или неэлемент. Ссылки на вложенные классы возвращают null. Например, для:

@see String#startsWith(String)

возвращает "startsWith(String)".

Возвращает:: "startsWith(String)".

referencedMember

MemberDoc referencedMember()

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

Получить документацию члена для поля, конструктора или метода, на которые ссылается @see. Возвращает null, если член не найден или если ссылка на любой другой элемент или неэлемент. Ссылки на вложенные классы возвращают null. Например, для:

@see String#startsWith(java.lang.String)

возвращает MethodDoc для startsWith.

Возвращает:: the MethodDoc для startsWith.