public interface Taglet
Map
を引数として受け取る、register
というstaticメソッドを持っている必要があります。
public void register(Map map)このメソッドは、タグレット名をキーとして、カスタム・タグレットのインスタンスをマップに追加します。タグレットをオーバーライドする場合、名前の競合を避けるため、新しいタグレットのインスタンスをマップに追加する前に、オーバーライドされる側のタグレットをマップから削除する必要があります。
タグレットがそれ自体の登録に失敗した場合は、例外をスローすることをお勧めします。スローする例外はユーザー任意です。
2つのタグレットの例を次に示します。
独自のタグレットを作成する方法ついては、「タグレットの概要」を参照してください。
修飾子と型 | メソッドと説明 |
---|---|
String |
getName()
このカスタム・タグの名前を返します。
|
boolean |
inConstructor()
この
Taglet がコンストラクタ・ドキュメンテーションで使用されている場合、trueを返します。 |
boolean |
inField()
この
Taglet がフィールド・ドキュメンテーションで使用されている場合、trueを返します。 |
boolean |
inMethod()
この
Taglet がメソッド・ドキュメンテーションで使用されている場合、trueを返します。 |
boolean |
inOverview()
この
Taglet が概要ドキュメンテーションで使用されている場合、trueを返します。 |
boolean |
inPackage()
この
Taglet がパッケージ・ドキュメンテーションで使用されている場合、trueを返します。 |
boolean |
inType()
この
Taglet がタイプ・ドキュメンテーション(クラスまたはインタフェース)で使用されている場合、trueを返します。 |
boolean |
isInlineTag()
この
Taglet がインライン・タグである場合、trueを返します。 |
String |
toString(com.sun.javadoc.Tag tag)
このカスタム・タグの
Tag 表現を受け取り、生成されたページへの出力になるその文字列表現を返します。 |
String |
toString(com.sun.javadoc.Tag[] tags)
このカスタム・タグの
Tag 表現の配列を受け取り、生成されたページへの出力になるその文字列表現を返します。 |
boolean inField()
Taglet
がフィールド・ドキュメンテーションで使用されている場合、trueを返します。インライン・タグについてはfalseが設定されます。Taglet
がフィールド・ドキュメンテーションで使用されている場合はtrue、そうでない場合はfalse。boolean inConstructor()
Taglet
がコンストラクタ・ドキュメンテーションで使用されている場合、trueを返します。インライン・タグについてはfalseが設定されます。Taglet
がコンストラクタ・ドキュメンテーションで使用されている場合はtrue、そうでない場合はfalse。boolean inMethod()
Taglet
がメソッド・ドキュメンテーションで使用されている場合、trueを返します。インライン・タグについてはfalseが設定されます。Taglet
がメソッド・ドキュメンテーションで使用されている場合はtrue、そうでない場合はfalse。boolean inOverview()
Taglet
が概要ドキュメンテーションで使用されている場合、trueを返します。インライン・タグについてはfalseが設定されます。Taglet
がメソッド・ドキュメンテーションで使用されている場合はtrue、そうでない場合はfalse。boolean inPackage()
Taglet
がパッケージ・ドキュメンテーションで使用されている場合、trueを返します。インライン・タグについてはfalseが設定されます。Taglet
がパッケージ・ドキュメンテーションで使用されている場合はtrue、そうでない場合はfalse。boolean inType()
Taglet
がタイプ・ドキュメンテーション(クラスまたはインタフェース)で使用されている場合、trueを返します。インライン・タグについてはfalseが設定されます。Taglet
がタイプ・ドキュメンテーションで使用されている場合はtrue、そうでない場合はfalse。boolean isInlineTag()
Taglet
がインライン・タグである場合、trueを返します。そうでない場合はfalseを返します。Taglet
がインライン・タグである場合はtrue、そうでない場合はfalse。String getName()
String toString(com.sun.javadoc.Tag tag)
Tag
表現を受け取り、生成されたページへの出力になるその文字列表現を返します。tag
- このカスタム・タグのTag
表現。Tag
の文字列表現。String toString(com.sun.javadoc.Tag[] tags)
Tag
表現の配列を受け取り、生成されたページへの出力になるその文字列表現を返します。このタグレットがインライン・タグを表す場合、このメソッドはnullを返します。tags
- このカスタム・タグを表すTag
の配列。Tag
の文字列表現。 バグまたは機能を送信
Java は米国ならびにその他の国における Oracle Corporation およびその関連企業の商標または登録商標です。
Copyright © 1993, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.