Spec-Zone.ru › OpenJDK 17

Перечисление DocTree.Kind

java.lang.Object
java.lang.Enum<DocTree.Kind>
com.sun.source.doctree.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.
END_ELEMENT
Используется для экземпляров EndElementTree, представляющих конец HTML-элемента.
ENTITY
Используется для экземпляров EntityTree, представляющих HTML-сущность.
ERRONEOUS
Используется для экземпляров ErroneousTree, представляющих недействительный текст.
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.
START_ELEMENT
Используется для экземпляров EndElementTree, представляющих начало 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(String name)
Возвращает константу перечисления этого класса с указанным именем.
static DocTree.Kind[] values()
Возвращает массив, содержащий константы этого класса перечисления в порядке их объявления.

Методы, объявленные в классе java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Методы, объявленные в классе java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Подробности констант перечисления

ATTRIBUTE

public static final DocTree.Kind ATTRIBUTE
Используется для экземпляров AttributeTree , представляющих атрибут HTML.

AUTHOR

public static final DocTree.Kind AUTHOR
Используется для экземпляров AuthorTree , представляющих тег @author

CODE

public static final DocTree.Kind CODE
Используется для экземпляров LiteralTree , представляющих тег @code

COMMENT

public static final DocTree.Kind COMMENT
Используется для экземпляров CommentTree , представляющих HTML-комментарий.

DEPRECATED

public static final DocTree.Kind DEPRECATED
Используется для экземпляров DeprecatedTree , представляющих тег @deprecated

DOC_COMMENT

public static final DocTree.Kind DOC_COMMENT
Используется для экземпляров DocCommentTree , представляющих полный комментарий документации.

DOC_ROOT

public static final DocTree.Kind DOC_ROOT
Используется для экземпляров DocRootTree , представляющих тег @docRoot

DOC_TYPE

public static final DocTree.Kind DOC_TYPE
Используется для экземпляров DocTypeTree , представляющих объявление типа документа HTML.

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 , представляющих недопустимый текст.

EXCEPTION

public static final DocTree.Kind EXCEPTION
Используется для экземпляров ThrowsTree , представляющих тег @exception

HIDDEN

public static final DocTree.Kind HIDDEN
Используется для экземпляров HiddenTree , представляющих тег @hidden

IDENTIFIER

public static final DocTree.Kind IDENTIFIER
Используется для экземпляров IdentifierTree , представляющих идентификатор.

INDEX

public static final DocTree.Kind INDEX
Используется для экземпляров IndexTree , представляющих тег @index

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 , представляющих тег @literal

PARAM

public static final DocTree.Kind PARAM
Используется для экземпляров ParamTree , представляющих тег @param

PROVIDES

public static final DocTree.Kind PROVIDES
Используется для экземпляров ProvidesTree , представляющих тег @provides

ССЫЛКА

public static final DocTree.Kind REFERENCE
Используется для экземпляров ReferenceTree , представляющих ссылку на элемент в языке программирования Java.

RETURN

public static final DocTree.Kind RETURN
Используется для экземпляров ReturnTree , представляющих тег @return

SEE

public static final DocTree.Kind SEE
Используется для экземпляров SeeTree , представляющих тег @see

SERIAL

public static final DocTree.Kind SERIAL
Используется для экземпляров SerialTree , представляющих тег @serial

SERIAL_DATA

public static final DocTree.Kind SERIAL_DATA
Используется для экземпляров SerialDataTree , представляющих тег @serialData

SERIAL_FIELD

public static final DocTree.Kind SERIAL_FIELD
Используется для экземпляров SerialFieldTree , представляющих тег @serialField

SINCE

public static final DocTree.Kind SINCE
Используется для экземпляров SinceTree , представляющих тег @since

START_ELEMENT

public static final DocTree.Kind START_ELEMENT
Используется для экземпляров EndElementTree , представляющих начало HTML-элемента.

СВОЙСТВО_СИСТЕМЫ

public static final DocTree.Kind SYSTEM_PROPERTY
Используется для экземпляров SystemPropertyTree , представляющих тег @systemProperty

РЕЗЮМЕ

public static final DocTree.Kind SUMMARY
Используется для экземпляров SummaryTree , представляющих тег @summary

ТЕКСТ

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 , представляющих неизвестный внешний тег.

USES

public static final DocTree.Kind USES
Используется для экземпляров UsesTree , представляющих тег @uses

VALUE

public static final DocTree.Kind VALUE
Используется для экземпляров ValueTree , представляющих тег @value

VERSION

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, 2021, 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/17/docs/api/jdk.compiler/com/sun/source/doctree/DocTree.Kind.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API