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

インタフェースTaglet

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

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

    導入されたバージョン:
    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回、シングルトン・リストを使用してコールされます。 それ以外の場合、このタグがブロック・タグの場合、コメントごとに1回コールされ、コメント内のタグのすべてのインスタンスのリストが表示されます。
        パラメータ:
        tags - このタグのインスタンスのリスト
        element - 囲みコメントが属する要素
        戻り値:
        生成される出力に含めるタグの文字列表現