|
|||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||
概要: 内部クラス | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
すべての Doc クラスの抽象基底クラスです。Doc 項目は、コメントが付けられており、今回の javadoc の実行で処理された Java 言語の構成要素 (クラス、パッケージ、メソッドなど) を表します。すべての Doc 項目は一意であり、したがって == で比較することができます。
メソッドの概要 | |
java.lang.String |
commentText()
この Doc 項目のコメントテキストを返します。 |
int |
compareTo(java.lang.Object obj)
このオブジェクトと指定されたオブジェクトの順序を比較します。 |
Tag[] |
firstSentenceTags()
コメントの最初の文をタグとして返します。 |
java.lang.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 項目が通常のクラス (たとえば、インタフェース、例外クラス、エラークラスではない) かどうかを検査します。 |
java.lang.String |
name()
この Doc 項目の名前を返します。 |
SeeTag[] |
seeTags()
この Doc 項目に含まれる @see タグを返します。 |
void |
setRawCommentText(java.lang.String rawDocumentation)
未処理のコメントテキスト全体を設定します。 |
Tag[] |
tags()
この Doc 項目に含まれるすべてのタグを返します。 |
Tag[] |
tags(java.lang.String tagname)
この Doc 項目に含まれるタグのうち、指定された種類のタグを返します。 |
メソッドの詳細 |
public java.lang.String commentText()
public Tag[] tags()
public Tag[] tags(java.lang.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 タグで終了します。ロケールが英語でない場合、文の終わりは java.text.BreakIterator.getSentenceInstance(Locale)
によって決定されます。Tag
の配列public java.lang.String getRawCommentText()
public void setRawCommentText(java.lang.String rawDocumentation)
public java.lang.String name()
public int compareTo(java.lang.Object obj)
Doc 項目が java.lang.Comparable となるようにするために使用します。
java.lang.Comparable
内の compareTo
o
- 比較対象のオブジェクト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()
|
|||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||
概要: 内部クラス | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |