|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
すべての Doc クラスの抽象基底クラスです。Doc 項目は、コメントが付けられており、今回の javadoc の実行で処理された Java 言語の構成要素 (クラス、パッケージ、メソッドなど) を表します。すべての Doc 項目は一意であり、したがって == で比較することができます。
メソッドの概要 | |
String |
commentText()
この Doc 項目のコメントテキストを返します。 |
int |
compareTo(Object obj)
このオブジェクトと指定されたオブジェクトの順序を比較します。 |
Tag[] |
firstSentenceTags()
コメントの最初の文をタグとして返します。 |
String |
getRawCommentText()
コメントのテキスト全体を未処理のまま返します。 |
Tag[] |
inlineTags()
コメントをタグとして返します。 |
boolean |
isClass()
この Doc 項目がクラスかどうかを示します。 |
boolean |
isConstructor()
この Doc 項目がコンストラクタかどうかを示します。 |
boolean |
isError()
この Doc 項目がエラークラスかどうかを示します。 |
boolean |
isException()
この Doc 項目が例外クラスかどうかを示します。 |
boolean |
isField()
この Doc 項目がフィールドかどうかを示します。 |
boolean |
isIncluded()
この Doc 項目がアクティブセットに含まれる場合、true を返します。 |
boolean |
isInterface()
この Doc 項目がインタフェースかどうかを示します。 |
boolean |
isMethod()
この Doc 項目が単純なメソッド (つまりコンストラクタ以外のメソッド) かどうかを示します。 |
boolean |
isOrdinaryClass()
この Doc 項目が通常のクラス (インタフェース、例外、あるいはエラー以外のクラス) かどうかを示します。 |
String |
name()
この Doc 項目の非修飾名を返します。 |
SourcePosition |
position()
ドキュメント化されたエンティティのソース位置を返します。 |
SeeTag[] |
seeTags()
この Doc 項目に含まれる @see タグを返します。 |
void |
setRawCommentText(String rawDocumentation)
コメントのテキスト全体を未処理のまま設定します。 |
Tag[] |
tags()
この Doc 項目に含まれるすべてのタグを返します。 |
Tag[] |
tags(String tagname)
この Doc 項目に含まれるタグのうち、指定された種類のタグを返します。 |
メソッドの詳細 |
public String commentText()
public Tag[] tags()
public Tag[] tags(String tagname)
tagname
- 検索対象のタグ種の名前
public SeeTag[] seeTags()
public Tag[] inlineTags()
Tag
として表されます。インラインタグは、種類「link」の SeeTag
として表されます。
Tag
の配列public Tag[] firstSentenceTags()
Tag
として表されます。インラインタグは、種類「link」の SeeTag
として表されます。ロケールが英語の場合、最初の文は Java 言語仕様 (最初のバージョン) に記述されている規則によって決定されます。"この文は、後ろに空白文字、タブ、または行末記号が続く最初のピリオド、または最初のタグラインで終了します。"さらに、行は段落およびセクションの終わりを示す <p>、</p>、<h1>、<h2>、<h3>、<h4>、<h5>、<h6>、<hr>、<pre>、</pre> などの HTML タグで終了します。ロケールの言語が英語でない場合、文の終わりは Tag
java.text.BreakIterator#getSentenceInstance(Locale) java.text.BreakIterator.getSentenceInstance(Locale)} によって決定されます。
Tag
の配列public String getRawCommentText()
public void setRawCommentText(String rawDocumentation)
public String name()
public int compareTo(Object obj)
このメソッドにより、Doc 項目を java.lang.Comparable として扱えるようになります。
Comparable
内の compareTo
ClassCastException
- 指定されたオブジェクトの型が、このオブジェクトと比較できない型の場合public boolean isField()
public boolean isMethod()
public boolean isConstructor()
public boolean isInterface()
public boolean isException()
public boolean isError()
public boolean isOrdinaryClass()
public boolean isClass()
public boolean isIncluded()
public SourcePosition position()
|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |