モジュール jdk.javadoc
パッケージ com.sun.tools.doclets

インタフェースTaglet

  • 非推奨。 
    このインタフェースは、その置換Tagletに取って代わられました。

    @Deprecated
public interface Taglet
    ドックレットが使用するカスタム・タグのインタフェースです。 カスタム・タグはこのインタフェースを実装する必要があります。

    注意: このインタフェースは、その置換Tagletに取って代わられました。

    実行時にドックレットがタグレットをロードして使用するには、そのタグレットが、次のシグニチャでMapを引数として受け取る、registerというstaticメソッドを持っている必要があります。 
       public void register(Map map)
    このメソッドは、タグレット名をキーとして、カスタム・タグレットのインスタンスをマップに追加します。 タグレットをオーバーライドする場合、名前の競合を避けるため、新しいタグレットのインスタンスをマップに追加する前に、オーバーライドされる側のタグレットをマップから削除する必要があります。

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

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

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

    導入されたバージョン:
    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​(Tag tag)
      非推奨。 
      このカスタム・タグのTag表現を受け取り、生成されたページへの出力になるその文字列表現を返します。
      String toString​(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​(Tag tag)
        非推奨。 
        このカスタム・タグのTag表現を受け取り、生成されたページへの出力になるその文字列表現を返します。
        パラメータ:
        tag - このカスタム・タグのTag表現。
        戻り値:
        このTagの文字列表現。

      • toString

        String toString​(Tag[] tags)
        非推奨。 
        このカスタム・タグのTag表現の配列を受け取り、生成されたページへの出力になるその文字列表現を返します。 このタグレットがインライン・タグを表す場合、このメソッドはnullを返します。
        パラメータ:
        tags - このカスタム・タグを表すTagの配列。
        戻り値:
        このTagの文字列表現。