モジュール jdk.javadoc
パッケージ jdk.javadoc.doclet

インタフェースTaglet


  • public interface Taglet
    standard docletなどのドックレットでサポートされているカスタム・タグ・レットのインタフェース。 カスタム・タグ・レットは、ドキュメンテーション・コメントのカスタム・タグを処理するために使用されます。

    カスタム・タグ・レットはこのインタフェースを実装する必要があり、ドックレットがカスタム・タグ・レットをインスタンス化して登録するためのパブリック・デフォルト・コンストラクタ(パラメータを持たないpublicコンストラクタ)を持つ必要があります。

    導入されたバージョン:
    9

    • メソッドの詳細

      • getAllowedLocations

        Set<Taglet.Location> getAllowedLocations​()
        タグを使用できるロケーションのセットを返します。
        戻り値:
        タグが使用されるロケーションのセット

      • isInlineTag

        boolean isInlineTag​()
        このタグ・レットがインライン・タグ用であるかどうかを示します。
        戻り値:
        このタグ・レットがインライン・タグの場合はtrue、そうでない場合はfalse

      • getName

        String getName​()
        タグの名前を返します。
        戻り値:
        このカスタム・タグの名前。

      • init

        default void init​(DocletEnvironment env,
                  Doclet doclet)
        指定されたドックレット環境とドックレットでこのタグ・レットを初期化します。
        APIの注:
        環境は、必要に応じてelementsおよびtypesのユーティリティ・クラスにアクセスするために使用できます。
        実装要件:
        この実装は処理を行いません。
        パラメータ:
        env - ドックレットとタグ・レットが実行されている環境
        doclet - このタグ・レットをインスタンス化したドックレット

      • toString

        String toString​(List<? extends DocTree> tags,
                Element element)
        生成された出力に含まれる、このタグの一連のインスタンスの文字列表現を返します。 このタグ・レットがinlineタグのタグ・レットである場合は、そのたびにタグのインスタンスごとに呼び出されます。そのたびに、シングルトン・リストが呼び出されます。 それ以外の場合、このタグがブロック・タグである場合、コメント内のタグのすべてのインスタンスのリストとともに、コメントごとに1回呼び出されます。
        パラメータ:
        tags - このタグのインスタンスのリスト
        element - 囲みコメントが属する要素
        戻り値:
        生成された出力に含まれるタグの文字列表現