Перечисление DocTree.Kind
- Все реализуемые интерфейсы:
-
Serializable,Comparable<DocTree.Kind>,Constable
- Вложенный интерфейс:
DocTree
public static enum DocTree.Kind extends Enum<DocTree.Kind>
Перечисляет все типы деревьев.
Краткое описание вложенных классов
Вложенные классы/интерфейсы, объявленные в классе java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
Краткое описание констант перечисления
| Константа перечисления | Описание |
|---|---|
ATTRIBUTE |
Используется для экземпляров AttributeTree, представляющих атрибут в HTML-элементе или теге. |
AUTHOR |
Используется для экземпляров AuthorTree, представляющих тег @author. |
CODE |
Используется для экземпляров LiteralTree, представляющих тег @code. |
COMMENT |
Используется для экземпляров CommentTree, представляющих HTML-комментарий. |
DEPRECATED |
Используется для экземпляров DeprecatedTree, представляющих тег @deprecated. |
DOC_COMMENT |
Используется для экземпляров DocCommentTree, представляющих полный комментарий документации. |
DOC_ROOT |
Используется для экземпляров DocRootTree, представляющих тег @docRoot. |
DOC_TYPE |
Используется для экземпляров DocTypeTree, представляющих объявление HTML DocType. |
END_ELEMENT |
Используется для экземпляров EndElementTree, представляющих окончание HTML-элемента. |
ENTITY |
Используется для экземпляров EntityTree, представляющих HTML-сущность. |
ERRONEOUS |
Используется для экземпляров ErroneousTree, представляющих некорректный текст. |
ESCAPE |
Используется для экземпляров EscapeTree, представляющих некоторый экранированный текст документации. |
EXCEPTION |
Используется для экземпляров ThrowsTree, представляющих тег @exception. |
HIDDEN |
Используется для экземпляров HiddenTree, представляющих тег @hidden. |
IDENTIFIER |
Используется для экземпляров IdentifierTree, представляющих идентификатор. |
INDEX |
Используется для экземпляров IndexTree, представляющих тег @index. |
INHERIT_DOC |
Используется для экземпляров InheritDocTree, представляющих тег @inheritDoc. |
LINK |
Используется для экземпляров LinkTree, представляющих тег @link. |
LINK_PLAIN |
Используется для экземпляров LinkTree, представляющих тег @linkplain. |
LITERAL |
Используется для экземпляров LiteralTree, представляющих тег @literal. |
OTHER |
Резервируемый реализацией узел. |
PARAM |
Используется для экземпляров ParamTree, представляющих тег @param. |
PROVIDES |
Используется для экземпляров ProvidesTree, представляющих тег @provides. |
REFERENCE |
Используется для экземпляров ReferenceTree, представляющих ссылку на элемент в языке программирования Java. |
RETURN |
Используется для экземпляров ReturnTree, представляющих тег @return. |
SEE |
Используется для экземпляров SeeTree, представляющих тег @see. |
SERIAL |
Используется для экземпляров SerialTree, представляющих тег @serial. |
SERIAL_DATA |
Используется для экземпляров SerialDataTree, представляющих тег @serialData. |
SERIAL_FIELD |
Используется для экземпляров SerialFieldTree, представляющих тег @serialField. |
SINCE |
Используется для экземпляров SinceTree, представляющих тег @since. |
SNIPPET |
Используется для экземпляров SnippetTree, представляющих тег @snippet. |
SPEC |
Используется для экземпляров SpecTree, представляющих тег @spec. |
START_ELEMENT |
Используется для экземпляров StartElementTree, представляющих начало HTML-элемента. |
SUMMARY |
Используется для экземпляров SummaryTree, представляющих тег @summary. |
SYSTEM_PROPERTY |
Используется для экземпляров SystemPropertyTree, представляющих тег @systemProperty. |
TEXT |
Используется для экземпляров TextTree, представляющих некоторый простой текст документации. |
THROWS |
Используется для экземпляров ThrowsTree, представляющих тег @throws. |
UNKNOWN_BLOCK_TAG |
Используется для экземпляров UnknownBlockTagTree, представляющих неизвестный блочный тег. |
UNKNOWN_INLINE_TAG |
Используется для экземпляров UnknownInlineTagTree, представляющих неизвестный инлайновый тег. |
USES |
Используется для экземпляров UsesTree, представляющих тег @uses. |
VALUE |
Используется для экземпляров ValueTree, представляющих тег @value. |
VERSION |
Используется для экземпляров VersionTree, представляющих тег @version. |
Краткое описание полей
| Модификатор и тип | Поле | Описание |
|---|---|---|
final String |
tagName |
Имя тега, если он есть, связанное с этим типом узла. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
static DocTree.Kind |
valueOf |
Возвращает константу перечисления этого класса с указанным именем. |
static DocTree.Kind[] |
values() |
Возвращает массив, содержащий константы этого перечисления в порядке их объявления. |
Подробное описание констант перечисления
ATTRIBUTE
public static final DocTree.Kind ATTRIBUTE
Используется для экземпляров
AttributeTree, представляющих атрибут в HTML-элементе или теге.AUTHOR
public static final DocTree.Kind AUTHOR
Используется для экземпляров
AuthorTree, представляющих тег @authorCODE
public static final DocTree.Kind CODE
Используется для экземпляров
LiteralTree, представляющих тег @codeCOMMENT
public static final DocTree.Kind COMMENT
Используется для экземпляров
CommentTree, представляющих HTML-комментарий.DEPRECATED
public static final DocTree.Kind DEPRECATED
Используется для экземпляров
DeprecatedTree, представляющих тег @deprecatedDOC_COMMENT
public static final DocTree.Kind DOC_COMMENT
Используется для экземпляров
DocCommentTree, представляющих полный комментарий к документации.DOC_ROOT
public static final DocTree.Kind DOC_ROOT
Используется для экземпляров
DocRootTree, представляющих тег @docRootDOC_TYPE
public static final DocTree.Kind DOC_TYPE
Используется для экземпляров
DocTypeTree, представляющих объявление типа документации HTML.- С:
- 10
END_ELEMENT
public static final DocTree.Kind END_ELEMENT
Используется для экземпляров
EndElementTree, представляющих конец HTML-элемента.ENTITY
public static final DocTree.Kind ENTITY
Используется для экземпляров
EntityTree, представляющих HTML-сущность.ERRONEOUS
public static final DocTree.Kind ERRONEOUS
Используется для экземпляров
ErroneousTree, представляющих какой-либо недопустимый текст.ESCAPE
public static final DocTree.Kind ESCAPE
Используется для экземпляров
EscapeTree, представляющих некоторый экранированный текст документации.- С:
- 21
EXCEPTION
public static final DocTree.Kind EXCEPTION
Используется для экземпляров
ThrowsTree, представляющих тег @exceptionHIDDEN
public static final DocTree.Kind HIDDEN
Используется для экземпляров
HiddenTree, представляющих тег @hiddenIDENTIFIER
public static final DocTree.Kind IDENTIFIER
Используется для экземпляров
IdentifierTree, представляющих идентификатор.INDEX
public static final DocTree.Kind INDEX
Используется для экземпляров
IndexTree, представляющих тег @index- С:
- 9
INHERIT_DOC
public static final DocTree.Kind INHERIT_DOC
Используется для экземпляров
InheritDocTree, представляющих тег @inheritDocССЫЛКА
public static final DocTree.Kind LINK
Используется для экземпляров
LinkTree, представляющих тег @linkССЫЛКА_ПРОСТАЯ
public static final DocTree.Kind LINK_PLAIN
Используется для экземпляров
LinkTree, представляющих тег @linkplainЛИТЕРАЛ
public static final DocTree.Kind LITERAL
Используется для экземпляров
LiteralTree, представляющих тег @literalPARAM
public static final DocTree.Kind PARAM
Используется для экземпляров
ParamTree, представляющих тег @paramPROVIDES
public static final DocTree.Kind PROVIDES
Используется для экземпляров
ProvidesTree, представляющих тег @provides- С:
- 9
ССЫЛКА
public static final DocTree.Kind REFERENCE
Используется для экземпляров
ReferenceTree, представляющих ссылку на элемент языка программирования Java.RETURN
public static final DocTree.Kind RETURN
Используется для экземпляров
ReturnTree, представляющих тег @returnСМ
public static final DocTree.Kind SEE
Используется для экземпляров
SeeTree, представляющих тег @seeSERIAL
public static final DocTree.Kind SERIAL
Используется для экземпляров
SerialTree, представляющих тег @serialSERIAL_DATA
public static final DocTree.Kind SERIAL_DATA
Используется для экземпляров
SerialDataTree, представляющих тег @serialDataSERIAL_FIELD
public static final DocTree.Kind SERIAL_FIELD
Используется для экземпляров
SerialFieldTree, представляющих тег @serialFieldSINCE
public static final DocTree.Kind SINCE
Используется для экземпляров
SinceTree, представляющих тег @sinceФРАГМЕНТ
public static final DocTree.Kind SNIPPET
Используется для экземпляров
SnippetTree, представляющих тег @snippet- С:
- 18
SPEC
public static final DocTree.Kind SPEC
Используется для экземпляров
SpecTree, представляющих тег @spec- С:
- 20
START_ELEMENT
public static final DocTree.Kind START_ELEMENT
Используется для экземпляров
StartElementTree, представляющих начало HTML-элемента.СВОЙСТВО_СИСТЕМЫ
public static final DocTree.Kind SYSTEM_PROPERTY
Используется для экземпляров
SystemPropertyTree, представляющих тег @systemProperty- С:
- 12
РЕЗЮМЕ
public static final DocTree.Kind SUMMARY
Используется для экземпляров
SummaryTree, представляющих тег @summary- С:
- 10
ТЕКСТ
public static final DocTree.Kind TEXT
Используется для экземпляров
TextTree, представляющих некоторый простой текст документации.THROWS
public static final DocTree.Kind THROWS
Используется для экземпляров
ThrowsTree, представляющих тег @throwsНЕИЗВЕСТНЫЙ_БЛОЧНЫЙ_ТЕГ
public static final DocTree.Kind UNKNOWN_BLOCK_TAG
Используется для экземпляров
UnknownBlockTagTree, представляющих неизвестный блочный тег.НЕИЗВЕСТНЫЙ_ВСТРОЕННЫЙ_ТЕГ
public static final DocTree.Kind UNKNOWN_INLINE_TAG
Используется для экземпляров
UnknownInlineTagTree, представляющих неизвестный встроенный тег.ИСПОЛЬЗУЕТ
public static final DocTree.Kind USES
Используется для экземпляров
UsesTree, представляющих тег @uses- С:
- 9
VALUE
public static final DocTree.Kind VALUE
Используется для экземпляров
ValueTree, представляющих тег @valueVERSION
public static final DocTree.Kind VERSION
Используется для экземпляров
VersionTree, представляющих тег @version.OTHER
public static final DocTree.Kind OTHER
Узел, зарезервированный для реализации. Это не тот узел, который вы ищете.
Подробное описание полей
tagName
public final String tagName
Имя тега, если таковое имеется, связанное с этим типом узла.
Подробное описание методов
values
public static DocTree.Kind[] values()
Возвращает массив, содержащий константы этого перечисления в порядке их объявления.
- Возвращает:
- массив, содержащий константы этого перечисления в порядке их объявления
valueOf
public static DocTree.Kind valueOf(String name)
Возвращает константу перечисления этого класса с указанным именем. Строка должна точно соответствовать идентификатору, используемому для объявления константы перечисления в этом классе. (Дополнительные пробелы не допускаются.)
- Параметры:
-
name- имя возвращаемой константы перечисления. - Возвращает:
- константу перечисления с указанным именем
- Исключения:
-
IllegalArgumentException- если в этом классе перечисления нет константы с указанным именем -
NullPointerException- если аргумент равен null
© 1993, 2023, 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/21/docs/api/jdk.compiler/com/sun/source/doctree/DocTree.Kind.html