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

既知のサブインタフェースの一覧:

ParamTag, SeeTag, SerialFieldTag, ThrowsTag

public interface Tag

単純なドキュメンテーションタグ (@since、@author、@version など) を表します。各タグ (「@since 1.2」など) は、タグ名 (「@since」など) とタグテキスト (「1.2」など) を保持します。構造を持ったタグや特別な処理が必要なタグは、サブクラス (@param の場合 ParamTag、@see および {@link} の場合 SeeTag、および @throws の場合 ThrowsTag など) で処理されます。

関連項目:

SeeTag, ParamTag, ThrowsTag, SerialFieldTag, Doc.tags()

メソッドの概要

Tag[]	firstSentenceTags() コメントの最初の文をタグの配列として返します。
Doc	holder() この Tag 要素に含まれる Doc を返します。
Tag[]	inlineTags() 埋め込まれた {@link} タグのあるドキュメンテーションコメントの場合、Tag オブジェクトの配列を返します。
String	kind() このタグの種類を返します。
String	name() このタグの名前を返します。
SourcePosition	position() このタグのソース位置を返します。
String	text() このタグのテキスト (タグ名よりもあとの部分) を返します。
String	toString() このオブジェクトを文字列に変換します。

メソッドの詳細

name

String name()

このタグの名前を返します。タグの名前は、@return のように、ドキュメンテーションコメントで使用される「@」で始まる文字列です。{@link} のようなインラインタグの場合、中括弧は名前には含めず、この例では、単に @link がこのインラインタグの名前になります。

holder

Doc holder()

この Tag 要素に含まれる Doc を返します。

kind

String kind()

このタグの種類を返します。 similar タグや synonymous タグです。ほとんどのタグでは、kind() == name() が同一です。 指定された種類のタグが複数ある場合を次の表に示します。

kind()	name()
@throws	@throws
@throws	@exception
@see	@see
@see	@link
@see	@linkplain
@serial	@serial
@serial	@serialData

text

String text()

このタグのテキスト (タグ名よりもあとの部分) を返します。

toString

String toString()

このオブジェクトを文字列に変換します。

オーバーライド:

クラス Object 内の toString

inlineTags

Tag[] inlineTags()

埋め込まれた {@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()

コメントの最初の文をタグの配列として返します。インラインタグ ({@link reference} タグ) を含みますが、ブロックタグは含みません。プレーンテキストの各セクションは、種類「Text」の Tag として表されます。インラインタグは、種類「@link」の SeeTag として表されます。ロケールが英語の場合、最初の文は Java 言語仕様 (最初のバージョン) に記述されている規則によって決定されます。"この文は、後ろに空白文字、タブ、または行末記号が続く最初のピリオド、または最初のタグラインで終了します。"さらに、行は段落およびセクションの終わりを示す <p>、</p>、<h1>、<h2>、<h3>、<h4>、<h5>、<h6>、<hr>、<pre>、</pre> などの HTML タグで終了します。ロケールの言語が英語でない場合、文の終わりは BreakIterator.getSentenceInstance(Locale). によって決定されます。

戻り値:

コメントの最初の文を表す Tag オブジェクトの配列

position

SourcePosition position()

このタグのソース位置を返します。

戻り値:

このタグのソース位置