Интерфейс Doclet.Option

Вложенный интерфейс:: Doclet

public static interface Doclet.Option

Оборачивает имя опции, псевдонимы, параметры и описания, используемые Doclet.

Вложенные классы

Модификатор и тип	Интерфейс	Описание
`static class`	`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", "--class-path"] для опции "-classpath", с псевдонимом "--class-path".

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

getParameters

String getParameters()

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

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

process

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

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

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