Класс перечисления DocletEnvironment.ModuleMode

java.lang.Object

java.lang.Enum<DocletEnvironment.ModuleMode>

jdk.javadoc.doclet.DocletEnvironment.ModuleMode

Все реализуемые интерфейсы:: Serializable, Comparable<DocletEnvironment.ModuleMode>, Constable

Охватывающий интерфейс:: DocletEnvironment

public static enum DocletEnvironment.ModuleMode extends Enum<DocletEnvironment.ModuleMode>

Режим, определяющий уровень подробности документации модуля.

С версии:: 9

Краткое описание вложенных классов

Вложенные классы и интерфейсы, объявленные в классе Enum

Enum.EnumDesc<E>

Модификатор и тип	Класс	Описание
`static final class`	`Enum.EnumDesc<E extends Enum<E>>`	Номинальный дескриптор константы `enum`.

Краткое описание констант перечисления

Константа перечисления	Описание
`ALL`	Указывает, что требуется подробная документация
`API`	Указывает, что требуется документация на уровне API

Краткое описание методов

Модификатор и тип	Метод	Описание
`static DocletEnvironment.ModuleMode`	`valueOf(String name)`	Возвращает константу перечисления этого класса с указанным именем.
`static DocletEnvironment.ModuleMode[]`	`values()`	Возвращает массив, содержащий константы этого класса перечисления в порядке их объявления.

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

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

Модификатор и тип	Метод	Описание
`protected final Object`	`clone()`	Выбрасывает CloneNotSupportedException.
`final int`	`compareTo(DocletEnvironment.ModuleMode o)`	Сравнивает это перечисление с указанным объектом, определяя порядок.
`final Optional<Enum.EnumDesc<DocletEnvironment.ModuleMode>>`	`describeConstable()`	Возвращает дескриптор перечисления `EnumDesc` для этого экземпляра, если его можно создать, или пустой `Optional`, если создать его нельзя.
`final boolean`	`equals(Object other)`	Возвращает true, если указанный объект равен этой константе перечисления.
`protected final void`	`finalize()`	Устарело, подлежит удалению: этот элемент API может быть удалён в будущей версии. Финализация признана устаревшей и подлежит удалению.
`final Class<DocletEnvironment.ModuleMode>`	`getDeclaringClass()`	Возвращает объект Class, соответствующий типу перечисления этой константы перечисления.
`final int`	`hashCode()`	Возвращает хеш-код этой константы перечисления.
`final String`	`name()`	Возвращает имя этой константы перечисления точно в том виде, в каком оно указано в объявлении перечисления.
`final int`	`ordinal()`	Возвращает порядковый номер этой константы перечисления (её позицию в объявлении перечисления, где начальной константе присваивается порядковый номер 0).
`String`	`toString()`	Возвращает имя этой константы перечисления, указанное в объявлении.
`static <T extends Enum<T>> T`	`valueOf(Class<T> enumClass, String name)`	Возвращает константу указанного класса перечисления с заданным именем.

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

getClass, notify, notifyAll, wait, wait, wait

Модификатор и тип	Метод	Описание
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать до тех пор, пока он не будет пробуждён, обычно посредством уведомления или прерывания.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать до тех пор, пока он не будет пробуждён, обычно посредством уведомления или прерывания, либо пока не истечёт определённое время.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать до тех пор, пока он не будет пробуждён, обычно посредством уведомления или прерывания, либо пока не истечёт определённое время.

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

API

public static final DocletEnvironment.ModuleMode API

Указывает, что требуется документация на уровне API

ALL

public static final DocletEnvironment.ModuleMode ALL

Указывает, что требуется подробная документация

Подробное описание методов

values

public static DocletEnvironment.ModuleMode[] values()

Возвращает массив, содержащий константы этого класса перечисления в порядке их объявления.

Возвращает:: массив, содержащий константы этого класса перечисления в порядке их объявления

valueOf

public static DocletEnvironment.ModuleMode 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.