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