クラス 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
      • getNames

        public List<String> getNames()
        オプションを識別するために使用される可能性のある名前のリストを返します。
        定義:
        getNames インタフェース内 Doclet.Option
        戻り値:
        オプションの名前リスト
      • getParameters

        public String getParameters()
        オプションのパラメータを返します。
        定義:
        getParameters インタフェース内 Doclet.Option
        戻り値:
        設定されている場合はパラメータ、それ以外の場合は空のString