Перечисление Elements.DocCommentKind
- Все реализуемые интерфейсы:
Serializable, Comparable<Elements.DocCommentKind>, Constable
- Обрамляющий интерфейс:
Elements
public static enum Elements.DocCommentKind extends Enum<Elements.DocCommentKind>
Тип комментария документации.
- Начиная с:
- 23
Краткое описание вложенных классов
Вложенные классы/интерфейсы, объявленные в классе Enum
Enum.EnumDesc<E> | Модификатор и тип | Класс | Описание |
|---|---|---|
static final class |
Enum.EnumDesc<E extends Enum<E>> |
Номинальный дескриптор константы enum. |
Краткое описание констант перечисления
| Константа перечисления | Описание |
|---|---|
END_OF_LINE |
Тип комментариев, строки которых начинаются с ///. |
TRADITIONAL |
Тип комментариев, начинающихся с /**. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
static Elements.DocCommentKind |
valueOf |
Возвращает константу перечисления этого класса с указанным именем. |
static Elements.DocCommentKind[] |
values() |
Возвращает массив, содержащий константы этого класса перечисления в порядке их объявления. |
Методы, объявленные в классе Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf | Модификатор и тип | Метод | Описание |
|---|---|---|
protected final Object |
clone() |
Выбрасывает CloneNotSupportedException. |
final int |
compareTo |
Сравнивает это перечисление с указанным объектом, определяя порядок. |
final Optional |
describeConstable() |
Если для этого экземпляра можно создать дескриптор перечисления EnumDesc, возвращает его; в противном случае возвращает пустой объект Optional. |
final boolean |
equals |
Возвращает true, если указанный объект равен этой константе перечисления. |
protected final void |
finalize() |
Устарело, будет удалено: этот элемент API может быть удалён в будущей версии. Финализация признана устаревшей и будет удалена. |
final Class |
getDeclaringClass() |
Возвращает объект Class, соответствующий типу этого перечисления. |
final int |
hashCode() |
Возвращает хеш-код этой константы перечисления. |
final String |
name() |
Возвращает имя этой константы перечисления в точности так, как оно объявлено в объявлении перечисления. |
final int |
ordinal() |
Возвращает порядковый номер этой константы перечисления (её позицию в объявлении перечисления, где первой константе присваивается номер 0). |
String |
toString() |
Возвращает имя этой константы перечисления, указанное в объявлении. |
static <T extends Enum<T>> |
valueOf |
Возвращает константу указанного класса перечисления с указанным именем. |
Методы, объявленные в классе Object
getClass, notify, notifyAll, wait, wait, wait | Модификатор и тип | Метод | Описание |
|---|---|---|
final Class |
getClass() |
Возвращает класс времени выполнения этого Object. |
final void |
notify() |
Пробуждает один поток, ожидающий на мониторе этого объекта. |
final void |
notifyAll() |
Пробуждает все потоки, ожидающие на мониторе этого объекта. |
final void |
wait() |
Заставляет текущий поток ждать, пока он не будет разбужен, обычно посредством уведомления или прерывания. |
final void |
wait |
Заставляет текущий поток ждать, пока он не будет разбужен, обычно посредством уведомления или прерывания, либо пока не истечёт заданное время. |
final void |
wait |
Заставляет текущий поток ждать, пока он не будет разбужен, обычно посредством уведомления или прерывания, либо пока не истечёт заданное время. |
Подробное описание констант перечисления
END_OF_LINE
public static final Elements.DocCommentKind END_OF_LINE
Тип комментариев, строки которых начинаются с
///.- Примечание к API:
- Стандартный doclet, используемый инструментом
javadoc, обрабатывает эти комментарии как содержащие Markdown и теги комментариев документации. - См. также:
TRADITIONAL
public static final Elements.DocCommentKind TRADITIONAL
Тип комментариев, начинающихся с
/**.- Примечание к API:
- Стандартный doclet, используемый инструментом
javadoc, обрабатывает эти комментарии как содержащие HTML и теги комментариев документации.
Подробное описание методов
values
public static Elements.DocCommentKind[] values()
Возвращает массив, содержащий константы этого класса перечисления в порядке их объявления.
- Возвращает:
- массив, содержащий константы этого класса перечисления в порядке их объявления
valueOf
public static Elements.DocCommentKind valueOf(String name)
Возвращает константу перечисления этого класса с указанным именем. Строка должна точно совпадать с идентификатором, использованным для объявления константы перечисления в этом классе. (Пробелы в начале и конце строки не допускаются.)
- Параметры:
-
name— имя возвращаемой константы перечисления. - Возвращает:
- константу перечисления с указанным именем
- Выбрасывает:
-
IllegalArgumentException— если в этом классе перечисления нет константы с указанным именем -
NullPointerException— если аргумент равен null
© 1993, 2025, 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.