Taglet

```
public interface Taglet
```
ドックレットが使用するカスタムタグのインタフェースです。カスタムタグはこのインタフェースを実装する必要があります。実行時にドックレットがタグレットをロードして使用するには、そのタグレットが、次のシグネチャーで Map を引数として受け取る、register という static メソッドを持っている必要があります。
```
   public void register(Map map)
 
```
このメソッドは、タグレット名をキーとして、カスタムタグレットのインスタンスをマップに追加します。タグレットをオーバーライドする場合、名前の競合を避けるため、新しいタグレットのインスタンスをマップに追加する前に、オーバーライドされる側のタグレットをマップから削除する必要があります。
タグレットがそれ自体の登録に失敗した場合は、例外をスローすることをお勧めします。スローする例外はユーザー任意です。
2 つのタグレットの例を次に示します。
- ToDoTaglet.java - スタンドアロンタグレット
- UnderlineTaglet.java - インラインタグレット
独自のタグレットを作成する方法ついては、「タグレットの概要」を参照してください。
導入されたバージョン:

1.4

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`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` 表現の配列を受け取り、生成されたページへの出力になるその文字列表現を返します。

- メソッドの詳細
  - inField
```
boolean inField()
```
    この Taglet がフィールドドキュメンテーションで使用されている場合、true を返します。インラインタグについては false が設定されます。
    
    戻り値:
    この Taglet がフィールドドキュメンテーションで使用されている場合は true、そうでない場合は false。
  - inConstructor
```
boolean inConstructor()
```
    この Taglet がコンストラクタドキュメンテーションで使用されている場合、true を返します。インラインタグについては false が設定されます。
    
    戻り値:
    この Taglet がコンストラクタドキュメンテーションで使用されている場合は true、そうでない場合は false。
  - inMethod
```
boolean inMethod()
```
    この Taglet がメソッドドキュメンテーションで使用されている場合、true を返します。インラインタグについては false が設定されます。
    
    戻り値:
    この Taglet がメソッドドキュメンテーションで使用されている場合は true、そうでない場合は false。
  - inOverview
```
boolean inOverview()
```
    この Taglet が概要ドキュメンテーションで使用されている場合、true を返します。インラインタグについては false が設定されます。
    
    戻り値:
    この Taglet がメソッドドキュメンテーションで使用されている場合は true、そうでない場合は false。
  - inPackage
```
boolean inPackage()
```
    この Taglet がパッケージドキュメンテーションで使用されている場合、true を返します。インラインタグについては false が設定されます。
    
    戻り値:
    この Taglet がパッケージドキュメンテーションで使用されている場合は true、そうでない場合は false。
  - inType
```
boolean inType()
```
    この Taglet がタイプドキュメンテーション (クラスまたはインタフェース) で使用されている場合、true を返します。インラインタグについては false が設定されます。
    
    戻り値:
    この Taglet がタイプドキュメンテーションで使用されている場合は true、そうでない場合は false。
  - isInlineTag
```
boolean isInlineTag()
```
    この Taglet がインラインタグである場合、true を返します。そうでない場合は false を返します。
    
    戻り値:
    この Taglet がインラインタグである場合は true、そうでない場合は false。
  - getName
```
String getName()
```
    このカスタムタグの名前を返します。
    
    戻り値:
    このカスタムタグの名前。
  - toString
```
String toString(com.sun.javadoc.Tag tag)
```
    このカスタムタグの Tag 表現を受け取り、生成されたページへの出力になるその文字列表現を返します。
    
    パラメータ:
    tag - このカスタムタグの Tag 表現。
    
    戻り値:
    この Tag の文字列表現。
  - toString
```
String toString(com.sun.javadoc.Tag[] tags)
```
    このカスタムタグの Tag 表現の配列を受け取り、生成されたページへの出力になるその文字列表現を返します。このタグレットがインラインタグを表す場合、このメソッドは null を返します。
    
    パラメータ:
    tags - このカスタムタグを表す Tag の配列。
    
    戻り値:
    この Tag の文字列表現。

インタフェース Taglet

メソッドのサマリー

メソッドの詳細

inField

inConstructor

inMethod

inOverview

inPackage

inType

isInlineTag

getName

toString

toString