public interface Taglet
ドックレットが使用するカスタムタグのインタフェースです。カスタムタグはこのインタフェースを実装する必要があります。実行時にドックレットがタグレットを読み込んで使用するには、そのタグレットが、次のシグネチャーで Map
を引数として受け取る、register
という static メソッドを持っている必要があります。
public void register(Map map)このメソッドは、タグレット名をキーとして、カスタムタグレットのインスタンスをマップに追加します。タグレットをオーバーライドする場合、名前の競合を避けるため、新しいタグレットのインスタンスをマップに追加する前に、オーバーライドされる側のタグレットをマップから削除する必要があります。
タグレットがそれ自体の登録に失敗した場合は、例外をスローすることをお勧めします。スローする例外はユーザー任意です。
2 つのタグレットの例を次に示します。
独自のタグレットの作成方法ついては、「タグレットの概要」を参照してください。
メソッドの概要 | |
---|---|
String |
getName()
このカスタムタグの名前を返します。 |
boolean |
inConstructor()
この タグレット がコンストラクタドキュメンテーションで使用されている場合、true を返します。 |
boolean |
inField()
この タグレット がフィールドドキュメンテーションで使用されている場合、true を返します。 |
boolean |
inMethod()
この タグレット がメソッドキュメンテーションで使用されている場合、true を返します。 |
boolean |
inOverview()
この タグレット が概要ドキュメンテーションで使用されている場合、true を返します。 |
boolean |
inPackage()
この タグレット がパッケージドキュメンテーションで使用されている場合、true を返します。 |
boolean |
inType()
この タグレット がタイプドキュメンテーション (クラスまたはインタフェース) で使用されている場合、true を返します。 |
boolean |
isInlineTag()
この タグレット がインラインタグである場合は true、そうでない場合は false を返します。 |
String |
toString(com.sun.javadoc.Tag tag)
このカスタムタグの タグ 表現を受け取り、文字列としての表現を返し、生成されたページに出力します。 |
String |
toString(com.sun.javadoc.Tag[] tags)
このカスタムタグの タグ 表現の配列を受け取り、文字列としての表現を返し、生成されたページに出力します。 |
メソッドの詳細 |
---|
boolean inField()
タグレット
がフィールドドキュメンテーションで使用されている場合、true を返します。インラインタグについては false が設定されます。
タグレット
がフィールドドキュメンテーションで使用されている場合は true、そうでない場合は falseboolean inConstructor()
タグレット
がコンストラクタドキュメンテーションで使用されている場合、true を返します。インラインタグについては false が設定されます。
タグレット
がコンストラクタドキュメンテーションで使用されている場合は true、そうでない場合はfalseboolean inMethod()
タグレット
がメソッドキュメンテーションで使用されている場合、true を返します。インラインタグについては false が設定されます。
boolean inOverview()
タグレット
が概要ドキュメンテーションで使用されている場合、true を返します。インラインタグについては false が設定されます。
タグレット
がメソッドドキュメンテーションで使用されている場合は true、そうでない場合は falseboolean inPackage()
タグレット
がパッケージドキュメンテーションで使用されている場合、true を返します。インラインタグについては false が設定されます。
タグレット
がパッケージドキュメンテーションで使用されている場合は true、そうでない場合は falseboolean inType()
タグレット
がタイプドキュメンテーション (クラスまたはインタフェース) で使用されている場合、true を返します。インラインタグについては false が設定されます。
タグレット
がタイプドキュメンテーションで使用されている場合は true、そうでない場合は falseboolean isInlineTag()
タグレット
がインラインタグである場合は true、そうでない場合は false を返します。
タグレット
がインラインタグである場合は true、そうでない場合は falseString getName()
String toString(com.sun.javadoc.Tag tag)
タグ
表現を受け取り、文字列としての表現を返し、生成されたページに出力します。
tag
- このカスタムタグのタグ
表現
タグ
の文字列としての表現String toString(com.sun.javadoc.Tag[] tags)
タグ
表現の配列を受け取り、文字列としての表現を返し、生成されたページに出力します。このタグレットがインラインタグを表す場合、このメソッドは null を返します。
tags
- このカスタムタグを表すタグ
の配列
タグ
の文字列としての表現