Интерфейс Doc
- Все суперинтерфейсы:
Comparable<Object>
- Все известные подинтерфейсы:
-
AnnotationTypeDoc,AnnotationTypeElementDoc,ClassDoc,ConstructorDoc,ExecutableMemberDoc,FieldDoc,MemberDoc,MethodDoc,PackageDoc,ProgramElementDoc,RootDoc
@Deprecated(since="9",
forRemoval=true)
public interface Doc
extends Comparable<Object> jdk.javadoc.doclet. Дополнительную информацию см. в руководстве по миграции в документации по этому пакету.Представляет языковые конструкции языка Java (пакет, класс, конструктор, метод, поле), которые содержат комментарии и были обработаны этим запуском javadoc. Все объекты Doc уникальны, то есть они == сравнимы.
- С момента:
- 1.2
Методы
| Модификатор и тип | Метод | Описание |
|---|---|---|
String | commentText() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает текст комментария для данного элемента документа. |
int | compareTo(Object obj) | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Сравнивает этот объект документа с указанным объектом для определения порядка. |
Tag[] | firstSentenceTags() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает первое предложение комментария в виде массива тегов. |
String | getRawCommentText() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает весь необработанный текст комментария. |
Tag[] | inlineTags() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает комментарий в виде массива тегов. |
boolean | isAnnotationType() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Является ли этот элемент документа типа аннотации? |
boolean | isAnnotationTypeElement() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Является ли этот элемент документа элементом типа аннотации? |
boolean | isClass() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Является ли этот элемент документа классом (а не интерфейсом или типом аннотации)? |
boolean | isConstructor() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Является ли этот элемент документа конструктором? |
boolean | isEnum() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Является ли этот элемент документа типом перечисления? |
boolean | isEnumConstant() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Является ли этот элемент документа константой перечисления? |
boolean | isError() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Является ли этот элемент документа классом ошибки? |
boolean | isException() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Является ли этот элемент документа классом исключения? |
boolean | isField() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Является ли этот элемент документа полем (но не константой перечисления)? |
boolean | isIncluded() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает true, если этот элемент документа включен в результирующий набор. |
boolean | isInterface() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Является ли этот элемент документа интерфейсом (но не типом аннотации)? |
boolean | isMethod() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Является ли этот элемент документа методом (но не конструктором или элементом типа аннотации)? |
boolean | isOrdinaryClass() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Является ли этот элемент документа обычным классом? |
String | name() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает неквалифицированное имя данного элемента документа. |
SourcePosition | position() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает позицию в исходном коде первой строки соответствующего объявления или null, если позиция недоступна. |
SeeTag[] | seeTags() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает теги «см. также» в данном элементе документа. |
void | setRawCommentText(String rawDocumentation) | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Устанавливает весь необработанный текст комментария. |
Tag[] | tags() | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает все теги в данном элементе документа. |
Tag[] | tags(String tagname) | Устаревшее, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает теги указанного типа в данном элементе документа. |
Методы
commentText
String commentText()
Возвращает текст комментария для данного элемента документации. Теги удалены.
- Возвращает:
- текст комментария для данного элемента документации.
tags
Tag[] tags()
Возвращает все теги в этом элементе документации.
- Возвращает:
- массив объектов
Tagсодержащий все теги данного элемента документации.
tags
Tag[] tags(String tagname)
Возвращает теги заданного типа в этом элементе документации. Например, если 'tagname' имеет значение "@serial", будут возвращены все теги в этом элементе документации типа "@serial".
- Параметры:
-
tagname- имя типа тега для поиска. - Возвращает:
- массив тегов, содержащих все теги, чьё свойство 'kind()' соответствует 'tagname'.
seeTags
SeeTag[] seeTags()
Возвращает теги "см. также" в данном элементе документации.
- Возвращает:
- массив SeeTag, содержащий все теги @see.
inlineTags
Tag[] inlineTags()
Возвращает комментарий в виде массива тегов. Включает встроенные теги (например, {@link ссылка} теги), но не блочные теги. Каждый фрагмент простого текста представлен как Tag типа kind "Текст". Встроенные теги представлены как SeeTag типа "@see" и именем "@link".
- Возвращает:
- массив
Tagпредставляющий комментарий
firstSentenceTags
Tag[] firstSentenceTags()
Возвращает первую строку комментария в виде массива тегов. Включает встроенные теги (например, {@link ссылка} теги), но не блочные теги. Каждый фрагмент простого текста представлен как Tag типа kind "Текст". Встроенные теги представлены как SeeTag типа "@see" и именем "@link".
Если язык локализации — английский, первая строка определяется правилами, описанными в спецификации языка Java (первая версия): "Эта фраза заканчивается первой точкой, за которой следует пробел, табуляция или разделитель строки, или первой меткой строки", а также строка будет завершена блочными HTML-тегами: <p> </p> <h1> <h2> <h3> <h4> <h5> <h6> <hr> <pre> или </pre>. Если язык локализации не английский, окончание предложения определяется BreakIterator.getSentenceInstance(Locale).
- Возвращает:
- массив
Tagпредставляющих первую строку комментария
getRawCommentText
String getRawCommentText()
Возвращает весь необработанный текст комментария. Теги включены как текст. Используется в основном для операций хранения и извлечения, таких как локализация.
- Возвращает:
- полный необработанный текст комментария.
setRawCommentText
void setRawCommentText(String rawDocumentation)
Устанавливает весь необработанный текст комментария. Теги включены как текст. Используется в основном для операций хранения и извлечения, таких как локализация.
- Параметры:
-
rawDocumentation- строка, содержащая весь необработанный текст комментария.
name
String name()
Возвращает имя этого элемента документации без квалификатора.
- Возвращает:
- имя
compareTo
int compareTo(Object obj)
Сравнивает этот объект документации с указанным объектом для определения порядка. Возвращает отрицательное целое число, ноль или положительное целое число, если этот объект документации меньше, равен или больше указанного объекта.
Этот метод удовлетворяет интерфейсу Comparable.
- Определено в:
-
compareToв интерфейсеComparable<Object> - Параметры:
-
obj- объектObjectдля сравнения. - Возвращает:
- отрицательное целое число, ноль или положительное целое число, если данный объект меньше, равен или больше заданного объекта.
- Исключение:
-
ClassCastException- тип указанного объекта не позволяет сравнить его с этим объектом.
isField
boolean isField()
Является ли данный элемент документации полем (но не константой перечисления)?
- Возвращает:
- true, если представляет собой поле
isEnumConstant
boolean isEnumConstant()
Является ли данный элемент документации константой перечисления?
- Возвращает:
- true, если представляет собой константу перечисления
- С момента:
- 1.5
isConstructor
boolean isConstructor()
Является ли данный элемент документации конструктором?
- Возвращает:
- true, если представляет собой конструктор
isMethod
boolean isMethod()
Является ли данный элемент документации методом (но не конструктором или элементом типа аннотации)?
- Возвращает:
- true, если представляет собой метод
isAnnotationTypeElement
boolean isAnnotationTypeElement()
Является ли данный элемент документации элементом типа аннотации?
- Возвращает:
- true, если представляет собой элемент типа аннотации
- С момента:
- 1.5
isInterface
boolean isInterface()
Является ли данный элемент документации интерфейсом (но не типом аннотации)?
- Возвращает:
- true, если представляет собой интерфейс
isException
boolean isException()
Является ли данный элемент документации классом исключения?
- Возвращает:
- true, если представляет собой исключение
isError
boolean isError()
Является ли данный элемент документации классом ошибки?
- Возвращает:
- true, если представляет собой ошибку
isEnum
boolean isEnum()
Является ли данный элемент документации типом перечисления?
- Возвращает:
- true, если представляет собой тип перечисления
- С момента:
- 1.5
isAnnotationType
boolean isAnnotationType()
Является ли данный элемент документации типом аннотации?
- Возвращает:
- true, если представляет собой тип аннотации
- С момента:
- 1.5
isOrdinaryClass
boolean isOrdinaryClass()
Является ли данный элемент документации обычным классом? (т.е. не интерфейсом, типом аннотации, перечислением, исключением или ошибкой)?
- Возвращает:
- true, если представляет собой обычный класс
isClass
boolean isClass()
Является ли данный элемент документации классом (и не интерфейсом или типом аннотации)? Это включает обычные классы, перечисления, ошибки и исключения.
- Возвращает:
- true, если представляет собой класс
isIncluded
boolean isIncluded()
Возвращает true, если данный элемент документации включен в результирующий набор.
- Возвращает:
- true, если данный элемент документации включен в результирующий набор.
position
SourcePosition position()
Возвращает исходную позицию первой строки соответствующего объявления или null, если позиция недоступна. Конструктор по умолчанию возвращает null, так как он не имеет местоположения в исходном файле.
- Возвращает:
- исходная позиция первой строки соответствующего объявления, или null, если позиция недоступна. Конструктор по умолчанию возвращает null, так как он не имеет местоположения в исходном файле.
- С момента:
- 1.4
© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/11/docs/api/jdk.javadoc/com/sun/javadoc/Doc.html