モジュール 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 enum	Taglet.Location	タグを使用できるロケーションの種類。

メソッドのサマリー

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

メソッドの詳細

getAllowedLocations

Set<Taglet.Location> getAllowedLocations()

ブロック・タグでサポートされているロケーションのセットを返します。

戻り値:

ブロック・タグでサポートされているロケーションのセット

isInlineTag

boolean isInlineTag()

このタグ・レットがインライン・タグをサポートするかどうかを示します。

戻り値:

このタグ・レットがインライン・タグをサポートする場合はtrue

isBlockTag

default boolean isBlockTag()

このタグ・レットがブロック・タグをサポートするかどうかを示します。

実装要件:

この実装は、逆の結果をisInlineTagに返します。

戻り値:

このタグ・レットがブロック・タグをサポートする場合はtrue

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タグがサポートされている場合は、シングルトン・リストで毎回インライン・タグのインスタンスごとにコールされます。 このタグ・レットでblockタグがサポートされている場合は、ブロック・タグのインスタンスを含むコメントごとに、そのコメント内のブロック・タグのすべてのインスタンスのリストとともにコールされます。

パラメータ:

tags - このタグのインスタンスのリスト

element - 囲みコメントが属する要素

戻り値:

生成された出力に含まれるタグの文字列表現

関連項目:

• Standardドックレットのユーザー定義タグ