Enum DocTree.Kind
- java.lang.Object
-
- java.lang.Enum<DocTree.Kind>
-
- com.sun.source.doctree.DocTree.Kind
- All Implemented Interfaces:
-
Serializable,Comparable<DocTree.Kind>
- Enclosing interface:
- DocTree
public static enum DocTree.Kind extends Enum<DocTree.Kind>
Перечисляет все типы деревьев.
Константы перечисления
| Константа перечисления | Описание |
|---|---|
ATTRIBUTE | Используется для экземпляров |
AUTHOR | Используется для экземпляров |
CODE | Используется для экземпляров |
COMMENT | Используется для экземпляров |
DEPRECATED | Используется для экземпляров |
DOC_COMMENT | Используется для экземпляров |
DOC_ROOT | Используется для экземпляров |
DOC_TYPE | Используется для экземпляров |
END_ELEMENT | Используется для экземпляров |
ENTITY | Используется для экземпляров |
ERRONEOUS | Используется для экземпляров |
EXCEPTION | Используется для экземпляров |
HIDDEN | Используется для экземпляров |
IDENTIFIER | Используется для экземпляров |
INDEX | Используется для экземпляров |
INHERIT_DOC | Используется для экземпляров |
LINK | Используется для экземпляров |
LINK_PLAIN | Используется для экземпляров |
LITERAL | Используется для экземпляров |
OTHER | Узел, зарезервированный для реализации. |
PARAM | Используется для экземпляров |
PROVIDES | Используется для экземпляров |
REFERENCE | Используется для экземпляров |
RETURN | Используется для экземпляров |
SEE | Используется для экземпляров |
SERIAL | Используется для экземпляров |
SERIAL_DATA | Используется для экземпляров |
SERIAL_FIELD | Используется для экземпляров |
SINCE | Используется для экземпляров |
START_ELEMENT | Используется для экземпляров |
SUMMARY | Используется для экземпляров |
TEXT | Используется для экземпляров |
THROWS | Используется для экземпляров |
UNKNOWN_BLOCK_TAG | Используется для экземпляров |
UNKNOWN_INLINE_TAG | Используется для экземпляров |
USES | Используется для экземпляров |
VALUE | Используется для экземпляров |
VERSION | Используется для экземпляров |
Поля
| Модификатор и тип | Поле | Описание |
|---|---|---|
String | tagName | Имя тега, если таковой имеется, связанное с этим типом узла. |
Методы
| Модификатор и тип | Метод | Описание |
|---|---|---|
static DocTree.Kind | valueOf(String name) | Возвращает константу перечисления этого типа с указанным именем. |
static DocTree.Kind[] | values() | Возвращает массив, содержащий константы этого типа перечисления в порядке их объявления. |
Методы, унаследованные от класса java.lang.Enum
clone, compareTo, 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.
АВТОР
public static final DocTree.Kind AUTHOR
Используется для экземпляров AuthorTree, представляющих тег @author.
КОД
public static final DocTree.Kind CODE
Используется для экземпляров LiteralTree, представляющих тег @code.
КОММЕНТАРИЙ
public static final DocTree.Kind COMMENT
Используется для экземпляров CommentTree, представляющих комментарий HTML.
УСТАРЕВШИЙ
public static final DocTree.Kind DEPRECATED
Используется для экземпляров DeprecatedTree, представляющих тег @deprecated.
КОММЕНТАРИЙ_ДОКУМЕНТАЦИИ
public static final DocTree.Kind DOC_COMMENT
Используется для экземпляров DocCommentTree, представляющих полный комментарий документации.
КОРЕНЬ_ДОКУМЕНТАЦИИ
public static final DocTree.Kind DOC_ROOT
Используется для экземпляров DocRootTree, представляющих тег @docRoot.
ТИП_ДОКУМЕНТА
public static final DocTree.Kind DOC_TYPE
Используется для экземпляров DocTypeTree, представляющих объявление типа документа HTML.
КОНЕЦ_ЭЛЕМЕНТА
public static final DocTree.Kind END_ELEMENT
Используется для экземпляров EndElementTree, представляющих конец HTML-элемента.
СУЩНОСТЬ
public static final DocTree.Kind ENTITY
Используется для экземпляров EntityTree, представляющих сущность HTML.
ОШИБОЧНЫЙ
public static final DocTree.Kind ERRONEOUS
Используется для экземпляров ErroneousTree, представляющих некорректный текст.
ИСКЛЮЧЕНИЕ
public static final DocTree.Kind EXCEPTION
Используется для экземпляров ThrowsTree, представляющих тег @exception.
СКРЫТЫЙ
public static final DocTree.Kind HIDDEN
Используется для экземпляров HiddenTree, представляющих тег @hidden.
ИДЕНТИФИКАТОР
public static final DocTree.Kind IDENTIFIER
Используется для экземпляров IdentifierTree, представляющих идентификатор.
ИНДЕКС
public static final DocTree.Kind INDEX
Используется для экземпляров IndexTree, представляющих поисковый термин.
НАСЛЕДОВАТЬ_ДОКУМЕНТАЦИЮ
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.
ПАРАМЕТР
public static final DocTree.Kind PARAM
Используется для экземпляров ParamTree, представляющих тег @param.
ПРЕДОСТАВЛЯЕТ
public static final DocTree.Kind PROVIDES
Используется для экземпляров ProvidesTree, представляющих тег @provides.
ССЫЛКА
public static final DocTree.Kind REFERENCE
Используется для экземпляров ReferenceTree, представляющих ссылку на элемент языка программирования Java.
ВОЗВРАЩАЕТ
public static final DocTree.Kind RETURN
Используется для экземпляров ReturnTree, представляющих тег @return.
СМОТРИТЕ
public static final DocTree.Kind SEE
Используется для экземпляров SeeTree, представляющих тег @see.
ПОСЛЕДОВАТЕЛЬНОСТЬ
public static final DocTree.Kind SERIAL
Используется для экземпляров SerialTree, представляющих тег @serial.
ДАННЫЕ_ПОСЛЕДОВАТЕЛЬНОСТИ
public static final DocTree.Kind SERIAL_DATA
Используется для экземпляров SerialDataTree, представляющих тег @serialData.
ПОЛЕ_ПОСЛЕДОВАТЕЛЬНОСТИ
public static final DocTree.Kind SERIAL_FIELD
Используется для экземпляров SerialFieldTree, представляющих тег @serialField.
С_МОМЕНТА
public static final DocTree.Kind SINCE
Используется для экземпляров SinceTree, представляющих тег @since.
НАЧАЛО_ЭЛЕМЕНТА
public static final DocTree.Kind START_ELEMENT
Используется для экземпляров EndElementTree, представляющих начало HTML-элемента.
РЕЗЮМЕ
public static final DocTree.Kind SUMMARY
Используется для экземпляров SummaryTree, представляющих резюме описания комментария.
ТЕКСТ
public static final DocTree.Kind TEXT
Используется для экземпляров TextTree, представляющих текст документации.
БРОСАЕТ
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.
ЗНАЧЕНИЕ
public static final DocTree.Kind VALUE
Используется для экземпляров ValueTree, представляющих тег @value.
ВЕРСИЯ
public static final DocTree.Kind VERSION
Используется для экземпляров VersionTree, представляющих тег @version.
ДРУГОЕ
public static final DocTree.Kind OTHER
Резервируемый узел реализации. Это не тот узел, который вам нужен.
Поля
tagName
public final String tagName
Имя тега, если таковой имеется, связанное с этим типом узла.
Методы
values
public static DocTree.Kind[] values()
Возвращает массив, содержащий константы этого типа перечисления в порядке их объявления. Этот метод можно использовать для итерации по константам следующим образом:
for (DocTree.Kind c : DocTree.Kind.values()) System.out.println(c);
- Возвращает:
- массив, содержащий константы этого типа перечисления в порядке их объявления
valueOf
public static DocTree.Kind valueOf(String name)
Возвращает константу перечисления этого типа с заданным именем. Строка должна точно соответствовать идентификатору, используемому для объявления константы перечисления в этом типе. (Дополнительные пробелы не допускаются.)
- Параметры:
-
name- имя константы перечисления, которую нужно вернуть. - Возвращает:
- константа перечисления с заданным именем
- Исключения:
-
IllegalArgumentException- если в этом типе перечисления нет константы с заданным именем -
NullPointerException- если аргумент равен null
© 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.compiler/com/sun/source/doctree/DocTree.Kind.html