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

インタフェースSeeTag

  • すべてのスーパー・インタフェース:
    Tag
    @Deprecated
public interface SeeTag
extends Tag
    非推奨。
    このパッケージの宣言は、パッケージjdk.javadoc.docletの宣言に置き換えられました。 詳細は、そのパッケージのマニュアルの「移行ガイド」を参照してください。
    関連するドキュメンテーションへのユーザー定義相互参照を表します。 タグはパッケージ、クラス、またはメンバーを参照したり、プレーン・テキストを保持したりできます。 プレーン・テキストは、印刷された本などオンラインではないものへの参照であっても、ハードコードされたHTMLリンクであってもかまいません。 参照は、{@link}を使ってコメントに合わせたり、@seeを使って個別のブロック・コメントに合わせたりすることができます。 name()メソッドは、タグに応じて@linkまたは@seeを返します。 kind()メソッドは両方のタグで@seeを返します。

    • メソッドの詳細

      • label

        String label()
        非推奨。
        @seeタグのラベルを取得します。 ラベルが存在しない場合はnullを返します。 次に例を示します。

          @see String#trim() the trim method

        この場合は、「the trim method」が返されます。
        戻り値:
        "トリム・メソッド"。

      • referencedPackage

        PackageDoc referencedPackage()
        非推奨。
        @seeがパッケージだけを参照するときにパッケージdocを取得します。 パッケージが見つからない場合、あるいは@seeが他の要素(クラス、インタフェース、フィールド、コンストラクタ、メソッド)または要素以外を参照する場合は、nullを返します。 次に例を示します。

          @see java.lang

        java.langのPackageDocを返します。
        戻り値:
        java.langのPackageDoc。

      • referencedClassName

        String referencedClassName()
        非推奨。
        @see参照のクラス名またはインタフェース名を取得します。 元の@seeタグで指定された名前が完全修飾名の場合、あるいはクラスまたはインタフェースが見つからない場合、名前は完全修飾名です。そうでない場合は非修飾名です。 @seeがパッケージ名だけを参照する場合は、代わりにパッケージ名を返します。 次に例を示します。

          @see String#valueOf(java.lang.Object)

        この場合は、「java.lang.String」が返されます。 「@see java.lang」の場合、「java.lang」が返されます。 @seeが@see <a href="java.sun.com">などのような要素以外を参照する場合は、nullが返されます。
        戻り値:
        @seeが@see <a href="java.sun.com">などの非要素を参照する場合はnull。

      • referencedClass

        ClassDoc referencedClass()
        非推奨。
        @seeのクラス名の部分によって参照されるクラスdocを取得します。 クラスが見つからない場合はnullを返します。 次に例を示します。

          @see String#valueOf(java.lang.Object)

        java.lang.StringのClassDocを返します。
        戻り値:
        java.lang.StringのClassDoc。

      • referencedMemberName

        String referencedMemberName()
        非推奨。
        @see参照のフィールド、コンストラクタ、またはメソッドの部分文字列を取得します。 参照が他の要素または要素以外への参照の場合はnullを返します。 メンバー・クラス(ネストされたクラス)への参照はnullを返します。 次に例を示します。

          @see String#startsWith(String)

        この場合は「startsWith(String)」が返されます。
        戻り値:
        "startsWith(String) "。

      • referencedMember

        MemberDoc referencedMember()
        非推奨。
        @seeにより参照されたフィールド、コンストラクタ、またはメソッドのメンバーdocを取得します。 メンバーが見つからなかった場合、または参照が他の要素または要素以外への参照の場合はnullを返します。 メンバー・クラス(ネストされたクラス)への参照はnullを返します。 次に例を示します。

          @see String#startsWith(java.lang.String)

        startsWithのMethodDocを返します。
        戻り値:
        startsWithのMethodDoc。