-
- すべてのスーパー・インタフェース:
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を取得します。-
インタフェース com.sun.javadoc.Tagで宣言されたメソッド
firstSentenceTags, holder, inlineTags, kind, name, position, text, toString
-
-
-
-
メソッドの詳細
-
label
String label()
削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。@see
タグのラベルを取得します。 ラベルが存在しない場合はnullを返します。 たとえば、@see String#trim() the trim method
- 戻り値:
- "トリム・メソッド"。
-
referencedPackage
PackageDoc referencedPackage()
削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。@see
がパッケージだけを参照するときにパッケージdocを取得します。 パッケージが見つからない場合、あるいは@see
が他の要素(クラス、インタフェース、フィールド、コンストラクタ、メソッド)または要素以外を参照する場合は、nullを返します。 たとえば、@see java.lang
java.lang
のPackageDoc
を返します。- 戻り値:
java.lang
のPackageDoc
。
-
referencedClassName
String referencedClassName()
削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。@see
参照のクラス名またはインタフェース名を取得します。 元の@see
タグで指定された名前が完全修飾名の場合、あるいはクラスまたはインタフェースが見つからない場合、名前は完全修飾名です。そうでない場合は非修飾名です。@see
がパッケージ名だけを参照する場合は、代わりにパッケージ名を返します。 たとえば、@see String#valueOf(java.lang.Object)
@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.String
のClassDoc
を返します。- 戻り値:
java.lang.String
のClassDoc
。
-
referencedMemberName
String referencedMemberName()
削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。@see
参照のフィールド、コンストラクタ、またはメソッドの部分文字列を取得します。 参照が他の要素または要素以外への参照の場合はnullを返します。 メンバー・クラス(ネストされたクラス)への参照はnullを返します。 たとえば、@see String#startsWith(String)
- 戻り値:
- "startsWith(String)".
-
referencedMember
MemberDoc referencedMember()
削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。@see
により参照されたフィールド、コンストラクタ、またはメソッドのメンバーdocを取得します。 メンバーが見つからなかった場合、または参照が他の要素または要素以外への参照の場合はnullを返します。 メンバー・クラス(ネストされたクラス)への参照はnullを返します。 たとえば、@see String#startsWith(java.lang.String)
startsWith
のMethodDoc
を返します。- 戻り値:
startsWith
のMethodDoc
。
-
-