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

インタフェースTag

  • 既知のすべてのサブインタフェース:
    ParamTag, SeeTag, SerialFieldTag, ThrowsTag

    @Deprecated(since="9",
                forRemoval=true)
    public interface Tag
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    このパッケージの宣言は、パッケージjdk.javadoc.docletの宣言に置き換えられました。 詳細は、そのパッケージのマニュアルの「移行ガイド」を参照してください。
    単純なドキュメンテーション・タグ(@since、@author、@versionなど)を表します。 各タグ(@since 1.2など)は、タグ名(@sinceなど)とタグ・テキスト(1.2など)を保持します。 構造を持つタグや特殊な処理が必要なタグは、ParamTag (@paramの場合)、SeeTag (@seeと)、ThrowsTag (@throwsのために)などのサブクラスで処理されます。
    関連項目:
    SeeTag, ParamTag, ThrowsTag, SerialFieldTag, Doc.tags()
    • メソッドのサマリー

      すべてのメソッド インスタンス・メソッド 抽象メソッド 非推奨のメソッド 
      修飾子と型 メソッド 説明
      Tag[] firstSentenceTags()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      コメントの最初の文をタグの配列として返します。
      Doc holder()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このタグ要素のDocを含めて返します。
      Tag[] inlineTags()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      埋め込まれた{@link}タグのあるドキュメンテーション・コメントの場合、Tagオブジェクトの配列を返します。
      String kind()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このタグの種類を返します。
      String name()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このタグの名前を返します。
      SourcePosition position()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このタグのソース位置を返します。
      String text()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このタグのテキスト(タグ名よりも後ろの部分)を返します。
      String toString()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このオブジェクトを文字列に変換します。
    • メソッドの詳細

      • name

        String name()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このタグの名前を返します。 名前は、@returnのように、ドキュメンテーション・コメントで使用される@で始まる文字列です。 {@link}のようなインライン・タグの場合、中括弧は名前には含めず、この例では、単に@linkがこのインライン・タグの名前になります。
        戻り値:
        このタグの名前
      • holder

        Doc holder()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このタグ要素のDocを含めて返します。
        戻り値:
        このタグ要素に含まれるDoc
      • kind

        String kind()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このタグの種類を返します。 ほとんどのタグでは、kind() == name()です。指定された種類のタグが複数ある場合を次の表に示します。
        関連タグ
        name() kind()
        @exception @throws
        @link @see
        @linkplain @see
        @see @see
        @serial @serial
        @serialData @serial
        @throws @throws
        戻り値:
        このタグの種類。
      • text

        String text()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このタグのテキスト(タグ名よりも後ろの部分)を返します。
        戻り値:
        このタグのテキスト。
      • toString

        String toString()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このオブジェクトを文字列に変換します。
        オーバーライド:
        toString 、クラス:  Object
        戻り値:
        このオブジェクトの文字列表現。
      • inlineTags

        Tag[] inlineTags()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        埋め込まれた{@link}タグのあるドキュメンテーション・コメントの場合、Tagオブジェクトの配列を返します。 ドキュメンテーション・コメント全体が、{@link}タグで分割された複数の文字列に分けられます。この場合、配列の連続する各要素は、最初から最後まで順番に特定の文字列または{@link}タグを表します。 各文字列は、Textという名前のTagオブジェクトで表されます。この場合、text()は文字列を返します。 {@link}タグは、名前が@linkで種類が@seeのSeeTagによって表されます。 たとえば、次のコメント・タグが指定されたとします。

        This is a {@link Doc commentlabel} example.

        次のTagオブジェクトの配列を返します。

        • tags[0]は、Textという名前およびThis is aを含むテキストを持つTagです。
        • tags[1]は、@linkという名前、参照クラスのDoc、およびcommentlabelというラベルを持つSeeTagです。
        • tags[2]は、Textという名前およびexampleを含むテキストを持つTagです。

        戻り値:
        タグの配列Tag[]
        関連項目:
        ParamTag, ThrowsTag
      • firstSentenceTags

        Tag[] firstSentenceTags()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        コメントの最初の文をタグの配列として返します。 インライン・タグ({@link reference}タグ)を含みますが、ブロック・タグは含みません。 プレーン・テキストの各セクションは、種類TextのTagとして表されます。 インライン・タグは、種類@linkのSeeTagとして表されます。 ロケールが英語の場合、最初の文はJava言語仕様(最初のバージョン)に記述されている規則によって決定されます。"この文は、直後にスペース、タブ、または改行が続く最初のピリオド、または最初のタグ・ラインで終了します。"さらに、行は段落およびセクションの終わりを示す、次のようなHTMLタグで終了します。<p> </p> <h1> <h2> <h3> <h4> <h5> <h6> <hr> <pre>または</pre>。 ロケールの言語が英語でない場合、文の終わりはBreakIterator.getSentenceInstance(Locale)によって決定されます。
        戻り値:
        コメントの最初の文を表すTagオブジェクトの配列
      • position

        SourcePosition position()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このタグのソース位置を返します。
        戻り値:
        このタグのソース位置。