クラス AbstractDocTree

java.lang.Object
org.opengion.fukurou.taglet.AbstractDocTree
すべての実装されたインタフェース:
Doclet
直系の既知のサブクラス:
DocTreeParam, DocTreePlugin, DocTreeSpecific, DocTreeTaglib, DocTreeVerCheck

public abstract class AbstractDocTree extends Object implements Doclet
ソースコメントから、パラメータ情報を取り出す Doclet クラスです。 og.paramLevel タグと og.cryptography タグを切り出します。 これらは、システムパラメータとしてGE12テーブルに設定される値をクラスより抽出する のに使用します。
導入されたバージョン:
JDK11.0,
  • ネストされたクラスの概要

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

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

    Doclet.Option
  • フィールドの概要

    フィールド
    修飾子とタイプ
    フィールド
    説明
    protected static final List<DocTree>
    空DocTreeリスト
    static final String
    エンコード "UTF-8"
    protected Reporter
    情報の出力
  • コンストラクタの概要

    コンストラクタ
    コンストラクタ
    説明
    デフォルトコンストラクター
  • メソッドの概要

    修飾子とタイプ
    メソッド
    説明
    protected Map<String,List<String>>
    BlockTagsのキーとリストのMapを作成して返します。
    protected String
    getBlockTag(String key, Map<String,List<String>> blcMap, String delimiter)
    blockTagsMapで作成されたMapオブジェクトから、文字列を作成します。
    ドックレットを識別する名前を返します。
    このドックレットでサポートされている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
  • フィールド詳細

  • コンストラクタの詳細

    • 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

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

      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 - 複数タグを連結する場合の、区切り文字
      戻り値:
      指定のタグの文字列