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

インタフェースSeeTag

  • すべてのスーパー・インタフェース:
    Tag

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

      すべてのメソッド インスタンス・メソッド 抽象メソッド 非推奨のメソッド 
      修飾子と型 メソッド 説明
      String label()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      @seeタグのラベルを取得します。
      ClassDoc referencedClass()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      @seeのクラス名の部分によって参照されるクラスdocを取得します。
      String referencedClassName()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      @see参照のクラス名またはインタフェース名を取得します。
      MemberDoc referencedMember()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      @seeにより参照されたフィールド、コンストラクタ、またはメソッドのメンバーdocを取得します。
      String referencedMemberName()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      @see参照のフィールド、コンストラクタ、またはメソッドの部分文字列を取得します。
      PackageDoc referencedPackage()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      @seeがパッケージだけを参照するときにパッケージdocを取得します。
    • メソッドの詳細

      • label

        String label()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        @seeタグのラベルを取得します。 ラベルが存在しない場合はnullを返します。 次に例を示します。

          @see String#trim() the trim method

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

        PackageDoc referencedPackage()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        @seeがパッケージだけを参照するときにパッケージdocを取得します。 パッケージが見つからない場合、あるいは@seeが他の要素(クラス、インタフェース、フィールド、コンストラクタ、メソッド)または要素以外を参照する場合は、nullを返します。 次に例を示します。

          @see java.lang

        java.langPackageDocを返します。
        戻り値:
        java.langPackageDoc
      • referencedClassName

        String referencedClassName()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        @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()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        @seeのクラス名の部分によって参照されるクラスdocを取得します。 クラスが見つからない場合はnullを返します。 次に例を示します。

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

        java.lang.StringClassDocを返します。
        戻り値:
        java.lang.StringClassDoc
      • referencedMemberName

        String referencedMemberName()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        @see参照のフィールド、コンストラクタ、またはメソッドの部分文字列を取得します。 参照が他の要素または要素以外への参照の場合はnullを返します。 メンバー・クラス(ネストされたクラス)への参照はnullを返します。 次に例を示します。

          @see String#startsWith(String)

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

        MemberDoc referencedMember()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        @seeにより参照されたフィールド、コンストラクタ、またはメソッドのメンバーdocを取得します。 メンバーが見つからなかった場合、または参照が他の要素または要素以外への参照の場合はnullを返します。 メンバー・クラス(ネストされたクラス)への参照はnullを返します。 次に例を示します。

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

        startsWithMethodDocを返します。
        戻り値:
        startsWithMethodDoc