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

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

Comparable<Object>

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

AnnotationTypeDoc, AnnotationTypeElementDoc, ClassDoc, ConstructorDoc, ExecutableMemberDoc, FieldDoc, MemberDoc, MethodDoc, PackageDoc, ProgramElementDoc, RootDoc

public interface Doc
extends Comparable<Object>

コメントが付けられており、今回の javadoc の実行で処理された Java 言語構造要素 (パッケージ、クラス、コンストラクタ、メソッド、フィールド) を表します。すべての Doc オブジェクトは一意であり、したがって == で比較することができます。

導入されたバージョン:

1.2

メソッドの概要

String	commentText() この Doc 項目のコメントテキストを返します。
int	compareTo(Object obj) この doc オブジェクトと指定されたオブジェクトの順序を比較します。
Tag[]	firstSentenceTags() コメントの最初の文をタグの配列として返します。
String	getRawCommentText() コメントのテキスト全体を未処理のまま返します。
Tag[]	inlineTags() コメントをタグの配列として返します。
boolean	isAnnotationType() この Doc 項目が注釈型かどうかを示します。
boolean	isAnnotationTypeElement() この Doc 項目が注釈型の要素かどうかを示します。
boolean	isClass() この Doc 項目がインタフェースまたは注釈型ではなく、クラス型かどうかを示します。
boolean	isConstructor() この Doc 項目がコンストラクタかどうかを示します。
boolean	isEnum() この Doc 項目が enum 型かどうかを示します。
boolean	isEnumConstant() この Doc 項目が enum 定数かどうかを示します。
boolean	isError() この Doc 項目がエラークラスかどうかを示します。
boolean	isException() この Doc 項目が例外クラスかどうかを示します。
boolean	isField() この Doc 項目がフィールド (ただし、enum 定数ではない) かどうかを示します。
boolean	isIncluded() この Doc 項目が結果セットに組み込まれる場合、true を返します。
boolean	isInterface() この Doc 項目がインタフェース (ただし、注釈型ではない) かどうかを示します。
boolean	isMethod() この Doc 項目がメソッド (ただし、コンストラクタまたは注釈型の要素ではない) かどうかを示します。
boolean	isOrdinaryClass() この Doc 項目が通常クラス (つまりインタフェース、注釈型、enum、例外、またはエラー以外) かどうかを示します。
String	name() この Doc 項目の非修飾名を返します。
SourcePosition	position() 対応する宣言の最初の行のソース位置を返します。
SeeTag[]	seeTags() この Doc 項目に含まれる @see タグを返します。
void	setRawCommentText(String rawDocumentation) コメントのテキスト全体を未処理のまま設定します。
Tag[]	tags() この Doc 項目に含まれるすべてのタグを返します。
Tag[]	tags(String tagname) この Doc 項目に含まれる指定された 種類 のタグを返します。

メソッドの詳細

commentText

String commentText()

この Doc 項目のコメントテキストを返します。タグは削除されます。

tags

Tag[] tags()

この Doc 項目に含まれるすべてのタグを返します。

戻り値:

この Doc 項目に含まれるすべてのタグを含んだ Tag オブジェクトの配列

tags

Tag[] tags(String tagname)

この Doc 項目に含まれる指定された 種類 のタグを返します。 たとえば、「tagname」に「@serial」という値がある場合、「@serial」型のこの Doc 項目内のすべてのタグが返されます。

パラメータ:

tagname - 検索対象のタグ種の名前

戻り値:

kind() が tagname に一致するすべてのタグを含んだ Tag の配列

seeTags

SeeTag[] seeTags()

この Doc 項目に含まれる @see タグを返します。

戻り値:

すべての @see タグを含んだ SeeTag の配列

inlineTags

Tag[] inlineTags()

コメントをタグの配列として返します。ブロックタグではなく、インラインタグ ({@link reference} タグ) が含まれます。プレーンテキストの各セクションは、種類「Text」の Tag として表されます。インラインタグは、種類「@see」および名前「@link」の SeeTag として表されます。

戻り値:

コメントを表す Tag の配列

firstSentenceTags

Tag[] firstSentenceTags()

コメントの最初の文をタグの配列として返します。ブロックタグではなく、インラインタグ ({@link reference} タグ) が含まれます。プレーンテキストの各セクションは、種類「Text」の Tag として表されます。インラインタグは、種類「@see」および名前「@link」の SeeTag として表されます。

ロケールが英語の場合、最初の文は Java 言語仕様 (最初のバージョン) に記述されている規則によって決定されます。"この文は、後ろに空白文字、タブ、または行末記号が続く最初のピリオド、または最初のタグラインで終了します。"さらに、<p>、</p>、<h1>、<h2>、<h3>、<h4>、<h5>、<h6>、<hr>、<pre>、</pre> などのブロック HTML タグで終了します。ロケールの言語が英語でない場合、文の終わりは BreakIterator.getSentenceInstance(Locale). によって決定されます。

戻り値:

コメントの最初の文を表す Tag の配列

getRawCommentText

String getRawCommentText()

コメントのテキスト全体を未処理のまま返します。タグはテキストとして含まれます。このメソッドは主に、内部化などの格納および取得操作で使われます。

setRawCommentText

void setRawCommentText(String rawDocumentation)

コメントのテキスト全体を未処理のまま設定します。タグはテキストとして含まれます。このメソッドは主に、内部化などの格納および取得操作で使われます。

name

String name()

この Doc 項目の非修飾名を返します。

戻り値:

名前

compareTo

int compareTo(Object obj)

この doc オブジェクトと指定されたオブジェクトの順序を比較します。この doc オブジェクトが指定されたオブジェクトよりも小さい場合は、負の整数、このオブジェクトと指定されたオブジェクトが等しい場合は、ゼロ、この doc オブジェクトが指定されたオブジェクトよりも大きい場合は、正の整数が返されます。

このメソッドは Comparable インタフェースの条件を満たします。

定義:

インタフェース Comparable<Object> 内の compareTo

パラメータ:

obj - 比較対象の Object

戻り値:

このオブジェクトが指定されたオブジェクトよりも小さい場合は負の整数。このオブジェクトと指定されたオブジェクトが等しい場合はゼロ。このオブジェクトが指定されたオブジェクトよりも大きい場合は正の整数

例外:

ClassCastException - 指定されたオブジェクトの型が、このオブジェクトと比較できない型の場合

isField

boolean isField()

この Doc 項目がフィールド (ただし、enum 定数ではない) かどうかを示します。

戻り値:

フィールドを表す場合は true

isEnumConstant

boolean isEnumConstant()

この Doc 項目が enum 定数かどうかを示します。

戻り値:

enum 定数を表す場合は true

導入されたバージョン:

1.5

isConstructor

boolean isConstructor()

この Doc 項目がコンストラクタかどうかを示します。

戻り値:

コンストラクタを表す場合は true

isMethod

boolean isMethod()

この Doc 項目がメソッド (ただし、コンストラクタまたは注釈型の要素ではない) かどうかを示します。

戻り値:

メソッドを表す場合は true

isAnnotationTypeElement

boolean isAnnotationTypeElement()

この Doc 項目が注釈型の要素かどうかを示します。

戻り値:

注釈型の要素を表す場合は true

導入されたバージョン:

1.5

isInterface

boolean isInterface()

この Doc 項目がインタフェース (ただし、注釈型ではない) かどうかを示します。

戻り値:

インタフェースを表す場合は true

isException

boolean isException()

この Doc 項目が例外クラスかどうかを示します。

戻り値:

例外を表す場合は true

isError

boolean isError()

この Doc 項目がエラークラスかどうかを示します。

戻り値:

エラーを表す場合は true

isEnum

boolean isEnum()

この Doc 項目が enum 型かどうかを示します。

戻り値:

enum 型を表す場合は true

導入されたバージョン:

1.5

isAnnotationType

boolean isAnnotationType()

この Doc 項目が注釈型かどうかを示します。

戻り値:

注釈型を表す場合は true

導入されたバージョン:

1.5

isOrdinaryClass

boolean isOrdinaryClass()

この Doc 項目が通常クラス (つまりインタフェース、注釈型、enum、例外、またはエラー以外) かどうかを示します。

戻り値:

通常のクラスを表す場合は true

isClass

boolean isClass()

この Doc 項目がインタフェースまたは注釈型ではなく、クラス型かどうかを示します。これには、通常のクラス、enum、エラー、および例外が含まれます。

戻り値:

クラスを表す場合は true

isIncluded

boolean isIncluded()

この Doc 項目が結果セットに組み込まれる場合、true を返します。

position

SourcePosition position()

対応する宣言の最初の行のソース位置を返します。ソース位置にアクセスできない場合は null を返します。デフォルトのコンストラクタは、ソースファイルでの位置を持たないので、null を返します。

導入されたバージョン:

1.4