public interface Taglet
standard doclet
などのドックレットでサポートされているカスタム・タグ・レットのインタフェース。 カスタム・タグ・レットは、ドキュメンテーション・コメントのカスタム・タグを処理するために使用されます。カスタム・タグは、コメントの最後に表示される「ブロック・タグ」またはドキュメンテーション・コメントの本文内に表示される「インライン・タグ」として個別にインスタンス化できます。
タグ・レットの各実装は、タグ・レットをインスタンス化するためにドックレットによって使用されるパブリック非引数コンストラクタを指定する必要があります。 ドックレットは、このインタフェースを実装するクラスと次のように相互作用します:
- ドックレットは、tagletクラスのno-argコンストラクタを使用して、tagletのインスタンスを作成します。
- 次に、ドックレットは
init
メソッドを適切な環境およびドックレットとともに呼び出します。 - その後、ドックレットは
getName
、getAllowedLocations
およびisInlineTag
をコールして、タグ・レットでサポートされているタグの特性を判別します。 - 該当する場合、ドックレットはtagletオブジェクトで
toString
メソッドを呼び出し、タグのリストと、タグが要素ドキュメント・コメントの一部である要素を提供します。ここから、タグによってドキュメントに含める文字列を決定できます。 通常、ドックレットでは、戻される文字列のコンテンツに要件が指定されます。
前述のプロトコルに従わずにtagletオブジェクトを作成して使用した場合、taglet動作はこのインタフェース仕様では定義されません。
- APIのノート:
- これは、特定のドックレットと連動するようにタグを設計するのが一般的です。
- 導入されたバージョン:
- 9
- 関連項目:
- Standardドックレットのユーザー定義タグ
-
ネストされたクラスのサマリー
ネストされたクラス -
メソッドのサマリー
修飾子と型メソッド説明ブロック・タグでサポートされているロケーションのセットを返します。getName()
このタグ・レットでサポートされるタグの名前を返します。default void
init(DocletEnvironment env, Doclet doclet)
指定されたドックレット環境とドックレットでこのタグ・レットを初期化します。default boolean
このタグ・レットがブロック・タグをサポートするかどうかを示します。boolean
このタグ・レットがインライン・タグをサポートするかどうかを示します。生成された出力に含まれる、このタグの一連のインスタンスの文字列表現を返します。
-
メソッドの詳細
-
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)指定されたドックレット環境とドックレットでこのタグ・レットを初期化します。 -
toString
生成された出力に含まれる、このタグの一連のインスタンスの文字列表現を返します。このタグ・レットで
inline
タグがサポートされている場合は、シングルトン・リストで毎回インライン・タグのインスタンスごとにコールされます。 このタグ・レットでblock
タグがサポートされている場合は、ブロック・タグのインスタンスを含むコメントごとに、そのコメント内のブロック・タグのすべてのインスタンスのリストとともにコールされます。- パラメータ:
tags
- このタグのインスタンスのリストelement
- 囲みコメントが属する要素- 戻り値:
- 生成された出力に含まれるタグの文字列表現
- 関連項目:
- Standardドックレットのユーザー定義タグ
-