パッケージ org.opengion.fukurou.taglet

クラス AbstractDocTree.AbstractOption

java.lang.Object
org.opengion.fukurou.taglet.AbstractDocTree.AbstractOption
すべての実装されたインタフェース:
Doclet.Option
含まれているクラス:
AbstractDocTree
protected abstract static class AbstractDocTree.AbstractOption extends Object implements Doclet.Option
Doclet.Option を継承し、共通ﾒｿｯﾄﾞを実装したabstractｸﾗｽ 単純に、ﾒｿｯﾄﾞのOverrideで共通化しているだけです。

  • コンストラクタの詳細

    • 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