com.sun.javadoc
インタフェース SeeTag

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

Tag

public interface SeeTag
extends Tag

関連するドキュメンテーションへのユーザー定義相互参照を表します。タグはパッケージ、クラス、またはメンバーを参照したり、プレーンテキストを保持したりできます。プレーンテキストは、印刷された本などオンラインではないものへの参照であっても、ハードコードされた HTML リンクであってもかまいません。参照は、{@link} を使ってコメントに合わせたり、@see を使って個別のブロックコメントに合わせたりすることができます。name() メソッドは、タグに応じて「@link」または「@see」を返します。kind() メソッドは両方のタグで「@see」を返します。

メソッドの概要

String	label() @see タグのラベルを取得します。
ClassDoc	referencedClass()
String	referencedClassName() @see 参照のクラス名またはインタフェース名を取得します。
MemberDoc	referencedMember() @see により参照されたフィールド、コンストラクタ、またはメソッドのメンバー doc を取得します。
String	referencedMemberName() @see 参照のフィールド、コンストラクタ、またはメソッドの部分文字列を取得します。
PackageDoc	referencedPackage() @see がパッケージだけを参照するときにパッケージ doc を取得します。

インタフェース com.sun.javadoc.Tag から継承されたメソッド

firstSentenceTags, holder, inlineTags, kind, name, position, text, toString

メソッドの詳細

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 が返されます。

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 が返されます。

referencedClass

ClassDoc referencedClass()

関連項目:

doc を取得します。クラスが見つからない場合は null を返します。次に例を示します。

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

この場合は、java.lang.String に対して ClassDoc が返されます。

referencedMemberName

String referencedMemberName()

@see 参照のフィールド、コンストラクタ、またはメソッドの部分文字列を取得します。参照がほかの要素または要素以外への参照の場合は null を返します。メンバークラス (入れ子になったクラス) への参照は null を返します。次に例を示します。

@see String#startsWith(String)

この場合は「startsWith(String)」が返されます。

referencedMember

MemberDoc referencedMember()

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

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

この場合は startsWith に対して MethodDoc が返されます。