Интерфейс Doclet.Option
- Вмещающий интерфейс:
Doclet
public static interface Doclet.Option
Инкапсуляция имени параметра, псевдонимов, параметров и описаний, используемых Doclet.
- Начиная с:
- 9
Краткое описание вложенных классов
| Модификатор и тип | Интерфейс | Описание |
|---|---|---|
static enum |
Doclet.Option.Kind |
Тип параметра. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
int |
getArgumentCount() |
Возвращает количество аргументов, которые будет обрабатывать этот параметр. |
String |
getDescription() |
Возвращает описание параметра. |
Doclet.Option.Kind |
getKind() |
Возвращает тип параметра. |
List |
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, 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.
https://docs.oracle.com/en/java/javase/25/docs/api/jdk.javadoc/jdk/javadoc/doclet/Doclet.Option.html
