|
ドックレット API | ||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
public interface Doc
コメントが付けられており、今回の javadoc の実行で処理された Java 言語構造要素 (パッケージ、クラス、コンストラクタ、メソッド、フィールド) を表します。すべての Doc オブジェクトは一意であり、したがって == で比較することができます。
メソッドの概要 | |
---|---|
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 項目に含まれる指定された 種類 のタグを返します。 |
メソッドの詳細 |
---|
String commentText()
Tag[] tags()
Tag
オブジェクトの配列Tag[] tags(String tagname)
tagname
- 検索対象のタグ種の名前
SeeTag[] seeTags()
Tag[] inlineTags()
Tag
として表されます。インラインタグは、種類「@see」および名前「@link」の SeeTag
として表されます。
Tag
の配列Tag[] firstSentenceTags()
Tag
として表されます。インラインタグは、種類「@see」および名前「@link」の SeeTag
として表されます。
ロケールが英語の場合、最初の文は Java 言語仕様 (最初のバージョン) に記述されている規則によって決定されます。"この文は、後ろに空白文字、タブ、または行末記号が続く最初のピリオド、または最初のタグラインで終了します。"さらに、<p>、</p>、<h1>、<h2>、<h3>、<h4>、<h5>、<h6>、<hr>、<pre>、</pre> などのブロック HTML タグで終了します。ロケールの言語が英語でない場合、文の終わりは BreakIterator.getSentenceInstance(Locale)
. によって決定されます。
Tag
の配列String getRawCommentText()
void setRawCommentText(String rawDocumentation)
String name()
int compareTo(Object obj)
このメソッドは Comparable
インタフェースの条件を満たします。
Comparable<Object>
内の compareTo
obj
- 比較対象の Object
ClassCastException
- 指定されたオブジェクトの型が、このオブジェクトと比較できない型の場合boolean isField()
boolean isEnumConstant()
boolean isConstructor()
boolean isMethod()
boolean isAnnotationTypeElement()
boolean isInterface()
boolean isException()
boolean isError()
boolean isEnum()
boolean isAnnotationType()
boolean isOrdinaryClass()
boolean isClass()
boolean isIncluded()
SourcePosition position()
|
ドックレット API | ||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |