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

インタフェースTaglet

public interface Taglet
standard docletなどのドックレットでサポートされているカスタム・タグ・レットのインタフェース。 カスタム・タグを使用して、ドキュメント・コメントでカスタム・タグを処理します。カスタム・タグは、コメントの終わりに表示される「ブロック・タグ」か、ドキュメント・コメントの本文内に表示される「インライン・タグ」のいずれかです。

タグ・レットの各実装は、タグ・レットをインスタンス化するためにドックレットによって使用されるパブリック非引数コンストラクタを指定する必要があります。 ドックレットは、このインタフェースを実装するクラスと次のように相互作用します:

  1. ドックレットは、tagletクラスのno-argコンストラクタを使用して、tagletのインスタンスを作成します。
  2. 次に、ドックレットはinitメソッドを適切な環境およびドックレットとともに呼び出します。
  3. その後、ドックレットはgetName、getAllowedLocationsおよびisInlineTagをコールして、タグ・レットでサポートされているタグの特性を判別します。
  4. 該当する場合、ドックレットはtagletオブジェクトでtoStringメソッドを呼び出し、タグのリストと、タグが要素ドキュメント・コメントの一部である要素を提供します。ここから、タグによってドキュメントに含める文字列を決定できます。 通常、ドックレットでは、戻される文字列のコンテンツに要件が指定されます。

前述のプロトコルに従わずにtagletオブジェクトを作成して使用した場合、taglet動作はこのインタフェース仕様では定義されません。

APIのノート:
これは、特定のドックレットと連動するようにタグを設計するのが一般的です。
導入されたバージョン:
9
関連項目:
Standardドックレットのユーザー定義タグ

  • ネストされたクラスのサマリー

    ネストされたクラス 
    修飾子と型 インタフェース 説明
    static class  Taglet.Location
    タグが使用されるロケーションの種類。

  • メソッドのサマリー

    修飾子と型 メソッド 説明
    Set<Taglet.Location> getAllowedLocations()
    タグを使用できるロケーションのセットを返します。
    String getName()
    タグの名前を返します。
    default void init​(DocletEnvironment env, Doclet doclet)
    指定されたドックレット環境とドックレットでこのタグ・レットを初期化します。
    boolean isInlineTag()
    このタグ・レットがインライン・タグ用であるかどうかを示します。
    String toString​(List<? extends DocTree> tags, Element element)
    生成された出力に含まれる、このタグの一連のインスタンスの文字列表現を返します。

  • メソッドの詳細

    • 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 - 囲みコメントが属する要素
      戻り値:
      生成された出力に含まれるタグの文字列表現
      関連項目:
      Standardドックレットのユーザー定義タグ