Интерфейс Doclet.Option
- Вложенный интерфейс:
- Doclet
public static interface Doclet.Option
Инкапсуляция имени опции, псевдонимов, параметров и описаний, используемых Doclet.
Краткое описание вложенных классов
| Модификатор и тип | Интерфейс | Описание |
|---|---|---|
static enum |
Doclet.Option.Kind |
Тип опции. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
int |
getArgumentCount() |
Возвращает количество аргументов, потребляемых этой опцией. |
String |
getDescription() |
Возвращает описание опции. |
Doclet.Option.Kind |
getKind() |
Возвращает тип опции. |
List<String> |
getNames() |
Возвращает список имён, которые могут быть использованы для идентификации опции. |
String |
getParameters() |
Возвращает параметры опции. |
boolean |
process |
Обрабатывает опцию и аргументы по необходимости. |
Подробное описание методов
getArgumentCount
int getArgumentCount()
Возвращает количество аргументов, потребляемых этой опцией.
- Возвращает:
- количество потреблённых аргументов
getDescription
String getDescription()
Возвращает описание опции. Например, для опции "group" будет возвращена сводка, такая как "группирует документы".
- Возвращает:
- описание, если задано, иначе пустая строка
getKind
Doclet.Option.Kind getKind()
Возвращает тип опции.
- Возвращает:
- тип этой опции
getNames
List<String> getNames()
Возвращает список имён, которые могут быть использованы для идентификации опции. Например, список может содержать
["-classpath", "--class-path"] для опции "-classpath", с псевдонимом "--class-path".- Возвращает:
- имена опции
getParameters
String getParameters()
Возвращает параметры опции. Например, "name <p1>:<p2>.."
- Возвращает:
- параметры, если заданы, иначе пустая строка
process
boolean process(String option, List<String> arguments)
Обрабатывает опцию и аргументы по необходимости. Этот метод будет вызван, если имя заданной опции соответствует опции.
- Параметры:
-
option- опция -
arguments- список, содержащий аргументы - Возвращает:
- true, если операция прошла успешно, иначе false
© 1993, 2021, 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/17/docs/api/jdk.javadoc/jdk/javadoc/doclet/Doclet.Option.html
