クラス AbstractDocTree.AbstractOption
- java.lang.Object
-
- org.opengion.fukurou.taglet2.AbstractDocTree.AbstractOption
-
- すべての実装されたインタフェース:
Doclet.Option
- 含まれているクラス:
- AbstractDocTree
protected abstract static class AbstractDocTree.AbstractOption extends Object implements Doclet.Option
Doclet.Option を継承し、共通メソッドを実装したabstractクラス 単純に、メソッドのOverrideで共通化しているだけです。
-
-
ネストされたクラスの概要
-
インタフェースから継承されたネストされたクラス/インタフェース jdk.javadoc.doclet.Doclet.Option
Doclet.Option.Kind
-
-
コンストラクタの概要
コンストラクタ コンストラクタ 説明 AbstractOption(String... prm)
コンストラクター。
-
メソッドの概要
すべてのメソッド インスタンス・メソッド concreteメソッド 修飾子とタイプ メソッド 説明 int
getArgumentCount()
このオプションが消費する引数の数を返します。String
getDescription()
オプションの説明を返します。Doclet.Option.Kind
getKind()
オプションの種類を返します。List<String>
getNames()
オプションを識別するために使用される可能性のある名前のリストを返します。String
getParameters()
オプションのパラメータを返します。-
クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
インタフェースから継承されたメソッド jdk.javadoc.doclet.Doclet.Option
process
-
-
-
-
コンストラクタの詳細
-
AbstractOption
AbstractOption(String... prm)
コンストラクター。- パラメータ:
prm
- 引数に対応するキーの可変引数
-
-
メソッドの詳細
-
getArgumentCount
public int getArgumentCount()
このオプションが消費する引数の数を返します。- 定義:
getArgumentCount
インタフェース内Doclet.Option
- 戻り値:
- 消費された引数の数
-
getDescription
public String getDescription()
オプションの説明を返します。- 定義:
getDescription
インタフェース内Doclet.Option
- 戻り値:
- 設定されている場合はdescription、そうでない場合は空のString
-
getKind
public Doclet.Option.Kind getKind()
オプションの種類を返します。- 定義:
getKind
インタフェース内Doclet.Option
- 戻り値:
- このオプションの種類
-
getNames
public List<String> getNames()
オプションを識別するために使用される可能性のある名前のリストを返します。- 定義:
getNames
インタフェース内Doclet.Option
- 戻り値:
- オプションの名前リスト
-
getParameters
public String getParameters()
オプションのパラメータを返します。- 定義:
getParameters
インタフェース内Doclet.Option
- 戻り値:
- 設定されている場合はパラメータ、それ以外の場合は空のString
-
-