モジュール jdk.javadoc

パッケージ jdk.javadoc.doclet

インタフェースDoclet.Option

含まれているインタフェース:

Doclet

public static interface Doclet.Option

ドックレットで使用されるオプション名、別名、パラメータおよび説明のカプセル化。

ネストされたクラスのサマリー

ネストされたクラス

修飾子と型	インタフェース	説明
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"のリストは、別名"--class-path"を持つ["-classpath", "--class-path"]です。

戻り値:

オプションの名前

getParameters

String getParameters()

オプションのパラメータを返します。 例:"名前 <p1>:<p2>.."

戻り値:

設定されている場合はパラメータ、それ以外の場合は空の文字列

process

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

必要に応じてオプションおよび引数を処理します。 このメソッドは、指定されたオプション名がオプションと一致する場合に呼び出されます。

パラメータ:

option - オプション

arguments - 引数をカプセル化したリスト

戻り値:

操作が成功した場合はtrue、それ以外の場合はfalse