Перечисление DocumentationTool.Location

java.lang.Object

java.lang.Enum<DocumentationTool.Location>

javax.tools.DocumentationTool.Location

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

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

public static enum DocumentationTool.Location extends Enum<DocumentationTool.Location> implements JavaFileManager.Location

Расположения, специфичные для DocumentationTool.

С:

1.8

См. также:

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

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

Enum.EnumDesc<E>

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

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

Константа перечисления	Описание
`DOCLET_PATH`	Расположение для поиска доклетов.
`DOCUMENTATION_OUTPUT`	Расположение новых файлов документации.
`SNIPPET_PATH`	Расположение для поиска фрагментов кода.
`TAGLET_PATH`	Расположение для поиска тэглетов.

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

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

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

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

Модификатор и тип	Метод	Описание
`protected final Object`	`clone()`	Выбрасывает CloneNotSupportedException.
`final int`	`compareTo(DocumentationTool.Location o)`	Сравнивает это перечисление с указанным объектом, определяя их порядок.
`final Optional<Enum.EnumDesc<DocumentationTool.Location>>`	`describeConstable()`	Возвращает дескриптор перечисления `EnumDesc` для этого экземпляра, если его можно создать, или пустой объект `Optional`, если создать его невозможно.
`final boolean`	`equals(Object other)`	Возвращает true, если указанный объект равен этой константе перечисления.
`protected final void`	`finalize()`	Устарело, планируется удаление: этот элемент API подлежит удалению в будущей версии. Метод финализации помечен как устаревший и подлежащий удалению.
`final Class<DocumentationTool.Location>`	`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()`	Заставляет текущий поток ждать пробуждения, обычно в результате вызова notify или получения прерывания.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ждать пробуждения, обычно в результате вызова notify или получения прерывания, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ждать пробуждения, обычно в результате вызова notify или получения прерывания, либо до истечения заданного промежутка реального времени.

Методы, объявленные в интерфейсе JavaFileManager.Location

isModuleOrientedLocation

Модификатор и тип	Метод	Описание
`default boolean`	`isModuleOrientedLocation()`	Указывает, является ли это расположение ориентированным на модули и, следовательно, предполагает ли оно наличие классов в иерархии модуль/пакет/класс, в отличие от расположения, ориентированного на пакеты, для которого предполагается иерархия пакет/класс.

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

DOCUMENTATION_OUTPUT

public static final DocumentationTool.Location DOCUMENTATION_OUTPUT

Расположение новых файлов документации.

DOCLET_PATH

public static final DocumentationTool.Location DOCLET_PATH

Расположение для поиска доклетов.

TAGLET_PATH

public static final DocumentationTool.Location TAGLET_PATH

Расположение для поиска тэглетов.

SNIPPET_PATH

public static final DocumentationTool.Location SNIPPET_PATH

Расположение для поиска фрагментов кода.

С:: 18

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

values

public static DocumentationTool.Location[] values()

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

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

valueOf

public static DocumentationTool.Location valueOf(String name)

Возвращает константу перечисления этого класса с указанным именем. Строка должна точно совпадать с идентификатором, использованным для объявления константы перечисления в этом классе. (Лишние пробельные символы не допускаются.)

Параметры:: name — имя возвращаемой константы перечисления.
Возвращает:: константа перечисления с указанным именем
Выбрасывает:: IllegalArgumentException — если в этом классе перечисления нет константы с указанным именем; NullPointerException — если аргумент равен null

getName

public String getName()

Описание скопировано из интерфейса: JavaFileManager.Location

Возвращает имя этого расположения.

Определено в:: getName в интерфейсе JavaFileManager.Location
Возвращает:: имя

isOutputLocation

public boolean isOutputLocation()

Описание скопировано из интерфейса: JavaFileManager.Location

Определяет, является ли это расположение выходным. Выходное расположение — это расположение, обычно используемое для вывода.

Определено в:: isOutputLocation в интерфейсе JavaFileManager.Location
Возвращает:: true, если это выходное расположение, иначе false

© 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.