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

## クラス AbstractDocTree

- java.lang.Object
- - org.opengion.fukurou.taglet2.AbstractDocTree

- すべての実装されたインタフェース:
    `Doclet`
  直系の既知のサブクラス:
    `DocTreeParam`, `DocTreePlugin`, `DocTreeSpecific`, `DocTreeTaglib`, `DocTreeVerCheck`

      public abstract class AbstractDocTree
      extends Object
      implements Doclet

  ソースコメントから、パラメータ情報を取り出す Doclet クラスです。 og.paramLevel タグと og.cryptography タグを切り出します。 これらは、ｼｽﾃﾑパラメータとしてGE12ﾃｰﾌﾞﾙに設定される値をクラスより抽出する のに使用します。
  バージョン
    7.3
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK11.0,

- - ### ネストされたクラスの概要

    ネストされたクラス
    修飾子とタイプ | クラス | 説明
    --- | --- | ---
    `protected static class` | `AbstractDocTree.AbstractOption` | Doclet.Option を継承し、共通メソッドを実装したabstractクラス 単純に、メソッドのOverrideで共通化しているだけです。

    - ### インタフェースから継承されたネストされたクラス/インタフェース jdk.javadoc.doclet.Doclet

      `Doclet.Option`

  - ### フィールドの概要

    フィールド
    修飾子とタイプ | フィールド | 説明
    --- | --- | ---
    `protected static List<DocTree>` | `EMPTY_LIST` | 空DocTreeﾘｽﾄ
    `static String` | `ENCODE` | ｴﾝｺｰﾄﾞ "UTF-8"
    `protected Reporter` | `reporter` | 情報の出力

  - ### コンストラクタの概要

    コンストラクタ
    コンストラクタ | 説明
    --- | ---
    `AbstractDocTree()` | デフォルトコンストラクター

  - ### メソッドの概要

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッド | 説明
    --- | --- | ---
    `protected Map<String,​List<String>>` | `blockTagsMap​(DocCommentTree docTree)` | BlockTagsのキーとリストのMapを作成して返します。
    `protected String` | `getBlockTag​(String key, Map<String,​List<String>> blcMap, String delimiter)` | blockTagsMapで作成されたMapｵﾌﾞｼﾞｪｸﾄから、文字列を作成します。
    `String` | `getName()` | ドックレットを識別する名前を返します。
    `SourceVersion` | `getSupportedSourceVersion()` | このドックレットでサポートされているJavaプログラミング言語のバージョンを返します。
    `void` | `init​(Locale locale, Reporter reporter)` | 指定されたロケールとエラー・レポータでこのドックレットを初期化します。

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

    - ### インタフェースから継承されたメソッド jdk.javadoc.doclet.Doclet

      `getSupportedOptions, run`

- - ### フィールドの詳細

    - #### ENCODE

          public static final String ENCODE

      ｴﾝｺｰﾄﾞ "UTF-8"
      関連項目:
        定数フィールド値

    - #### reporter

          protected Reporter reporter

      情報の出力

    - #### EMPTY_LIST

          protected static final List<DocTree> EMPTY_LIST

      空DocTreeﾘｽﾄ

  - ### コンストラクタの詳細

    - #### AbstractDocTree

          public AbstractDocTree()

      デフォルトコンストラクター
      変更履歴:
        7.3.0.0 (2021/01/06) PMD refactoring. Each class should declare at least one constructor.

  - ### メソッドの詳細

    - #### init

          public void init​(Locale locale,
                           Reporter reporter)

      指定されたロケールとエラー・レポータでこのドックレットを初期化します。
      定義:
        `init` インタフェース内 `Doclet`
      パラメータ:
        `locale` - 使用されるロケール
        `reporter` - 使用するレポータ
      変更履歴:
        7.3.0.0 (2021/01/06) 新しいJavaDoc対応

    - #### getName

          public String getName()

      ドックレットを識別する名前を返します。
      定義:
        `getName` インタフェース内 `Doclet`
      戻り値:
        名前

    - #### getSupportedSourceVersion

          public SourceVersion getSupportedSourceVersion()

      このドックレットでサポートされているJavaプログラミング言語のバージョンを返します。
      定義:
        `getSupportedSourceVersion` インタフェース内 `Doclet`
      戻り値:
        通常は最新バージョン

    - #### blockTagsMap

          protected Map<String,​List<String>> blockTagsMap​(DocCommentTree docTree)

      BlockTagsのキーとリストのMapを作成して返します。 キーと値を分離します。同じキーが複数存在しますので、それらは Listに入れて返します。 docTreeは、null の場合もあるので、その場合は、空のMapを返します。
      パラメータ:
        `docTree` - DocCommentTreeｵﾌﾞｼﾞｪｸﾄ
      戻り値:
        BlockTagsのキーとリストのMap

    - #### getBlockTag

          protected String getBlockTag​(String key,
                                       Map<String,​List<String>> blcMap,
                                       String delimiter)

      blockTagsMapで作成されたMapｵﾌﾞｼﾞｪｸﾄから、文字列を作成します。 キーがMapに存在しない場合は、空文字列を返します。 docTreeは、null の場合もあるので、その場合は、空のMapを返します。
      パラメータ:
        `key` - blockTagのキー
        `blcMap` - blockTagsMapで作成されたMapｵﾌﾞｼﾞｪｸﾄ
        `delimiter` - 複数タグを連結する場合の、区切り文字
      戻り値:
        指定のタグの文字列