Документация перечисления DocumentationTool.Location
- java.lang.Object
-
- java.lang.Enum<DocumentationTool.Location>
-
- javax.tools.DocumentationTool.Location
- Все реализованные интерфейсы:
- Serializable, Comparable<DocumentationTool.Location>, JavaFileManager.Location
- Вложенный интерфейс:
- DocumentationTool
public static enum DocumentationTool.Location extends Enum<DocumentationTool.Location> implements JavaFileManager.Location
Локации, специфичные для DocumentationTool.
- См. также:
StandardLocation
Постоянные значения перечисления
| Постоянное значение перечисления и описание |
|---|
DOCLET_PATH Местоположение для поиска doclets. |
DOCUMENTATION_OUTPUT Местоположение новых файлов документации. |
TAGLET_PATH Местоположение для поиска taglets. |
Методы
| Модификатор и тип | Метод и описание |
|---|---|
String |
getName() Возвращает имя этой локации. |
boolean |
isOutputLocation() Определяет, является ли это местоположение местоположением вывода. |
static DocumentationTool.Location |
valueOf(String name) Возвращает константу перечисления этого типа с заданным именем. |
static DocumentationTool.Location[] |
values() Возвращает массив, содержащий константы этого типа перечисления в порядке их объявления. |
Методы, унаследованные от класса java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf Методы, унаследованные от класса java.lang.Object
getClass, notify, notifyAll, wait, wait, wait Постоянные значения перечисления
DOCUMENTATION_OUTPUT
public static final DocumentationTool.Location DOCUMENTATION_OUTPUT
Местоположение новых файлов документации.
DOCLET_PATH
public static final DocumentationTool.Location DOCLET_PATH
Местоположение для поиска doclets.
TAGLET_PATH
public static final DocumentationTool.Location TAGLET_PATH
Местоположение для поиска taglets.
Методы
values
public static DocumentationTool.Location[] values()
Возвращает массив, содержащий константы этого типа перечисления в порядке их объявления. Этот метод можно использовать для перебора констант следующим образом:
for (DocumentationTool.Location c : DocumentationTool.Location.values()) System.out.println(c);
- Возвращает:
- массив, содержащий константы этого типа перечисления в порядке их объявления
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, 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.