com.sun.tools.doclets
インタフェース Taglet

public interface Taglet

ドックレットが使用するカスタムタグのインタフェースです。カスタムタグはこのインタフェースを実装する必要があります。実行時にドックレットがタグレットを読み込んで使用するには、そのタグレットが、次のシグネチャーで Map を引数として受け取る、register という static メソッドを持っている必要があります。

   public void register(Map map)
 

タグレットがそれ自体の登録に失敗した場合は、例外をスローすることをお勧めします。スローする例外はユーザー任意です。

2 つのタグレットの例を次に示します。

• ToDoTaglet.java - スタンドアロンタグレット
• UnderlineTaglet.java - インラインタグレット

独自のタグレットの作成方法ついては、「タグレットの概要」を参照してください。

導入されたバージョン:

1.4

inField

boolean inField()

このタグレットがフィールドドキュメンテーションで使用されている場合、true を返します。インラインタグについては false が設定されます。

戻り値:

このタグレットがフィールドドキュメンテーションで使用されている場合は true、そうでない場合は false

inConstructor

boolean inConstructor()

このタグレットがコンストラクタドキュメンテーションで使用されている場合、true を返します。インラインタグについては false が設定されます。

戻り値:

このタグレットがコンストラクタドキュメンテーションで使用されている場合は true、そうでない場合はfalse

inMethod

boolean inMethod()

このタグレットがメソッドキュメンテーションで使用されている場合、true を返します。インラインタグについては false が設定されます。

戻り値:

このタグレットがメソッドドキュメンテーションで使用されている場合は true、そうでない場合は false

inOverview

boolean inOverview()

このタグレットが概要ドキュメンテーションで使用されている場合、true を返します。インラインタグについては false が設定されます。

戻り値:

このタグレットがメソッドドキュメンテーションで使用されている場合は true、そうでない場合は false

inPackage

boolean inPackage()

このタグレットがパッケージドキュメンテーションで使用されている場合、true を返します。インラインタグについては false が設定されます。

戻り値:

このタグレットがパッケージドキュメンテーションで使用されている場合は true、そうでない場合は false

inType

boolean inType()

このタグレットがタイプドキュメンテーション (クラスまたはインタフェース) で使用されている場合、true を返します。インラインタグについては false が設定されます。

戻り値:

このタグレットがタイプドキュメンテーションで使用されている場合は true、そうでない場合は false

isInlineTag

boolean isInlineTag()

このタグレットがインラインタグである場合は true、そうでない場合は false を返します。

戻り値:

このタグレットがインラインタグである場合は true、そうでない場合は false

getName

String getName()

このカスタムタグの名前を返します。

戻り値:

このカスタムタグの名前

toString

String toString(com.sun.javadoc.Tag tag)

このカスタムタグのタグ表現を受け取り、文字列としての表現を返し、生成されたページに出力します。

パラメータ:

tag - このカスタムタグのタグ表現

戻り値:

このタグの文字列としての表現

toString

String toString(com.sun.javadoc.Tag[] tags)

このカスタムタグのタグ表現の配列を受け取り、文字列としての表現を返し、生成されたページに出力します。このタグレットがインラインタグを表す場合、このメソッドは null を返します。

パラメータ:

tags - このカスタムタグを表すタグの配列

戻り値:

このタグの文字列としての表現