- 含まれているインタフェース:
- Doclet
public static interface Doclet.Option
Docletが使用するオプション名、別名、パラメータ、および記述のカプセル化。
-
メソッドの詳細
-
getArgumentCount
int getArgumentCount()このオプションが消費する引数の数を返します。- 戻り値:
- 消費された引数の数
-
getDescription
String getDescription()オプションの説明を返します。 たとえば、オプション"group"は、"文書のグループ化"のようなオプションのシノプシスを返します。- 戻り値:
- 設定されている場合はdescription、そうでない場合は空のString
-
getKind
Doclet.Option.Kind getKind()オプションの種類を返します。- 戻り値:
- このオプションの種類
-
getNames
オプションを識別するために使用される可能性のある名前のリストを返します。 たとえば、オプション"-classpath"の["-classpath", "--class-path"]
、別名"--class-path"のリストなどがあります。- 戻り値:
- オプションの名前
-
getParameters
String getParameters()オプションのパラメータを返します。 たとえば"名前<p1>:<p2>.."- 戻り値:
- 設定されている場合はパラメータ、それ以外の場合は空のString
-
process
必要に応じてオプションと引数を処理します。 このメソッドは、指定されたオプション名がオプションに一致する場合に呼び出されます。- パラメータ:
option
- オプションarguments
- 引数をカプセル化したリスト- 戻り値:
- 操作が成功した場合はtrue、そうでない場合はfalse
-