Интерфейс 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(String option, List<String> arguments)`	Обрабатывает опцию и аргументы по мере необходимости.

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

getArgumentCount

int getArgumentCount()

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

Возвращает:: количество потребляемых аргументов

getDescription

String getDescription()

Возвращает описание опции. Например, для опции "group" возвращается описание, такое как "группирует документы".

Возвращает:: описание, если задано, в противном случае пустая строка

getKind

Doclet.Option.Kind getKind()

Возвращает тип опции.

Возвращает:: тип этой опции

getNames

List<String> getNames()

Возвращает список имен, которые могут быть использованы для идентификации опции. Например, для опции "-classpath" список может содержать "-classpath" и "--class-path".

Возвращает:: имена опции

getParameters

String getParameters()

Возвращает параметры опции. Например, "имя <p1>:<p2>.."

Возвращает:: параметры, если заданы, в противном случае пустая строка

process

boolean process(String option, List<String> arguments)

Обрабатывает опцию и аргументы по мере необходимости. Этот метод вызывается, если заданное имя опции совпадает с опцией.

Параметры:: option - опция; arguments - список, инкапсулирующий аргументы
Возвращает:: true, если операция выполнена успешно, иначе false

© 1993, 2023, 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/21/docs/api/jdk.javadoc/jdk/javadoc/doclet/Doclet.Option.html