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

クラス 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 
    AbstractDocTree.AbstractOption
    Doclet.Option を継承し、共通ﾒｿｯﾄﾞを実装したabstractｸﾗｽ 単純に、ﾒｿｯﾄﾞのOverrideで共通化しているだけです。

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

    Doclet.Option

  • フィールドの概要

    フィールド
    修飾子とタイプ
    フィールド
    説明
    protected static final List<DocTree>
    EMPTY_LIST
    空DocTreeﾘｽﾄ
    static final String
    ENCODE
    ｴﾝｺｰﾄﾞ "UTF-8"
    protected String
    outfile
    8.5.6.1 (2024/03/29) 出力ﾌｧｲﾙ
    protected Reporter
    reporter
    情報の出力
    protected String
    version
    8.5.6.1 (2024/03/29) ﾊﾞｰｼﾞｮﾝ

  • コンストラクタの概要

    コンストラクタ
    コンストラクタ
    説明
    AbstractDocTree()
    ﾃﾞﾌｫﾙﾄｺﾝｽﾄﾗｸﾀｰ

  • メソッドの概要

    修飾子とタイプ
    メソッド
    説明
    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()
    ﾄﾞｯｸﾚｯﾄを識別する名前を返します。
    Set<? extends Doclet.Option>
    getSupportedOptions()
    ｻﾎﾟｰﾄされているすべてのｵﾌﾟｼｮﾝを返します｡
    SourceVersion
    getSupportedSourceVersion()
    このﾄﾞｯｸﾚｯﾄでｻﾎﾟｰﾄされているJavaﾌﾟﾛｸﾞﾗﾐﾝｸﾞ言語のﾊﾞｰｼﾞｮﾝを返します。
    protected String[]
    getTitleCmnt(DocCommentTree docTree)
    DocTreeﾘｽﾄから、最初の1文(改行か『。』
    void
    init(Locale locale, Reporter reporter)
    指定されたﾛｹｰﾙとｴﾗｰ・ﾚﾎﾟｰﾀでこのﾄﾞｯｸﾚｯﾄを初期化します。
    boolean
    run(DocletEnvironment docEnv)
    Doclet のｴﾝﾄﾘﾎﾟｲﾝﾄﾒｿｯﾄﾞです(昔の startﾒｿｯﾄﾞ)｡
    protected abstract void
    writeContents(DocletEnvironment docEnv, DocTreeWriter writer)
    DocletEnvironmentよりコンテンツを作成します。

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

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

  • フィールド詳細

  • コンストラクタの詳細

    • 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対応

    • run

      public boolean run(DocletEnvironment docEnv)
      Doclet のｴﾝﾄﾘﾎﾟｲﾝﾄﾒｿｯﾄﾞです(昔の startﾒｿｯﾄﾞ)｡
      定義:
      run インタフェース内 Doclet
      パラメータ:
      docEnv - ﾄﾞｯｸﾚｯﾄを1回呼び出す操作環境
      戻り値:
      正常実行時 true
      変更履歴:
      7.3.0.0 (2021/01/06) 新しいJavaDoc対応, 8.5.6.1 (2024/03/29) 継承で使えるように、追加します。

    • writeContents

      protected abstract void writeContents(DocletEnvironment docEnv, DocTreeWriter writer)
      DocletEnvironmentよりコンテンツを作成します。
      パラメータ:
      docEnv - ドックレットの最上位
      writer - DocTreeWriterオブジェクト
      変更履歴:
      7.3.0.0 (2021/01/06) 新しいJavaDoc対応, 8.0.2.1 (2021/12/10) tagGroupがdescriptionと合わせて出力されるため、【】でくくります。, 8.0.2.1 (2021/12/10) ｺﾒﾝﾄ分割で『。』と半角の『｡』の両方対応しておく。, 8.5.6.1 (2024/03/29) 継承で使えるように、一部修正します。

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

    • getTitleCmnt

      protected String[] getTitleCmnt(DocCommentTree docTree)
      DocTreeﾘｽﾄから、最初の1文(改行か『。』まで)と本文の文字列を切り出します。 title が、docTree.getFirstSentence(); でうまく取れていないようです。 docTree.getFullBody() で取ってきた最初の1文と、残りの本文を切り出します。
      パラメータ:
      docTree - DocCommentTreeｵﾌﾞｼﾞｪｸﾄ
      戻り値:
      最初の1文(改行か『。』まで)と本文の文字列を分割した配列
      変更履歴:
      8.0.1.0 (2021/10/29) titleを改行か『。』までの文字列を切り出す。, 8.0.2.1 (2021/12/10) ｺﾒﾝﾄ分割で『。』と半角の『。』の両方対応しておく。, 8.0.2.1 (2021/12/10) DocTreeParam → AbstractDocTree に移動, 8.5.1.0 (2023/06/30) docTreeの変換がunicodeの為、正しく動作しなかった『。』変換対応

    • getSupportedOptions

      public Set<? extends Doclet.Option> getSupportedOptions()
      ｻﾎﾟｰﾄされているすべてのｵﾌﾟｼｮﾝを返します｡
      定義:
      getSupportedOptions インタフェース内 Doclet
      戻り値:
      ｻﾎﾟｰﾄされているすべてのｵﾌﾟｼｮﾝを含むｾｯﾄ、存在しない場合は空のｾｯﾄ
      変更履歴:
      8.5.6.1 (2024/03/29) 継承で使えるように、追加します。